Informace o WorkflowCommonParameters

Článek
05/09/2024

KRÁTKÝ POPIS

Toto téma popisuje parametry platné pro všechny příkazy pracovního postupu Windows PowerShell. Protože je modul Windows PowerShell přidává do pracovních postupů, můžete tyto parametry použít u libovolného pracovního postupu a automaticky se povolí u pracovních postupů, které vytvoříte.

DLOUHÝ POPIS

Windows PowerShell Workflow jsou společné parametry rutiny, které můžete použít se všemi pracovními postupy a aktivitami Windows PowerShell. Přidává je modul pracovních postupů Windows PowerShell, nikoli autor pracovního postupu, a jsou automaticky k dispozici v pracovních postupech a aktivitách. Pracovní postupy, které jsou vnořené do tří úrovní hloubky, ale nepodporují žádné společné parametry, včetně běžných parametrů pracovního postupu.

Všechny parametry pracovního postupu jsou volitelné a pojmenované (ne poziční). Nepřijímají vstup z kanálu.

Většina běžných parametrů pracovního postupu má předponu PS, například PSComputerName a PSCredential. Parametry s předponou PS konfigurují připojení a spouštěcí prostředí pro cílové počítače, označované také jako "vzdálené uzly".

Mnoho běžných parametrů pracovního postupu, například PSAllowRedirection a AsJob, má názvy, které se podobají parametrům používaným v Windows PowerShell vzdálené komunikace a úlohách na pozadí. Tyto parametry fungují stejným způsobem jako podobně pojmenované parametry vzdálené komunikace a úlohy, takže ke správě pracovních postupů můžete využít znalosti, které jste získali v oblasti vzdálené komunikace a úloh.

Pracovní postupy jsou zavedeny v Windows PowerShell 3.0.

POPISY PARAMETRŮ

Tato část popisuje společné parametry pracovního postupu.

-AsJob <SwitchParameter>

Spustí pracovní postup jako úlohu pracovního postupu. Příkaz pracovního postupu okamžitě vrátí objekt, který představuje nadřazenou úlohu. Nadřazená úloha obsahuje podřízené úlohy, které běží na každém z cílových počítačů. Ke správě úlohy použijte rutiny úlohy. Pokud chcete získat výsledky úlohy, použijte Receive-Job.

Řetězec -JobName <>

Určuje popisný název úlohy pracovního postupu. Ve výchozím nastavení mají úlohy název "Úloha<n>", kde <n> je pořadové číslo.

Pokud v příkazu pracovního postupu použijete parametr JobName, pracovní postup se spustí jako úloha a příkaz pracovního postupu vrátí objekt úlohy, i když parametr do příkazu nezahrnete AsJob .

Další informace o Windows PowerShell úlohách na pozadí najdete v tématu about_Jobs.

-PSAllowRedirection <SwitchParameter>

Umožňuje přesměrování připojení k cílovým počítačům.

Při použití parametru PSConnectionURI může vzdálený cíl vrátit pokyn k přesměrování na jiný identifikátor URI. Ve výchozím nastavení Windows PowerShell nepřesměrovává připojení, ale pomocí parametru PSAllowRedirection můžete povolit přesměrování připojení k cílovému počítači.

Počet přesměrování připojení můžete také omezit nastavením MaximumConnectionRedirectionCount vlastnosti $PSSessionOption proměnné předvolby nebo MaximumConnectionRedirectionCount vlastnosti hodnoty PSSessionOption parameter. Výchozí hodnota je 5. Další informace najdete v popisu parametru PSSessionOption a new-PSSessionOption.

-PSApplicationName <String>

Určuje segment názvu aplikace identifikátoru URI připojení, který se používá pro připojení k cílovým počítačům. Tento parametr použijte k zadání názvu aplikace, pokud parametr v příkazu nepoužíváte ConnectionURI .

Výchozí hodnota je hodnota $PSSessionApplicationName proměnné předvoleb v místním počítači. Pokud tato proměnná předvoleb není definována, výchozí hodnota je WSMAN. Tato hodnota je vhodná pro většinu použití. Další informace najdete v tématu about_Preference_Variables.

