about_WorkflowCommonParameters
KRÁTKÝ POPIS
Toto téma popisuje parametry platné pro všechny příkazy pracovního postupu Windows PowerShellu. Vzhledem k tomu, že modul Windows PowerShellu je přidá 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é vytváříte.
DLOUHÝ POPIS
Běžné parametry pracovního postupu Windows PowerShellu jsou sada parametrů rutiny, které můžete použít se všemi pracovními postupy a aktivitami Prostředí Windows PowerShell. Jsou přidány modulem pracovního postupu Prostředí Windows PowerShell, nikoli autorem pracovního postupu, a jsou automaticky k dispozici pro pracovní postupy a aktivity. Pracovní postupy, které jsou vnořené do hloubky tří úrovní, však nepodporují žádné společné parametry, včetně běžných parametrů pracovního postupu.
Všechny parametry pracovního postupu jsou volitelné a pojmenované (nikoli poziční). Nepřebírají 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, jako je PSAllowRedirection a AsJob, má názvy, které jsou podobné parametrům používaným ve vzdálené komunikace Prostředí Windows PowerShell a úlohách na pozadí. Tyto parametry fungují stejným způsobem jako podobně pojmenované parametry vzdálené komunikace a úlohy, abyste mohli ke správě pracovních postupů použít znalosti, které jste vyvinuli v vzdálené komunikace a úlohách.
Pracovní postupy jsou zavedeny ve Windows PowerShellu 3.0.
POPISY PARAMETRŮ
Tato část popisuje běž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 spuštěné na každém cílovém počítači. Ke správě úlohy použijte rutiny Úlohy. Pokud chcete získat výsledky úlohy, použijte příkaz Receive-Job.
-JobName <String>
Určuje popisný název úlohy pracovního postupu. Ve výchozím nastavení jsou úlohy pojmenované Job<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ž do příkazu nezahrnete parametr AsJob .
Další informace o úlohách prostředí Windows PowerShell 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.
Pokud použijete parametr PSConnectionURI , vzdálený cíl může vrátit instrukce pro přesměrování na jiný identifikátor URI. Ve výchozím nastavení Windows PowerShell nepřesměrovává připojení, ale můžete použít parametr PSAllowRedirection k povolení přesměrování připojení k cílovému počítači.
Můžete také omezit počet, kolikrát je připojení přesměrováno nastavením MaximumConnectionRedirectionCount vlastnosti $PSSessionOption proměnné předvolby, nebo MaximumConnectionRedirectionCount vlastnosti hodnoty PSSessionOption parametru. 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 v příkazu nepoužíváte parametr 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 službu žádosti o připojení. Hodnota tohoto parametru by se měla shodovat s hodnotou vlastnosti URLPrefix 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:
DefaultBasicCredsspDigestKerberosNegotiateNegotiateWithImplicitCredential
Výchozí hodnota je Default.
Informace o hodnotách tohoto parametru naleznete v popisu System.Management.Automation.Runspaces.AuthenticationMechanism výčet v sadě PowerShell SDK.
Upozorňující
Ověřování zprostředkovatele služby CredSSP (Credential Security Service Provider), ve kterém jsou přihlašovací údaje uživatele předány vzdálenému počítači, který se má ověřit, je určený pro příkazy, které vyžadují ověření u více než jednoho prostředku, například pro přístup ke vzdálené síťové sdílené složce. Tento mechanismus zvyšuje riziko zabezpečení vzdálené operace. Pokud dojde k ohrožení zabezpečení vzdáleného počítače, dají se k řízení síťové relace použít 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 Default.
Platné hodnoty jsou:
| Název | Popis |
|---|---|
Unchanged |
Úroveň ověřování je stejná jako předchozí příkaz. |
Default |
Ověřování systému Windows. |
None |
Žádné ověřování modelu COM. |
Connect |
Ověřování modelu COM na úrovni připojení |
Call |
Ověřování modelu COM na úrovni volání |
Packet |
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áty se používají při ověřování na základě klientských certifikátů. Lze je namapovat 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 na jednotce Windows PowerShellu 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í na počítačích určených pomocí tohoto parametru. Ve výchozím nastavení je to místní počítač.
Do seznamu oddělených čárkami zadejte název NETBIOS, IP adresu nebo plně kvalifikovaný název domény jednoho nebo více počítačů. Chcete-li zadat místní počítač, zadejte název localhostpočítače nebo tečku (.).
Pokud chcete zahrnout místní počítač do hodnoty parametru PSComputerName , otevřete Prostředí Windows PowerShell s možností Spustit jako správce .
Pokud je tento parametr z příkazu vynechán, nebo je $null hodnota nebo prázdný řetězec, cíl pracovního postupu je místní počítač a vzdálené komunikace Prostředí Windows PowerShell se ke spuštění příkazu nepoužívá.
Pokud chcete použít IP adresu v hodnotě parametru ComputerName , musí příkaz obsahovat parametr PSCredential . Počítač musí být také nakonfigurovaný pro přenos HTTPS nebo musí být IP adresa vzdáleného počítače zahrnuta do seznamu Důvěryhodných hostitelů WinRM na místním počítači. Pokyny k přidání názvu počítače do seznamu TrustedHosts najdete v části Postup přidání počítače do seznamu důvěryhodných hostitelů v about_Remote_Troubleshooting.
-PSConfigurationName <String>
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í hodnota 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 první pokus o připojení selže. 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 zpoždění mezi pokusy o opakování 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 http://localhost:5985/WSMAN.
Pokud nezadáte psConnectionURI, můžete k zadání hodnot PSConnectionURI použít parametry PSUseSSL, PSComputerName, PSPort a PSApplicationName.
Platné hodnoty pro segment přenosu identifikátoru URI jsou HTTP a HTTPS. Pokud zadáte identifikátor URI připojení s přenosovým segmentem, ale nezadáte port, relace se vytvoří s porty standardů: 80 pro HTTP a 443 HTTPS. Pokud chcete použít výchozí porty pro vzdálené komunikace Prostředí Windows PowerShell, zadejte port 5985 pro PROTOKOL HTTP nebo 5986 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 parametr PSComputerName je součástí příkazu.
Zadejte uživatelské jméno, například User01 nebo Domain01\User01nebo zadejte proměnnou , která obsahuje objekt PSCredential , například takové, 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 se pracovní postup a všechny související prostředky spravují 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 (nula) znamená, 0 že neexistuje žádný uplynulý č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 tabulek hash s jednou tabulkou hash pro každý cílový počítač. V každé tabulce hash je prvním klíčem PSComputerName 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íčem název parametru a hodnota je hodnota parametru.
Příklad:
-PSParameterCollection @{PSComputerName="*"; PSElapsedTimeoutSec=20},
@{PSComputerName="Server02"},
@{PSComputerName="Server03"},
@{PSComputerName="Server01"; PSElapsedTimeoutSec=10}
V předchozím příkladu budou mít všechna připojení výchozí hodnotu PSElapsedTimeoutSec sekund 20 s výjimkou Serveru01, která přepíše výchozí hodnotu zadáním vlastního časového limitu 10 sekund.
-PSPersist <Boolean>
Přidá do pracovního postupu kontrolní body kromě všech kontrolních bodů zadaných v pracovním postupu.
Tento parametr nemůže potlačit kontrolní body v pracovním postupu, například kontrolní body zadané pomocí společného parametru Checkpoint-Workflow aktivity PSPersist, aktivity nebo $PSPersistPreference proměnné.
Kontrolní bod nebo bod trvalosti je snímek stavu pracovního postupu a data zachycená při spuštění pracovního postupu a ukládají se do úložiště trvalosti na disku nebo v databázi SQL. Pracovní postup Windows PowerShellu používá uložená data k obnovení pozastaveného nebo přerušeného pracovního postupu z posledního bodu trvalosti místo restartování pracovního postupu.
Platné hodnoty:
(Výchozí) Pokud tento parametr vynecháte, přidá se kontrolní bod na začátek a konec pracovního postupu kromě kontrolních bodů zadaných v pracovním postupu.
$True. Přidá kontrolní bod na začátek a konec pracovního postupu a kontrolní bod po každé aktivitě, kromě kontrolních bodů zadaných v pracovním postupu.$False. Nejsou přidány žádné kontrolní body. Kontrolní body jsou převzaty pouze v případech, kdy jsou zadány 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).
Nepoužívejte parametr PSPort, pokud není nutné. 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 zabrá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 privátních metadatech pracovního postupu najdete v tématu nápovědy pro pracovní postup.
Tento parametr nezpracovávají modul pracovního postupu Windows PowerShellu. Místo toho modul předá tabulku hash přímo do pracovního postupu.
-PSRunningTimeoutSec <UInt32>
Určuje dobu běhu pracovního postupu v sekundách, s výjimkou doby, kdy je pracovní postup pozastaven. Pokud se provádění pracovního postupu nedokončí, jakmile vyprší čas, modul pracovního postupu Windows PowerShellu vynuceně zastaví provádění pracovního postupu.
-PSSessionOption <PSSessionOption>
Nastaví upřesňující možnosti relací na cílové počítače. Zadejte objekt PSSessionOption, například objekt, který vytvoříte pomocí rutinyNew-PSSessionOption.
Výchozí hodnoty pro možnosti relace jsou určeny hodnotou $PSSessionOption proměnné předvoleb, pokud je nastavena. V opačném případě relace používá hodnoty zadané v konfiguraci relace.
Popis možností relace, včetně výchozích hodnot, naleznete v new-PSSessionOption.
Informace o $PSSessionOption proměnné předvoleb najdete v 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 ssl nepoužívá.
Ws-Management šifruje veškerý obsah Windows PowerShellu přenášený přes síť. UseSSL je další ochrana, která odesílá data přes protokol HTTPS místo protokolu HTTP. Pokud použijete tento parametr, ale ssl není k dispozici na portu použitém pro příkaz, příkaz selže.
