Informationen über_ActivityCommonParameters
KURZE BESCHREIBUNG
Beschreibt die Parameter, die Windows PowerShell-Workflow zu Aktivitäten hinzufügt.
LANGE BESCHREIBUNG
Windows PowerShell-Workflow fügt die aktivitätsüblichen Parameter zu Aktivitäten hinzu, die von der PSActivity-Basisklasse abgeleitet werden. Diese Kategorie umfasst die InlineScript-Aktivität und Windows PowerShell-Cmdlets, die als Aktivitäten implementiert werden, z Get-Process . B. und Get-WinEvent.
Die allgemeinen Aktivitätsparameter sind für die Suspend-Workflow Und Aktivitäten nicht gültig und Checkpoint-Workflow 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 InlineScript -Aktivität verfügbar, nicht jedoch für die Befehle im InlineScript -Skriptblock.
Einige der allgemeinen Aktivitätsparameter sind auch workflowübliche Parameter oder allgemeine Windows PowerShell-Parameter. Andere allgemeine Aktivitätsparameter sind für Aktivitäten eindeutig.
Informationen zu den allgemeinen Workflowparametern finden Sie unter about_WorkflowCommonParameters. Informationen zu den allgemeinen Windows PowerShell-Parametern finden Sie unter about_CommonParameters.
LISTE DER ALLGEMEINEN 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, $True der die Ausgabe der Aktivität zum Wert der Variablen hinzufügt.
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 wurde für XAML-basierte Workflows entwickelt. In Skriptworkflows können Sie auch den += Zuordnungsoperator verwenden, um dem Wert einer Variablen Ausgabe hinzuzufügen, wie im folgenden Beispiel gezeigt.
Workflow Test-Workflow
{
$x = Get-Service
$x += Get-Process
}
Debug <SwitchParameter>
Zeigt Details auf Programmiererebene zu dem vom Befehl ausgeführten Vorgang an.
Der Debug-Parameter überschreibt den Wert der $DebugPreference Variablen für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl Debugmeldungen generiert. Dieser Parameter ist auch ein allgemeiner Windows PowerShell-Parameter.
DisplayName-Zeichenfolge <>
Gibt einen Anzeigenamen für die Aktivität an. Der Wert "DisplayName " wird in der Statusleiste angezeigt, während der Workflow ausgeführt wird, und im Wert der Statuseigenschaft des Workflowauftrags. Wenn der PARAMETER "PSProgressMessage " auch im Befehl enthalten ist, wird der Inhalt der Statusleiste im <DisplayName>:<PSProgressMessage> Format angezeigt.
ErrorAction <ActionPreference>
Bestimmt, wie die Aktivität auf einen nicht beendeten Fehler des Befehls reagiert. Sie wirkt sich nicht auf Beendigungsfehler aus. Dieser Parameter funktioniert nur, wenn der Befehl einen nicht beendeten Fehler generiert, z. B. solche aus dem Write-Error Cmdlet. Der ErrorAction-Parameter überschreibt den Wert der $ErrorActionPreference Variablen für den aktuellen Befehl. Dieser Parameter ist auch ein allgemeiner Windows PowerShell-Parameter.
Gültige Werte:
Continue. Zeigt die Fehlermeldung an und führt den Befehl weiterhin aus. Der Standardwert lautetContinue.Ignore. Unterdrückt die Fehlermeldung und führt den Befehl weiterhin aus. Im Gegensatz dazuSilentlyContinueIgnorefügt die Fehlermeldung nicht zur$Errorautomatischen Variablen hinzu. DerIgnoreWert wird in Windows PowerShell 3.0 eingeführt.Inquire. Zeigt die Fehlermeldung an und fordert Sie zur Bestätigung auf, bevor Sie die Ausführung fortsetzen. Dieser Wert wird selten verwendet.Suspend. Hält einen Workflowauftrag automatisch an, um eine weitere Untersuchung zu ermöglichen. Nach der Untersuchung kann der Workflow fortgesetzt werden.SilentlyContinue. Unterdrückt die Fehlermeldung und führt den Befehl weiterhin aus.Stop. Zeigt die Fehlermeldung an und beendet die Ausführung des Befehls.
Input-Objekt <[]>
Sendet 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, der $True Fehler zum Ausgabedatenstrom hinzufügt. Ein Wert von $False hat keine Auswirkung. Verwenden Sie diesen Parameter mit den Parallel- und ForEach -Parallel Schlüsselwort (keyword)s, um Fehler und Ausgaben aus mehreren parallelen Befehlen in einer einzigen Auflistung zu sammeln.
PSActionRetryCount <Int32>
Versucht wiederholt, die Aktivität auszuführen, wenn der erste Versuch fehlschlägt. Der Standardwert , 0wird nicht wiederholt.
PSActionRetryIntervalSec <Int32>
Bestimmt das Intervall zwischen Aktionsversuchen in Sekunden. Der Standardwert , 0ruft die Aktion sofort erneut auf. Dieser Parameter ist nur gültig, wenn der PSActionRetryCount-Parameter auch im Befehl verwendet wird.
PSActionRunningTimeoutSec <Int32>
Bestimmt, 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 Beendigungsfehler und beendet die Verarbeitung des Workflows auf dem betroffenen Zielcomputer.
PSAllowRedirection <Boolean>
Ein Wert, der $True die Umleitung der Verbindung zu den Zielcomputern zulässt.
Ein Wert von $False hat keine Auswirkung. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Wenn Sie den PS Verbinden ionURI-Parameter verwenden, kann das Remoteziel eine Anweisung zurückgeben, um zu einem anderen URI umzuleiten. Standardmäßig leitet Windows PowerShell keine Verbindungen um, Aber Sie können den PSAllowRedirection-Parameter mit einem Wert verwenden, um $True die Umleitung der Verbindung an den Zielcomputer zuzulassen.
Sie können auch einschränken, wie oft die Verbindung umgeleitet wird, indem Sie die Maximum Verbinden ionRedirectionCount-Eigenschaft der $PSSessionOption Einstellungsvariable oder die Maximum Verbinden ionRedirectionCount-Eigenschaft des Werts des SessionOption-Parameters von Cmdlets festlegen, die eine Sitzung erstellen. Der Standardwert ist 5.
PSApplicationName-Zeichenfolge <>
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 parameter Verbinden ionURI 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 zum Authentifizieren der Anmeldeinformationen des Benutzers beim Herstellen einer Verbindung mit den Zielcomputern verwendet wird. Gültige Werte sind 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 in der Beschreibung der System.Management.Automation.Runspaces.AuthenticationMechanism-Aufzählung im PowerShell SDK.
Warnung
Die Authentifizierung des Credential Security Service Provider (CredSSP), bei der die Anmeldeinformationen des Benutzers an einen Remotecomputer übergeben werden, der authentifiziert werden soll, wurde für Befehle entwickelt, die eine Authentifizierung für mehrere Ressourcen erfordern, z. B. den Zugriff auf eine Remotenetzwerkfreigabe. 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 Windows PowerShell-Laufwerk 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 oder localhosteinen 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 aus dem Befehl nicht angegeben wird oder es sich um eine leere Zeichenfolge handelt $null , 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 Liste "TrustedHosts" finden Sie unter "Hinzufügen eines Computers zur vertrauenswürdigen Hostliste" in about_Remote_Troubleshooting.
PSConfigurationName-Zeichenfolge <>
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.Workflow". Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
PS Verbinden ionRetryCount <UInt>
Gibt die maximale Anzahl von Versuchen an, eine Verbindung mit jedem Zielcomputer herzustellen, 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.
PS Verbinden ionRetryIntervalSec <UInt>
Gibt die Verzögerung zwischen Verbindungsversuchen in Sekunden an. Der Standardwert ist Null (0). Dieser Parameter ist nur gültig, wenn der Wert von PS Verbinden ionRetryCount mindestens 1 beträgt. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
PS Verbinden ionURI <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>
Der Standardwert ist http://localhost:5985/WSMAN.
Wenn Sie keinen PS Verbinden ionURI angeben, können Sie die Parameter PSUseSSL, PSComputerName, PSPort und PSApplicationName verwenden, um die PS Verbinden ionURI-Werte anzugeben.
Gültige Werte für das Transportsegment des URI sind HTTP und HTTPS. Wenn Sie einen Verbindungs-URI mit einem Transportsegment angeben, aber keinen Port angeben, wird die Sitzung mit Standardsports erstellt: 80 für HTTP und 443 für HTTPS.
Um die Standardports für Windows PowerShell-Remoting zu verwenden, geben Sie den Port 5985 für HTTP oder 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 PARAMETER "PSComputerName " im Befehl enthalten ist. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Geben Sie einen Benutzernamen ein, z User01 . B. oder Domain01\User01eine Variable, die ein PSCredential-Objekt enthält, z. B. einen, der vom Get-Credential Cmdlet zurückgegeben wird. 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 Debugmeldungen in die Konsole oder den Wert der Debugeigenschaft des Workflowauftrags zu schreiben. Sie können Debugmeldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Debugdatensätzen hinzufügen.
Verwenden Sie zum Verwenden dieses gemeinsamen Aktivitätsparameters das New-Object Cmdlet, um ein PSDataCollection-Objekt mit einem Typ von 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>
Leitet die Aktivität an, um "live"-Objekte (nicht serialisiert) 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) Wird dieser Parameter nicht angegeben, und Sie haben den PARAMETER "PSDisableSerialization " nicht zu einer Aktivität hinzugefügt, 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 Fehlerdatensatzauflistung Fehlermeldungen aus der Aktivität hinzu, anstatt die Fehlermeldungen in die Konsole oder auf 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 einem Typ von 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 enthalten, 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 erfasst werden, während der Workflow ausgeführt wird und in einem Persistenzspeicher auf dem Datenträger gespeichert wird. Windows PowerShell-Workflow verwendet die gespeicherten Daten, um einen angehaltenen oder unterbrochenen Workflow vom 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 übernommen.
$True. Zeichnet einen Prüfpunkt auf, nachdem die Aktivität abgeschlossen ist. Dieser Prüfpunkt ist zusätzlich zu allen Prüfpunkten enthalten, die im Workflow angegeben sind.$False. Es werden keine Prüfpunkte hinzugefügt. Prüfpunkte werden nur 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 59'86 (der WinRM-Port für HTTPS). Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Verwenden Sie den PSPort-Parameter nicht, es sei denn, Sie 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 zur angegebenen Statusdatensatzauflistung hinzu, anstatt die Statusmeldungen in die Konsole oder den Wert der Statuseigenschaft des Workflowauftrags zu schreiben. Sie können Statusmeldungen aus mehreren Aktivitäten demselben Auflistungsobjekt mit Statusdatensätzen hinzufügen.
PSProgressMessage-Zeichenfolge <>
Gibt eine benutzerfreundliche Beschreibung der Aktivität an. Der PSProgressMessage-Wert wird in der Statusleiste angezeigt, während der Workflow ausgeführt wird. Wenn der DisplayName auch im Befehl enthalten ist, wird der Inhalt der Statusleiste im <DisplayName>:<PSProgressMessage> Format angezeigt.
Dieser Parameter ist besonders hilfreich, 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 Remoting verwaltet wird, wenn die Aktivität auf Zielcomputern ausgeführt wird. PowerShell ist die Standardeinstellung.
Gültige Werte sind:
None: Die Aktivität wird nicht auf Remotecomputern ausgeführt.PowerShell: Windows PowerShell-Remoting wird verwendet, um die Aktivität auf Zielcomputern auszuführen.Custom: Die Aktivität unterstützt eine eigene Art von Remoting. Dieser Wert ist gültig, wenn das Cmdlet, das als Aktivität implementiert wird, den Wert des Attributs RemotingCapability auf SupportedByCommand festlegt und der Befehl den Parameter ComputerName enthält.
PSRequiredModules <String[]>
Importiert die angegebenen Module, bevor der Befehl ausgeführt wird. Geben Sie die Modulnamen ein. Die Module müssen auf dem Zielcomputer installiert sein.
Module, die in einem Pfad installiert sind, der in der PSModulePath-Umgebungsvariablen angegeben ist, werden automatisch bei der ersten Verwendung eines Befehls im Modul 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 ein Modul nur in die 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 mithilfe des New-PSSessionOption Cmdlets erstellen. Dieser allgemeine Aktivitätsparameter ist auch ein allgemeiner Workflowparameter.
Die Standardwerte für die Sitzungsoptionen werden durch den Wert der $PSSessionOption Einstellungsvariablen bestimmt, wenn 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 Einstellungsvariablen $PSSessionOption finden Sie unter about_Preference_Variables.
PSUseSSL <Boolean>
Ein Wert, der $True das SSL-Protokoll (Secure Sockets Layer) verwendet, um eine Verbindung mit dem Zielcomputer herzustellen. Standardmäßig wird SSL nicht verwendet. Ein Wert von $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 ist ein zusätzlicher Schutz, der die Daten über ein HTTPS und nicht über HTTP sendet. 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 ausführliche Nachrichten aus der Aktivität zur angegebenen ausführlichen Datensatzauflistung hinzu, anstatt die ausführlichen Nachrichten in die Konsole oder 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 Warndatensatzauflistung Warnmeldungen aus der Aktivität hinzu, anstatt die Warnmeldungen in die Konsole oder auf den Wert der Warnungseigenschaft 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.
Die Aktivität im folgenden Beispielworkflow verwendet beispielsweise Get-Process den allgemeinen UseDefaultInput-Aktivitätsparameter , um Eingaben abzurufen, die an den Workflow übergeben werden. 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
Ausführlicher <SwitchParameter>
Zeigt detaillierte Informationen zum vom Befehl ausgeführten Vorgang an. Diese Informationen ähneln den Informationen in einer Ablaufverfolgung oder in einem Transaktionsprotokoll. Der Verbose-Parameter überschreibt den Wert der $VerbosePreference Variablen für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl eine ausführliche Nachricht generiert. Dieser Parameter ist auch ein allgemeiner Windows PowerShell-Parameter.
WarningAction <ActionPreference>
Bestimmt, wie die Aktivität auf eine Warnung reagiert. Der Standardwert lautet Continue. Der WarningAction-Parameter überschreibt den Wert der $WarningPreference Variablen für den aktuellen Befehl. Dieser Parameter funktioniert nur, wenn der Befehl eine Warnmeldung generiert. Dieser Parameter ist auch ein allgemeiner Windows PowerShell-Parameter.
Gültige Werte:
SilentlyContinue. Unterdrückt die Warnmeldung und führt den Befehl weiterhin aus.Continue. Zeigt die Warnmeldung an und führt die Ausführung des Befehls fort. Der Standardwert lautetContinue.Inquire. Zeigt die Warnmeldung an und fordert Sie zur Bestätigung auf, bevor Sie die Ausführung fortsetzen. Dieser Wert wird selten verwendet.Stop. Zeigt die Warnmeldung an und beendet die Ausführung des Befehls.
Hinweis
Der WarningAction-Parameter überschreibt nicht den Wert der $WarningAction Einstellungsvariable, 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. Sie können beispielsweise den PSComputerName-Parameter verwenden, um bestimmte Aktivitäten nur auf einer Teilmenge der Zielcomputer auszuführen.
Sie können auch die Parameter PS Verbinden ionRetryCount und PS Verbinden ionRetryIntervalSec verwenden, um die Wiederholungswerte für bestimmte Aktivitäten anzupassen.
Das folgende Beispiel zeigt, wie Sie die allgemeinen PSComputerName-Aktivitätsparameter verwenden, um eine Get-EventLog Aktivität nur auf Computern auszuführen, die eine bestimmte Aktion ausführen Standard.
Workflow Test-Workflow
{
$UserDomain = Get-Content -Path '.\UserComputers.txt'
$Log = (Get-EventLog -LogName "Windows PowerShell" `
-PSComputerName $UserDomain)
if ($Log)
{
# Do Work Here.
}
}
Weitere Informationen
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für