Služba WinRM používá název aplikace k výběru naslouchacího procesu pro obsluhu žádosti o připojení. Hodnota tohoto parametru by měla odpovídat hodnotě URLPrefix vlastnosti naslouchacího procesu ve vzdáleném počítači.

-PSAuthentication <AuthenticationMechanism>

Určuje mechanismus, který se používá k ověření přihlašovacích údajů uživatele při připojování k cílovým počítačům.

Platné hodnoty jsou:

Default
Basic
Credssp
Výtah
Kerberos
Vyjednávat
NegotiateWithImplicitCredential

Výchozí hodnota je Výchozí.

Informace o hodnotách tohoto parametru naleznete v popisu výčtu System.Management.Automation.Runspaces.AuthenticationMechanism v MSDN.

Upozornění

Ověřování credSSP (Credential Security Service Provider), při kterém se přihlašovací údaje uživatele předávají vzdálenému počítači k ověření, je určeno pro příkazy, které vyžadují ověření na více než jednom prostředku, jako je například přístup ke vzdálené síťové složce. Tento mechanismus zvyšuje bezpečnostní riziko vzdálené operace. Pokud dojde k ohrožení zabezpečení vzdáleného počítače, mohou být k řízení síťové relace použity přihlašovací údaje, které jsou mu předány.

-PSAuthenticationLevel <AuthenticationLevel>

Určuje úroveň ověřování pro připojení k cílovým počítačům. Výchozí hodnota je Výchozí.

Platné hodnoty jsou:

Název	Description
Nezměněn	Úroveň ověřování je stejná jako u předchozího příkazu.
Default	Ověřování systému Windows.
Žádný	Žádné ověřování modelu COM.
Připojit	Ověřování modelu COM na úrovni připojení.
Call	Ověřování modelu COM na úrovni volání.
Paket	Ověřování modelu COM na úrovni paketů.
PacketIntegrity	Ověřování modelu COM na úrovni integrity paketů.
PacketPrivacy	Ověřování modelu COM na úrovni ochrany osobních údajů paketů.

-PSCertificateThumbprint <String>

Určuje certifikát digitálního veřejného klíče (X509) uživatelského účtu, který má oprávnění k provedení této akce. Zadejte kryptografický otisk certifikátu certifikátu.

Certifikáty se používají při ověřování na základě klientských certifikátů. Mohou být mapovány pouze na místní uživatelské účty; nefungují s doménovými účty.

Pokud chcete získat certifikát, použijte rutiny Get-Item nebo [Get-ChildItem] (xref:Microsoft.PowerShell.Management.Get-Childitem) v jednotce Windows PowerShell Cert: .

-PSComputerName <String[]>

Určuje seznam počítačů, které jsou cílovými uzly pracovního postupu. Příkazy nebo aktivity v pracovním postupu se spouštějí na počítačích určených pomocí tohoto parametru. Výchozí hodnotou je místní počítač.

Do seznamu odděleného čárkami zadejte název netBIOS, IP adresu nebo plně kvalifikovaný název domény jednoho nebo více počítačů. Pokud chcete zadat místní počítač, zadejte název počítače , "localhost" nebo tečku (.).

Pokud chcete zahrnout místní počítač do hodnoty parametruPSComputerName, otevřete Windows PowerShell s možností Spustit jako správce.

Pokud je tento parametr v příkazu vynechán nebo je $null hodnota nebo prázdný řetězec, je cílem pracovního postupu místní počítač a Windows PowerShell vzdálené komunikace se ke spuštění příkazu nepoužívá.

Pokud chcete použít IP adresu v hodnotě parametru ComputerName , musí příkaz obsahovat PSCredential parametr . Počítač také musí být nakonfigurován pro přenos HTTPS nebo IP adresa vzdáleného počítače musí být zahrnuta v seznamu WinRM TrustedHosts na místním počítači. Pokyny pro přidání názvu počítače do seznamu TrustedHosts najdete v části How to Add a Computer to the Trusted Host List (Přidání počítače do seznamu důvěryhodných hostitelů) v about_Remote_Troubleshooting.

