Sdílet prostřednictvím

O společnosti 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 společ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é jsou podobné parametrům používaným v úlohách vzdálené komunikace a na pozadí prostředí Windows PowerShell. 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.

-Řetězec názvu úlohy <>

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, a to i v případě, že parametr do příkazu nezahrnete AsJob .

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

-PSAllowRedirection <– parametr přepínače>

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

Když použijete parametr, PSConnectionURI vzdálený cíl může vrátit instrukci k 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 pomocí parametru PSAllowRedirection povolit přesměrování připojení na cílový počítač.

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

Řetězec -PSApplicationName <>

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 slouží k určení názvu aplikace, když nepoužíváte ConnectionURI parametr v příkazu.

Výchozí hodnota je hodnota proměnné předvoleb $PSSessionApplicationName 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 části 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 URLPrefix vlastnosti naslouchacího procesu na 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:

  • výchozí
  • Základní
  • Credssp řekl:
  • Přehled
  • Kerberos
  • Vyjednávat
  • NegotiateWithImplicitCredential

Výchozí hodnota je Default.

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

Výstraha

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 <– úroveň ověřování>

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
Nezměněný Úroveň ověřování je stejná jako předchozí příkaz.
výchozí Ověřování systému Windows.
Nic Žádné ověřování modelu COM.
Připojit Ověřování modelu COM na úrovni připojení
Zavolat Ověřování modelu COM na úrovni volání
Balíček Ověřování modelu COM na úrovni paketů
Integrita paketů Ověřování modelu COM na úrovni integrity paketů
PacketPrivacy Ověřování modelu COM na úrovni ochrany osobních údajů paketů

-PSCertificateŘetězec kryptografického otisku <>

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.

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

-PSComputerName <– řetězec[]>

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. Výchozí hodnota je 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 počítače, "localhost" nebo tečku (.).

Chcete-li do hodnoty parametru PSComputerName zahrnout místní počítač, 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á.

Chcete-li v hodnotě parametru ComputerName použít IP adresu, musí příkaz tento PSCredential parametr obsahovat. 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 pro přidání názvu počítače do seznamu TrustedHosts naleznete v části "Jak přidat počítač 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í 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 v rozmezí 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 https://localhost:5985/WSMAN.

Pokud neurčíte , PSConnectionURImůžete k určení hodnot použít PSConnectionURIPSUseSSLparametry , PSComputerName, PSPorta 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 pro HTTPS. Pokud chcete použít výchozí porty pro vzdálené komunikace Prostředí Windows PowerShell, 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. Výchozí hodnota je aktuální uživatel. Tento parametr je platný pouze v případě, že je v příkazu zahrnut parametr PSComputerName.

Zadejte uživatelské jméno, například "Uživatel01" nebo "Doména01\Uživatel01", nebo zadejte proměnnou, která obsahuje PSCredential objekt, například ten, který vrátí rutina Get-Credential . 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, 0 (nula), znamená, že neuplynul žádný časový limit.

-Zatřiďovací tabulka PSParameterCollection <[]>

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é zatřiďovací tabulce 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íčem název parametru a hodnota je hodnota parametru.

Napří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 připojení Server01, 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 ty, které jsou určeny pomocí společného parametru PSPersist aktivity, aktivity Checkpoint-Workflow nebo proměnné $PSPersistPreference .

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, bude na začátek a konec pracovního postupu přidán kontrolní bod, který doplní všechny kontrolní body určené 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).

Parametr PSPort nepoužívejte, pokud to 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 <– zatřiďovací tabulka>

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. PSSessionOption Zadejte objekt, například ten, 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 tématu nápovědy k rutině New-PSSessionOption (xref:Microsoft.PowerShell.Core.New-PSSessionOption). Informace o proměnné předvoleb $PSSessionOption naleznete v tématu about_Preference_Variables.

-PSUseSSL <Parametr přepínače>

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 namí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.

VIZ TAKÉ

  • Last updated on