Informationen zu ActivityCommonParameters
KURZE BESCHREIBUNG
Beschreibt die Parameter, die Windows PowerShell Workflow Aktivitäten hinzufügt.
LANGE BESCHREIBUNG
Windows PowerShell Workflow fügt die allgemeinen Aktivitätsparameter aktivitäten hinzu, die von der PSActivity-Basisklasse abgeleitet sind. Diese Kategorie umfasst die InlineScript-Aktivität und Windows PowerShell Cmdlets, die als Aktivitäten implementiert werden, z. B. Get-Process und Get-WinEvent.
Die allgemeinen Aktivitätsparameter sind für die Suspend-Workflow und Checkpoint-Workflow Aktivitäten ungültig und werden nicht zu Cmdlets oder Ausdrücken hinzugefügt, die Windows PowerShell Workflow automatisch in einem InlineScript-Skriptblock oder einer ähnlichen Aktivität ausgeführt wird. Die allgemeinen Aktivitätsparameter sind für die Aktivität InlineScript verfügbar, nicht aber für die Befehle im Skriptblock InlineScript.
Einige der allgemeinen Aktivitätsparameter sind auch workflowübliche Parameter oder Windows PowerShell allgemeinen Parametern. Andere allgemeine Aktivitätsparameter sind für Aktivitäten eindeutig.
Weitere Informationen zu allgemeinen Workflowparametern finden Sie unter about_WorkflowCommonParameters. Informationen zu den Windows PowerShell allgemeinen Parametern finden Sie unter about_CommonParameters.
LISTE ALLGEMEINER AKTIVITÄTSPARAMETER
AppendOutput PSDebug
Debug PSDisableSerialization
DisplayName PSDisableSerializationPreference
ErrorAction PSError
Input PSPersist
MergeErrorToOutput PSPort
PSActionRetryCount PSProgress
PSActionRetryIntervalSec PSProgressMessage
PSActionRunningTimeoutSec PSRemotingBehavior
PSApplicationName PSRequiredModules
PSAuthentication PSSessionOption
PSCertificateThumbprint PSUseSSL
PSComputerName PSVerbose
PSConfigurationName PSWarning
PSConnectionRetryCount Result
PSConnectionRetryIntervalSec UseDefaultInput
PSConnectionURI Verbose
PSCredential WarningAction
PARAMETERBESCHREIBUNGEN
In diesem Abschnitt werden die allgemeinen Aktivitätsparameter beschrieben.
AppendOutput <Boolean>
Ein Wert von $True fügt die Ausgabe der Aktivität dem Wert der Variablen hinzu.
Ein Wert von $False hat keine Auswirkung. In der Standardeinstellung ersetzt das Zuweisen eines Werts zu einer Variablen den Wert der Variablen.
Beispielsweise fügen die folgenden Befehle dem Dienstobjekt in der $x Variablen ein Prozessobjekt hinzu.
Workflow Test-Workflow
{
$x = Get-Service
$x = Get-Process -AppendOutput $true
}
Dieser Parameter ist für XAML-basierte Workflows konzipiert. In Skriptworkflows können Sie auch den Zuweisungsoperator += verwenden, um dem Wert einer Variablen eine Ausgabe hinzuzufügen, wie im folgenden Beispiel gezeigt.
Workflow Test-Workflow
{
$x = Get-Service
$x += Get-Process
}
Debuggen von <SwitchParameter>
Zeigt Details auf Programmiererebene zum Vorgang an, der vom Befehl ausgeführt wird. Der Debug-Parameter überschreibt den Wert der variablen $DebugPreference für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl Debugmeldungen generiert. Dieser Parameter ist auch ein Windows PowerShell allgemeiner Parameter.
DisplayName-Zeichenfolge <>
Gibt einen Anzeigenamen für die Aktivität an. Der DisplayName-Wert wird in der Statusleiste angezeigt, während der Workflow ausgeführt wird, und im Wert der Progress-Eigenschaft des Workflowauftrags. Wenn der PSProgressMessage-Parameter auch im Befehl enthalten ist, wird der Statusleisteninhalt im <Format DisplayName>:<PSProgressMessage> angezeigt.
ErrorAction <ActionPreference>
Bestimmt, wie die Aktivität auf einen nicht beendenden Fehler des Befehls reagiert. Es hat keine Auswirkung auf Beendigungsfehler. Dieser Parameter funktioniert nur, wenn der Befehl einen nicht beendenden Fehler generiert, z. B. aus dem Cmdlet Write-Error. Der ErrorAction-Parameter überschreibt den Wert der variablen $ErrorActionPreference für den aktuellen Befehl. Dieser Parameter ist auch ein Windows PowerShell allgemeiner Parameter.
Gültige Werte:
Weiter. Zeigt die Fehlermeldung an, und setzt die Ausführung des Befehls fort. "Continue" ist der Standardwert.
Ignorieren. Unterdrückt die Fehlermeldung und setzt die Ausführung des Befehls fort. Im Gegensatz zu SilentlyContinue fügt Ignore die Fehlermeldung nicht zur $Error automatischen Variablen hinzu. Der Ignore-Wert wird in Windows PowerShell 3.0 eingeführt.
Fragen. Zeigt die Fehlermeldung an und fordert Sie zur Bestätigung auf, bevor Sie mit der Ausführung fortfahren. Dieser Wert wird selten verwendet.
Anhalten. Setzt einen Workflowauftrag automatisch an, um weitere Untersuchungen zu ermöglichen. Nach der Untersuchung kann der Workflow fortgesetzt werden.
SilentlyContinue. Unterdrückt die Fehlermeldung und setzt die Ausführung des Befehls fort.
Beenden Zeigt die Fehlermeldung an und beendet die Ausführung des Befehls.
Eingabeobjekt <[]>
Übermittelt eine Auflistung von Objekten an eine Aktivität. Dies stellt eine Alternative zum einzelnen Weiterleiten von Objekten an die Aktivität dar.
MergeErrorToOutput <Boolean>
Ein Wert von $True fügt dem Ausgabedatenstrom Fehler hinzu. Ein Wert von $False hat keine Auswirkung. Verwenden Sie diesen Parameter mit den Schlüsselwörtern Parallel und ForEach -Parallel , um Fehler und Ausgaben aus mehreren parallelen Befehlen in einer einzelnen Auflistung zu sammeln.
PSActionRetryCount <Int32>
Versucht wiederholt, die Aktivität auszuführen, wenn der erste Versuch fehlschlägt. Beim Standardwert 0 wird keine Wiederholung durchgeführt.
PSActionRetryIntervalSec <Int32>
Legt das Intervall zwischen Wiederholungsversuchen der Aktion in Sekunden fest. Beim Standardwert 0 wird die Aktion sofort wiederholt. Dieser Parameter ist nur gültig, wenn der PSActionRetryCount-Parameter auch im Befehl verwendet wird.
PSActionRunningTimeoutSec <Int32>
Legt fest, wie lange die Aktivität auf jedem Zielcomputer ausgeführt werden kann. Wenn die Aktivität nicht abgeschlossen wird, bevor das Timeout abläuft, generiert Windows PowerShell Workflow einen Abbruchfehler und beendet die Verarbeitung des Workflows auf dem betroffenen Zielcomputer.
PSAllowRedirection <Boolean>
Der Wert $True ermöglicht die Umleitung der Verbindung zu den Zielcomputern. Ein Wert von $False hat keine Auswirkung. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Wenn Sie den PSConnectionURI-Parameter verwenden, kann das Remoteziel eine Anweisung zum Umleiten an einen anderen URI zurückgeben. Standardmäßig leitet Windows PowerShell verbindungen nicht um, aber Sie können den PSAllowRedirection-Parameter mit dem Wert $True verwenden, um die Umleitung der Verbindung zum Zielcomputer zuzulassen.
Sie können auch die Anzahl der Umleitungen der Verbindung einschränken, indem Sie die MaximumConnectionRedirectionCount-Eigenschaft der $PSSessionOption Einstellungsvariablen oder die MaximumConnectionRedirectionCount-Eigenschaft des Werts des SSessionOption-Parameters von Cmdlets festlegen, die eine Sitzung erstellen. Der Standardwert ist 5.
PSApplicationName <String>
Gibt das Anwendungsnamensegment des Verbindungs-URI an, der zum Herstellen einer Verbindung mit den Zielcomputern verwendet wird. Verwenden Sie diesen Parameter, um den Anwendungsnamen anzugeben, wenn Sie nicht den ConnectionURI-Parameter im Befehl verwenden. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Der Standardwert ist der Wert der $PSSessionApplicationName Einstellungsvariable auf dem Zielcomputer. Wenn diese Einstellungsvariable nicht definiert ist, ist der Standardwert „WSMan“. Dieser Wert ist für die meisten Verwendungsarten geeignet. Weitere Informationen finden Sie unter about_Preference_Variables.
Der WinRM-Dienst wählt mit dem Anwendungsnamen einen Listener für die Verbindungsanforderung aus. Der Wert dieses Parameters sollte mit dem Wert der URLPrefix-Eigenschaft eines Listeners auf dem Remotecomputer übereinstimmen.
PSAuthentication AuthenticationMechanism <>
Gibt den Mechanismus an, der verwendet wird, um die Anmeldeinformationen des Benutzers beim Herstellen einer Verbindung mit den Zielcomputern zu authentifizieren. Zu den gültigen Werten gehören Default, Basic, Credssp, Digest, Kerberos, Negotiate und NegotiateWithImplicitCredential. Der Standardwert ist Default. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Informationen zu den Werten dieses Parameters finden Sie unter der Beschreibung der System.Management.Automation.Runspaces.AuthenticationMechanism-Enumeration in MSDN.
Warnung
Die Credential Security Support Provider (CredSSP)-Authentifizierung, in der die Anmeldeinformationen des Benutzers zur Authentifizierung an einen Remotecomputer übergeben werden, ist für Befehle gedacht, die Authentifizierung bei mehr als einer Ressource erfordern, z. B. beim Zugriff auf eine Remote-Netzwerkfreigabe. Dieser Mechanismus erhöht das Sicherheitsrisiko des Remotevorgangs. Wenn die Sicherheit des Remotecomputers gefährdet ist, können die an ihn übergebenen Anmeldeinformationen zum Steuern der Netzwerksitzung verwendet werden.
PSCertificateThumbprint <String>
Gibt das digitale Zertifikat für öffentliche Schlüssel (X509) eines Benutzerkontos an, das über die Berechtigung zum Ausführen dieser Aktion verfügt. Geben Sie den Zertifikatfingerabdruck des Zertifikats ein. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Zertifikate werden bei der clientzertifikatbasierten Authentifizierung verwendet. Sie können nur lokalen Benutzerkonten zugeordnet werden und funktionieren nicht mit Domänenkonten.
Verwenden Sie zum Abrufen eines Zertifikats die Cmdlets Get-Item oder Get-ChildItem im Laufwerk Windows PowerShell Cert: .
PSComputerName <String[]>
Gibt die Zielcomputer an, auf denen die Aktivität ausgeführt wird. Die Standardeinstellung ist der lokale Computer. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Geben Sie den NetBIOS-Namen, die IP-Adresse oder den vollqualifizierten Domänennamen von mindestens einem Computer in eine durch Kommas getrennte Liste ein. Um den lokalen Computer anzugeben, geben Sie den Computernamen, „localhost“ oder einen Punkt (.) ein.
Um den lokalen Computer in den Wert des PSComputerName-Parameters einzuschließen, öffnen Sie Windows PowerShell mit der Option "Als Administrator ausführen".
Wenn dieser Parameter im Befehl ausgelassen wird oder der Wert $null oder eine leere Zeichenfolge ist, ist das Workflowziel der lokale Computer, und Windows PowerShell Remoting wird nicht zum Ausführen des Befehls verwendet.
Um eine IP-Adresse im Wert des ComputerName-Parameters zu verwenden, muss der Befehl den PSCredential-Parameter enthalten. Außerdem muss der Computer für den HTTPS-Transport konfiguriert sein, oder die IP-Adresse des Remotecomputers muss in der WinRM TrustedHosts-Liste auf dem lokalen Computer enthalten sein. Anweisungen zum Hinzufügen eines Computernamens zur TrustedHosts-Liste finden Sie unter Hinzufügen eines Computers zur Liste der vertrauenswürdigen Hosts in about_Remote_Troubleshooting.
PSConfigurationName <String>
Gibt die Sitzungskonfigurationen an, die zum Erstellen von Sitzungen auf den Zielcomputern verwendet werden. Geben Sie den Namen einer Sitzungskonfiguration auf den Zielcomputern ein (nicht auf dem Computer, auf dem der Workflow ausgeführt wird. Der Standardwert ist Microsoft.PowerShell. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
PSConnectionRetryCount <UInt>
Gibt die maximale Anzahl von Verbindungsversuchen mit jedem Zielcomputer an, wenn der erste Verbindungsversuch fehlschlägt. Geben Sie eine Zahl zwischen 1 und 4.294.967.295 (UInt.MaxValue) ein. Der Standardwert null (0) stellt keine Wiederholungsversuche dar. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
PSConnectionRetryIntervalSec <UInt>
Gibt die Verzögerung zwischen Verbindungsversuchsversuchen in Sekunden an. Der Standardwert ist 0 (null). Dieser Parameter ist nur gültig, wenn der Wert von PSConnectionRetryCount mindestens 1 ist. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
PSConnectionURI <System.Uri>
Gibt einen URI (Uniform Resource Identifier) an, der den Verbindungsendpunkt für die Aktivität auf dem Zielcomputer definiert. Der URI muss vollqualifiziert sein. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Das Format dieser Zeichenfolge lautet wie folgt:
<Transport>://<ComputerName>:<Port>/<ApplicationName>
Standardwert: https://localhost:5985/WSMAN.
Wenn Sie keinen PSConnectionURI angeben, können Sie die Parameter PSUseSSL, PSComputerName, PSPort und PSApplicationName verwenden, um die PSConnectionURI-Werte anzugeben.
Gültige Werte für das Transport-Segment des URI sind „HTTP“ und „HTTPS“. Wenn Sie einen Verbindungs-URI mit einem Transportsegment angeben, aber keinen Port angeben, wird die Sitzung mit Standardports erstellt: 80 für HTTP und 443 für HTTPS. Um die Standardports für Windows PowerShell-Remoting zu verwenden, geben Sie Port 5985 für HTTP bzw. 5986 für HTTPS an.
PSCredential <PSCredential>
Gibt ein Benutzerkonto an, das über die Berechtigung zum Ausführen der Aktivität auf dem Zielcomputer verfügt. Der Standardwert ist der aktuelle Benutzer. Dieser Parameter ist nur gültig, wenn der PSComputerName-Parameter im Befehl enthalten ist. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Geben Sie einen Benutzernamen ein, z. B. "User01" oder "Domain01\User01", oder geben Sie eine Variable ein, die ein PSCredential-Objekt enthält, z. B. einen, den das Get-Credential-Cmdlet zurückgibt. Wenn Sie nur einen Benutzernamen eingeben, werden Sie zur Eingabe eines Kennworts aufgefordert.
PSDebug <PSDataCollection[DebugRecord]>
Fügt der angegebenen Debugdatensatzauflistung Debugmeldungen aus der Aktivität hinzu, anstatt die Debugnachrichten in die Konsole oder den Wert der Debug-Eigenschaft des Workflowauftrags zu schreiben. Sie können Debugmeldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Debugdatensätzen hinzufügen.
Um diesen allgemeinen Aktivitätsparameter zu verwenden, verwenden Sie das Cmdlet New-Object, um ein PSDataCollection-Objekt mit dem Typ DebugRecord zu erstellen und das Objekt in einer Variablen zu speichern. Verwenden Sie dann die Variable als Wert des PSDebug-Parameters einer oder mehrerer Aktivitäten, wie im folgenden Beispiel gezeigt.
Workflow Test-Workflow
{
$debugCollection = New-Object -Type `
System.Management.Automation.PSDataCollection[System.Management.Automation.DebugRecord]
InlineScript {\Server01\Share01\Get-AssetData.ps1} -PSDebug $debugCollection -Debug $True
InlineScript {\Server01\Share01\Set-AssetData.ps1} -PSDebug $debugCollection -Debug $True
if ($debugCollection -like "Missing") { ...}
}
PSDisableSerialization <Boolean>
Weist die Aktivität an, „Live“-Objekte (nicht serialisierte Objekte) an den Workflow zurückzugeben. Die resultierenden Objekte besitzen Methoden und Eigenschaften, aber sie können nicht gespeichert werden, wenn ein Prüfpunkt angenommen wird.
PSDisableSerializationPreference <Boolean>
Wendet das Äquivalent des PSDisableSerialization-Parameters auf den gesamten Workflow an, nicht nur auf die Aktivität. Das Hinzufügen dieses Parameters wird im Allgemeinen nicht empfohlen, da ein Workflow, der seine Objekte nicht serialisiert, nicht fortgesetzt oder beibehalten werden kann.
Gültige Werte:
(Standard) Wenn sie nicht angegeben werden und Sie auch nicht den PSDisableSerialization-Parameter zu einer Aktivität hinzugefügt haben, werden Objekte serialisiert.
$True. Leitet alle Aktivitäten in einem Workflow an, (nicht serialisierte) „Live“-Objekte zurückzugeben. Die resultierenden Objekte besitzen Methoden und Eigenschaften, aber sie können nicht gespeichert werden, wenn ein Prüfpunkt angenommen wird.$False. Workflow-Objekte werden serialisiert.
PSError <PSDataCollection[ErrorRecord]>
Fügt der angegebenen Fehlerdatensatzsammlung Fehlermeldungen aus der Aktivität hinzu, anstatt die Fehlermeldungen in die Konsole oder den Wert der Error-Eigenschaft des Workflowauftrags zu schreiben. Sie können Fehlermeldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Fehlerdatensätzen hinzufügen.
Um diesen allgemeinen Aktivitätsparameter zu verwenden, verwenden Sie das New-Object Cmdlet, um ein PSDataCollection-Objekt mit dem Typ ErrorRecord zu erstellen und das Objekt in einer Variablen zu speichern. Verwenden Sie dann die Variable als Wert des PSError-Parameters einer oder mehrerer Aktivitäten, wie im folgenden Beispiel gezeigt.
Workflow Test-Workflow
{
$typeName = "System.Management.Automation.PSDataCollection"
$typeName += '[System.Management.Automation.ErrorRecord]'
$ec = New-Object $typeName
InlineScript {\Server01\Share01\Get-AssetData.ps1} -PSError $ec
InlineScript {\Server01\Share01\Set-AssetData.ps1} -PSError $ec
if ($ec.Count -gt 2)
{
# Do Some Work.
}
}
PSPersist <Boolean>
Nimmt einen Prüfpunkt nach der Aktivität an. Dieser Prüfpunkt ist zusätzlich zu allen Prüfpunkten, die im Workflow angegeben sind. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Ein "Prüfpunkt" oder "Persistenzpunkt" ist eine Momentaufnahme des Workflowstatus und der Daten, die während der Ausführung des Workflows erfasst und in einem Persistenzspeicher auf dem Datenträger gespeichert wird. Windows PowerShell Workflow verwendet die gespeicherten Daten, um einen angehaltenen oder unterbrochenen Workflow ab dem letzten Persistenzpunkt fortzusetzen, anstatt den Workflow neu zu starten.
Gültige Werte:
(Standard) Wenn Sie diesen Parameter weglassen, werden keine Prüfpunkte hinzugefügt. Prüfpunkte werden basierend auf den Einstellungen für den Workflow erstellt.
$True. Zeichnet einen Prüfpunkt auf, nachdem die Aktivität abgeschlossen ist. Dieser Prüfpunkt ist zusätzlich zu allen Prüfpunkten, die im Workflow angegeben sind.$False. Es werden keine Prüfpunkte hinzugefügt. Prüfpunkte werden nur dann ausgeführt, wenn sie im Workflow angegeben sind.
PSPort <Int32>
Gibt den Netzwerkport auf den Zielcomputern an. Die Standardports sind 5985 (der WinRM-Port für HTTP) und 5986 (der WinRM-Port für HTTPS). Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Verwenden Sie den PSPort-Parameter nur, wenn Sie dies tun müssen. Der im Befehl festgelegte Port gilt für alle Computer oder Sitzungen, auf denen der Befehl ausgeführt wird. Eine alternative Porteinstellung kann verhindern, dass der Befehl auf allen Computern ausgeführt wird. Bevor ein alternativer Port verwendet werden kann, müssen Sie den WinRM-Listener auf dem Remotecomputer für das Abhören an diesen Port konfigurieren.
PSProgress <PSDataCollection[ProgressRecord]>
Fügt Statusmeldungen aus der Aktivität der angegebenen Statusdatensatzsammlung hinzu, anstatt die Statusmeldungen in die Konsole oder den Wert der Progress-Eigenschaft des Workflowauftrags zu schreiben. Sie können Statusmeldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Statusdatensätzen hinzufügen.
PSProgressMessage-Zeichenfolge <>
Gibt eine Beschreibung der Aktivität an. Der WERT PSProgressMessage wird in der Statusleiste angezeigt, während der Workflow ausgeführt wird. Wenn der DisplayName auch im Befehl enthalten ist, wird der Statusleisteninhalt im <Format DisplayName>:<PSProgressMessage> angezeigt.
Dieser Parameter ist besonders nützlich, um Aktivitäten in einem ForEach -Parallel-Skriptblock zu identifizieren. Ohne diese Nachricht werden Aktivitäten in allen parallelen Teilstrukturen mit demselben Namen identifiziert.
PSRemotingBehavior <RemotingBehavior>
Gibt an, wie das Remoting verwaltet wird, wenn die Aktivität auf Zielcomputern ausgeführt wird. PowerShell ist die Standardeinstellung.
Gültige Werte sind:
Keine: Die Aktivität wird nicht auf Remotecomputern ausgeführt.
PowerShell: Windows PowerShell Remoting wird verwendet, um die Aktivität auf Zielcomputern auszuführen.
Benutzerdefiniert: Die Aktivität unterstützt ihren eigenen Typ von Remoting. Dieser Wert ist gültig, wenn das Cmdlet, das als Aktivität implementiert wird, den Wert des RemotingCapability-Attributs auf SupportedByCommand festlegt und der Befehl den ComputerName-Parameter enthält.
PSRequiredModules <String[]>
Importiert die angegebenen Module vor dem Ausführen des Befehls. Geben Sie die Modulnamen ein. Die Module müssen auf dem Zielcomputer installiert sein.
Module, die in einem Pfad installiert werden, der in der PSModulePath-Umgebungsvariablen angegeben ist, werden bei der ersten Verwendung eines Befehls im Modul automatisch importiert. Verwenden Sie diesen Parameter, um Module zu importieren, die sich nicht an einem PSModulePath-Speicherort befinden.
Da jede Aktivität in einem Workflow in einer eigenen Sitzung ausgeführt wird, importiert ein Import-Module-Befehl nur ein Modul in der Sitzung, in der er ausgeführt wird. Er importiert das Modul nicht in Sitzungen, in denen andere Aktivitäten ausgeführt werden.
PSSessionOption <PSSessionOption>
Legt erweiterte Optionen für die Sitzungen auf die Zielcomputer fest. Geben Sie ein PSSessionOption-Objekt ein, z. B. ein Objekt, das Sie mit dem Cmdlet New-PSSessionOption erstellen. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Die Standardwerte für die Sitzungsoptionen werden durch den Wert der $PSSessionOption Einstellungsvariablen bestimmt, sofern sie festgelegt ist. Andernfalls verwendet die Sitzung die in der Sitzungskonfiguration angegebenen Werte.
Eine Beschreibung der Sitzungsoptionen, einschließlich der Standardwerte, finden Sie im Hilfethema zum New-PSSessionOption Cmdlet New-PSSessionOption.
Weitere Informationen zur $PSSessionOption Einstellungsvariablen finden Sie unter about_Preference_Variables.
PSUseSSL <Boolean>
Der Wert $True verwendet das SSL-Protokoll (Secure Sockets Layer), um eine Verbindung mit dem Zielcomputer herzustellen. Standardmäßig wird SSL nicht verwendet. Der Wert $False hat keine Auswirkung. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
WS-Management verschlüsselt alle Windows PowerShell-Inhalte, die über das Netzwerk übertragen werden. UseSSL bietet zusätzlichen Schutz, indem die Daten über HTTPS, anstelle von HTTP gesendet werden. Wenn Sie diesen Parameter verwenden, aber SSL auf dem Port für den Befehl nicht verfügbar ist, tritt ein Fehler beim Befehl auf.
PSVerbose <PSDataCollection[VerboseRecord]>
Fügt der angegebenen ausführlichen Datensatzauflistung ausführliche Nachrichten aus der Aktivität hinzu, anstatt die ausführlichen Nachrichten in die Konsole oder in den Wert der Verbose-Eigenschaft des Workflowauftrags zu schreiben. Sie können ausführliche Meldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit ausführlichen Datensätzen hinzufügen.
PSWarning <PSDataCollection[WarningRecord]>
Fügt der angegebenen Warndatensatzsammlung Warnmeldungen aus der Aktivität hinzu, anstatt die Warnmeldungen in die Konsole oder in den Wert der Warning-Eigenschaft des Workflowauftrags zu schreiben. Sie können Warnungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Warnungsdatensätzen hinzufügen.
Ergebnis
Dieser Parameter ist nur in XAML-Workflows gültig.
UseDefaultInput <Boolean>
Akzeptiert alle Workfloweingaben als Eingabe für die Aktivität nach Wert.
Beispielsweise verwendet die Get-Process-Aktivität im folgenden Beispielworkflow den allgemeine UseDefaultInput-Aktivitätsparameter als Eingabe, die an den Workflow übergeben wird. Beim Ausführen des Workflows mit der Eingabe wird die Eingabe von der Aktivität verwendet.
workflow Test-Workflow
{
Get-Service -UseDefaultInput $True
}
PS C:> Test-Workflow -InputObject WinRm
Status Name DisplayName PSComputerName
------ ---- ----------- --------------
Running winrm Windows Remote Management (WS-Manag... localhost
Verbose <SwitchParameter>
Zeigt detaillierte Informationen zum Vorgang an, der vom Befehl ausgeführt wird. Diese Informationen ähneln den Informationen in einer Ablaufverfolgung oder in einem Transaktionsprotokoll. Der Verbose-Parameter überschreibt den Wert der variablen $VerbosePreference für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl eine ausführliche Meldung generiert. Dieser Parameter ist auch ein Windows PowerShell allgemeiner Parameter.
WarningAction <ActionPreference>
Bestimmt, wie die Aktivität auf eine Warnung reagiert. "Continue" ist der Standardwert. Der WarningAction-Parameter überschreibt den Wert der variablen $WarningPreference für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl eine Warnmeldung generiert. Dieser Parameter ist auch ein Windows PowerShell allgemeiner Parameter.
Gültige Werte:
SilentlyContinue. Unterdrückt die Warnmeldung und setzt die Ausführung des Befehls fort.
Weiter. Zeigt die Warnmeldung an und setzt die Ausführung des Befehls fort. "Continue" ist der Standardwert.
Fragen. Zeigt die Warnmeldung an und fordert Sie zur Bestätigung auf, bevor Sie die Ausführung fortsetzen. Dieser Wert wird selten verwendet.
Beenden Zeigt die Warnmeldung an und beendet die Ausführung des Befehls.
Hinweis
Der WarningAction-Parameter überschreibt den Wert der $WarningAction Einstellungsvariablen nicht, wenn der Parameter in einem Befehl zum Ausführen eines Skripts oder einer Funktion verwendet wird.
BEISPIELE
Die allgemeinen Aktivitätsparameter sind äußerst nützlich. Beispielsweise können Sie den PSComputerName-Parameter verwenden, um bestimmte Aktivitäten nur auf einer Teilmenge der Zielcomputer auszuführen.
Alternativ können Sie die Parameter PSConnectionRetryCount und PSConnectionRetryIntervalSec verwenden, um die Wiederholungswerte für bestimmte Aktivitäten anzupassen.
Das folgende Beispiel zeigt, wie die allgemeinen Parameter der PSComputerName-Aktivität verwendet werden, um eine Get-EventLog-Aktivität nur auf Computern auszuführen, die eine bestimmte Domäne aufweisen.
Workflow Test-Workflow
{
$UserDomain = Get-Content -Path '.\UserComputers.txt'
$Log = (Get-EventLog -LogName "Windows PowerShell" `
-PSComputerName $UserDomain)
if ($Log)
{
# Do Work Here.
}
}