Řetězec -PSConfigurationName <>

Určuje konfigurace relací, které se používají ke konfiguraci relací na cílových počítačích. Zadejte konfiguraci relace na cílových počítačích (ne na počítači serveru pracovního postupu). Výchozí formát je Microsoft.PowerShell.Workflow.

-PSConnectionRetryCount <UInt>

Určuje maximální počet pokusů o připojení ke každému cílovému počítači, pokud se první pokus o připojení nezdaří. Zadejte číslo od 1 do 4 294 967 295 (UInt.MaxValue). Výchozí hodnota nula (0) představuje žádné pokusy o opakování.

-PSConnectionRetryIntervalSec <UInt>

Určuje prodlevu mezi opakovanými pokusy o připojení v sekundách. Výchozí hodnota je nula (0). Tento parametr je platný pouze v případě, že hodnota PSConnectionRetryCount je alespoň 1.

-PSConnectionURI <System.Uri>

Určuje identifikátor URI (Uniform Resource Identifier), který definuje koncový bod připojení pro pracovní postup v cílovém počítači. Identifikátor URI musí být plně kvalifikovaný.

Formát tohoto řetězce je následující:

<Transport>://<ComputerName>:<Port>/<ApplicationName>

Výchozí hodnota je https://localhost:5985/WSMAN.

Pokud nezadáte PSConnectionURI, můžete k zadání PSConnectionURI hodnot použít PSUseSSLparametry , PSComputerName, PSPorta PSApplicationName .

Platné hodnoty pro segment Transport v identifikátoru URI jsou HTTP a HTTPS. Pokud zadáte identifikátor URI připojení se segmentem Přenos, ale nezadáte port, vytvoří se relace se standardními porty: 80 pro HTTP a 443 pro HTTPS. Pokud chcete pro Windows PowerShell vzdálené komunikace použít výchozí porty, zadejte port 5985 pro HTTP nebo 5986 pro HTTPS.

-PSCredential <PSCredential>

Určuje uživatelský účet, který má oprávnění ke spuštění pracovního postupu v cílovém počítači. Ve výchozím nastavení je to aktuální uživatel. Tento parametr je platný pouze v případě, že je parametr PSComputerName zahrnutý v příkazu.

Zadejte uživatelské jméno, například User01 nebo Domain01\User01, nebo zadejte proměnnou obsahující PSCredential objekt, například ten, který rutina Get-Credential vrátí. Pokud zadáte jenom uživatelské jméno, zobrazí se výzva k zadání hesla.

-PSElapsedTimeoutSec <UInt32>

Určuje, jak dlouho jsou pracovní postup a všechny související prostředky udržovány v systému. Po vypršení časového limitu se pracovní postup odstraní, i když se stále zpracovává. Zadejte hodnotu od 10 do 4 294 967 295. Výchozí hodnota 0 (nula) znamená, že neuplyne žádný časový limit.

-PSParameterCollection <Hashtable[]>

Určuje různé společné hodnoty parametrů pracovního postupu pro různé cílové počítače.

Zadejte čárkami oddělený seznam zatřiďovacích tabulek s jednou tabulkou hash pro každý cílový počítač. V každé tabulce hash je PSComputerName první klíč a jeho hodnota je název cílového počítače. V názvu počítače jsou povoleny zástupné znaky. Pro zbývající klíče v tabulce hash je klíč název parametru a hodnota je hodnota parametru.

Příklad:

-PSParameterCollection @{PSComputerName="*"; PSElapsedTimeoutSec=20},
@{PSComputerName="Server02"},
@{PSComputerName="Server03"},
@{PSComputerName="Server01"; PSElapsedTimeoutSec=10}

Ve výše uvedeném příkladu budou mít všechna připojení výchozí hodnotu PSElapsedTimeoutSec 20 sekund s výjimkou serveru Server01, který přepíše výchozí hodnotu zadáním vlastního časového limitu 10 sekund.

-PSPersist <Logická hodnota>

Přidá kontrolní body do pracovního postupu, kromě všech kontrolních bodů, které jsou zadány v pracovním postupu.

Tento parametr nemůže potlačit kontrolní body v pracovním postupu, například ty, které jsou určené pomocí společného parametru PSPersistCheckpoint-Workflow aktivity, aktivity nebo $PSPersistPreference proměnné.

"Kontrolní bod" nebo "bod trvalosti" je snímek stavu pracovního postupu a dat, která jsou zachycena během běhu pracovního postupu a jsou uložena do úložiště trvalosti na disku nebo v databázi SQL. Windows PowerShell Pracovní postup používá uložená data k obnovení pozastaveného nebo přerušeného pracovního postupu od posledního bodu trvalosti, nikoli k restartování pracovního postupu.

Platné hodnoty:

(Výchozí) Pokud tento parametr vynecháte, přidá se na začátek a konec pracovního postupu kromě kontrolních bodů zadaných v pracovním postupu také kontrolní bod.
$True. Přidá kontrolní bod na začátek a konec pracovního postupu a kontrolní bod za každou aktivitu, kromě všech kontrolních bodů, které jsou zadány v pracovním postupu.
$False. Nepřidávají se žádné kontrolní body. Kontrolní body se vezmou jenom v případech, kdy jsou zadané v pracovním postupu.

-PSPort <Int32>

Určuje síťový port na cílových počítačích. Výchozí porty jsou 5985 (port WinRM pro HTTP) a 5986 (port WinRM pro HTTPS).

Pokud je to nutné, nepoužívejte parametr PSPort. Port nastavený v příkazu se vztahuje na všechny počítače nebo relace, na kterých se příkaz spouští. Alternativní nastavení portu může bránit spuštění příkazu na všech počítačích. Před použitím alternativního portu musíte nakonfigurovat naslouchací proces WinRM na vzdáleném počítači tak, aby naslouchal na tomto portu.

-PSPrivateMetadata <Hashtable>

Poskytuje přizpůsobené informace pro úlohy pracovního postupu. Zadejte tabulku hash. Klíče a hodnoty jsou přizpůsobené pro každý pracovní postup. Informace o soukromých metadatech pracovního postupu najdete v tématu nápovědy k pracovnímu postupu.

Tento parametr není zpracován modulem pracovního postupu Windows PowerShell. Místo toho modul předá tabulku hash přímo pracovnímu postupu.

-PSRunningTimeoutSec <UInt32>

Určuje dobu běhu pracovního postupu v sekundách, s výjimkou doby, kdy je pracovní postup pozastaven. Pokud provádění pracovního postupu není dokončeno po uplynutí času, modul Windows PowerShell Workflow vynuceně zastaví provádění pracovního postupu.

-PSSessionOption <PSSessionOption>

Nastaví upřesňující možnosti pro relace cílových počítačů. PSSessionOption Zadejte objekt, například objekt, který vytvoříte pomocí rutiny New-PSSessionOption .

Výchozí hodnoty možností relace jsou určeny hodnotou $PSSessionOption proměnné předvoleb, pokud je nastavená. Jinak relace použije hodnoty zadané v konfiguraci relace.

Popis možností relace, včetně výchozích hodnot, najdete v tématu nápovědy pro rutinu New-PSSessionOption (xref:Microsoft.PowerShell.Core.New-PSSessionOption). Informace o proměnné předvoleb najdete v $PSSessionOption tématu about_Preference_Variables.

-PSUseSSL <SwitchParameter>

Používá protokol SSL (Secure Sockets Layer) k navázání připojení k cílovému počítači. Ve výchozím nastavení se protokol SSL nepoužívá.

WS-Management šifruje veškerý obsah Windows PowerShell přenášený přes síť. UseSSL je dodatečná ochrana, která odesílá data přes PROTOKOL HTTPS místo protokolu HTTP. Pokud použijete tento parametr, ale na portu použitém pro příkaz není k dispozici protokol SSL, příkaz selže.

Sdílet prostřednictvím