about_WorkflowCommonParameters

Artikel
10/04/2023

KORTE BESCHRIJVING

In dit onderwerp worden de parameters beschreven die geldig zijn voor alle Windows PowerShell-werkstroomopdrachten. Omdat de Windows PowerShell-engine deze toevoegt aan werkstromen, kunt u deze parameters op elke werkstroom gebruiken en worden ze automatisch ingeschakeld voor de werkstromen die u maakt.

LANGE BESCHRIJVING

Algemene parameters voor Windows PowerShell Workflow zijn een set cmdlet-parameters die u kunt gebruiken met alle Windows PowerShell-werkstromen en -activiteiten. Ze worden toegevoegd door de Windows PowerShell Workflow-engine, niet door de auteur van de werkstroom en zijn automatisch beschikbaar voor werkstromen en activiteiten. Werkstromen die zijn genest, bieden echter geen ondersteuning voor algemene parameters, waaronder gemeenschappelijke parameters voor werkstromen.

Alle werkstroomparameters zijn optioneel en benoemd (niet positioneel). Ze nemen geen invoer van de pijplijn.

De meeste algemene parameters van de werkstroom hebben een PS voorvoegsel, zoals PSComputerName en PSCredential. Met de parameters met ps-voorvoegsel configureert u de verbinding en de uitvoeringsomgeving voor de doelcomputers, ook wel 'externe knooppunten' genoemd.

Veel van de algemene parameters van de werkstroom, zoals PSAllowRedirection en AsJob, hebben namen die vergelijkbaar zijn met parameters die worden gebruikt in externe communicatie en achtergrondtaken van Windows PowerShell. Deze parameters werken op dezelfde manier als de op dezelfde manier benoemde externe communicatie en taakparameters, zodat u de kennis kunt gebruiken die u hebt ontwikkeld bij externe communicatie en taken om werkstromen te beheren.

Werkstromen worden geïntroduceerd in Windows PowerShell 3.0.

PARAMETERBESCHRIJVINGEN

In deze sectie worden de algemene parameters van de werkstroom beschreven.

-AsJob <SwitchParameter>

Hiermee wordt de werkstroom uitgevoerd als een werkstroomtaak. De werkstroomopdracht retourneert onmiddellijk een object dat een bovenliggende taak vertegenwoordigt. De bovenliggende taak bevat de onderliggende taken die op elk van de doelcomputers worden uitgevoerd. Gebruik de taak-cmdlets om de taak te beheren. Gebruik Receive-Job om de resultaten van de taak op te halen.

-JobName-tekenreeks <>

Hiermee geeft u een beschrijvende naam voor de werkstroomtaak. Taken worden standaard benoemd Job<n>, waarbij <n> een rangnummer is.

Als u de parameter JobName in een werkstroomopdracht gebruikt, wordt de werkstroom uitgevoerd als een taak en retourneert de werkstroomopdracht een taakobject, zelfs als u de parameter AsJob niet in de opdracht opneemt.

Zie about_Jobs voor meer informatie over Windows PowerShell-achtergrondtaken.

-PSAllowRedirection <SwitchParameter>

Hiermee staat u omleiding van de verbinding met de doelcomputers toe.

Wanneer u de PS Verbinding maken ionURI-parameter gebruikt, kan de externe bestemming een instructie retourneren om om te leiden naar een andere URI. Windows PowerShell leidt standaard geen verbindingen om, maar u kunt de parameter PSAllowRedirection gebruiken om omleiding van de verbinding met de doelcomputer toe te staan.

U kunt ook het aantal keren beperken dat de verbinding wordt omgeleid door de eigenschap Maximum Verbinding maken ionRedirectionCount van de $PSSessionOption voorkeursvariabele of de eigenschap Maximum Verbinding maken ionRedirectionCount van de waarde van de parameter PSSessionOption in te stellen. De standaardwaarde is 5. Zie de beschrijving van de parameter PSSessionOption en New-PSSessionOption voor meer informatie.

-PSApplicationName-tekenreeks <>

Hiermee geeft u het toepassingsnaamsegment op van de verbindings-URI die wordt gebruikt om verbinding te maken met de doelcomputers. Gebruik deze parameter om de naam van de toepassing op te geven wanneer u de parameter Verbinding maken ionURI niet in de opdracht gebruikt.

De standaardwaarde is de waarde van de $PSSessionApplicationName voorkeursvariabele op de lokale computer. Als deze voorkeursvariabele niet is gedefinieerd, is WSMANde standaardwaarde . Deze waarde is geschikt voor de meeste toepassingen. Zie about_Preference_Variables voor meer informatie.

De WinRM-service gebruikt de naam van de toepassing om een listener te selecteren voor de service van de verbindingsaanvraag. De waarde van deze parameter moet overeenkomen met de waarde van de eigenschap URLPrefix van een listener op de externe computer.

-PSAuthentication <AuthenticationMechanism>

Hiermee geeft u het mechanisme op dat wordt gebruikt om de referenties van de gebruiker te verifiëren bij het maken van verbinding met de doelcomputers.

Geldige waarden zijn:

Default
Basic
Credssp
Digest
Kerberos
Negotiate
NegotiateWithImplicitCredential

De standaardwaarde is Default.

Zie de beschrijving van de opsomming System.Management.Automation.Runspaces.AuthenticationMechanism in de PowerShell SDK voor meer informatie over de waarden van deze parameter.

Waarschuwing

CredSSP-verificatie (Credential Security Service Provider), waarbij de referenties van de gebruiker worden doorgegeven aan een externe computer die moet worden geverifieerd, is ontworpen voor opdrachten waarvoor verificatie is vereist voor meer dan één resource, zoals toegang tot een externe netwerkshare. Dit mechanisme verhoogt het beveiligingsrisico van de externe bewerking. Als de externe computer is aangetast, kunnen de referenties die aan de computer worden doorgegeven, worden gebruikt om de netwerksessie te beheren.

-PSAuthenticationLevel AuthenticationLevel <>

Hiermee geeft u het verificatieniveau voor de verbindingen met de doelcomputers. De standaardwaarde is Default.

Geldige waarden zijn:

Name	Beschrijving
`Unchanged`	Het verificatieniveau is hetzelfde als de vorige opdracht.
`Default`	Windows-verificatie.
`None`	Geen COM-verificatie.
`Connect`	com-verificatie op Verbinding maken niveau.
`Call`	COM-verificatie op gespreksniveau.
`Packet`	COM-verificatie op pakketniveau.
`PacketIntegrity`	COM-verificatie op pakketintegriteitsniveau.
`PacketPrivacy`	COM-verificatie op pakketprivacyniveau.

-PSCertificateThumbprint-tekenreeks <>

Hiermee geeft u het certificaat van de digitale openbare sleutel (X509) van een gebruikersaccount dat gemachtigd is om deze actie uit te voeren. Voer de vingerafdruk van het certificaat in.

Certificaten worden gebruikt in verificatie op basis van clientcertificaten. Ze kunnen alleen worden toegewezen aan lokale gebruikersaccounts; ze werken niet met domeinaccounts.

Als u een certificaat wilt ophalen, gebruikt u de cmdlets Get-Item of Get-ChildItem in het Windows PowerShell-station Cert: .

-PSComputerName <String[]>

Hiermee geeft u de lijst met computers die de doelknooppunten van de werkstroom zijn. Opdrachten of activiteiten in een werkstroom worden uitgevoerd op de computers die zijn opgegeven met behulp van deze parameter. Standaard is dit de lokale computer.

Typ de NETBIOS-naam, het IP-adres of de volledig gekwalificeerde domeinnaam van een of meer computers in een door komma's gescheiden lijst. Als u de lokale computer wilt opgeven, typt u de computernaam of localhosteen punt (.).

Als u de lokale computer wilt opnemen in de waarde van de parameter PSComputerName , opent u Windows PowerShell met de optie Als administrator uitvoeren .

Als deze parameter wordt weggelaten uit de opdracht, of deze waarde is $null of een lege tekenreeks, is het werkstroomdoel de lokale computer en wordt externe communicatie met Windows PowerShell niet gebruikt om de opdracht uit te voeren.

Als u een IP-adres wilt gebruiken in de waarde van de parameter ComputerName , moet de opdracht de PSCredential-parameter bevatten. De computer moet ook worden geconfigureerd voor HTTPS-transport of het IP-adres van de externe computer moet worden opgenomen in de winRM TrustedHosts-lijst op de lokale computer. Zie 'How to Add a Computer to the Trusted Host List' (Een computer toevoegen aan de lijst met vertrouwde hosts) in about_Remote_Troubleshooting voor instructies voor het toevoegen van een computernaam aan de lijst TrustedHosts.

-PSConfigurationName <String>

Hiermee geeft u de sessieconfiguraties op die worden gebruikt voor het configureren van sessies op de doelcomputers. Voer een sessieconfiguratie in op de doelcomputers (niet de werkstroomservercomputer). De standaardwaarde is Microsoft.PowerShell.Workflow.

-PS Verbinding maken ionRetryCount <UInt>

Hiermee geeft u het maximum aantal pogingen om verbinding te maken met elke doelcomputer als de eerste verbindingspoging mislukt. Voer een getal in tussen 1 en 4.294.967.295 (UInt.MaxValue). De standaardwaarde nul (0) vertegenwoordigt geen nieuwe pogingen.

-PS Verbinding maken ionRetryIntervalSec <UInt>

Hiermee geeft u de vertraging tussen pogingen voor opnieuw proberen in seconden. De standaardwaarde is nul (0). Deze parameter is alleen geldig wanneer de waarde van PS Verbinding maken ionRetryCount ten minste 1is.

-PS Verbinding maken ionURI <System.Uri>

Hiermee geeft u een URI (Uniform Resource Identifier) op waarmee het verbindingseindpunt voor de werkstroom op de doelcomputer wordt gedefinieerd. De URI moet volledig gekwalificeerd zijn.

De notatie van deze tekenreeks is als volgt:

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

De standaardwaarde is http://localhost:5985/WSMAN.

Als u geen PS Verbinding maken ionURI opgeeft, kunt u de parameters PSUseSSL, PSComputerName, PSPort en PSApplicationName gebruiken om de PS Verbinding maken ionURI-waarden op te geven.

Geldige waarden voor het transportsegment van de URI zijn HTTP en HTTPS. Als u een verbindings-URI met een transportsegment opgeeft, maar geen poort opgeeft, wordt de sessie gemaakt met standaardenpoorten: 80 voor HTTP en 443 voor HTTPS. Als u de standaardpoorten voor externe communicatie met Windows PowerShell wilt gebruiken, geeft u de poort 5985 op voor HTTP of 5986 voor HTTPS.

-PSCredential PSCredential <>

Hiermee geeft u een gebruikersaccount op dat is gemachtigd om een werkstroom uit te voeren op de doelcomputer. Standaard is dit de huidige gebruiker. Deze parameter is alleen geldig wanneer de parameter PSComputerName is opgenomen in de opdracht.

Typ een gebruikersnaam, zoals User01 of Domain01\User01, of voer een variabele in die een PSCredential-object bevat, zoals een variabele die door de Get-Credential cmdlet wordt geretourneerd. Als u alleen een gebruikersnaam invoert, wordt u om een wachtwoord gevraagd.

-PSElapsedTimeoutSec <UInt32>

Bepaalt hoe lang de werkstroom en alle gerelateerde resources in het systeem worden onderhouden. Wanneer de time-out verloopt, wordt de werkstroom verwijderd, zelfs als deze nog wordt verwerkt. Voer een waarde in tussen 10 en 4.294.967.295. De standaardwaarde ( 0 nul) betekent dat er geen time-out is verstreken.

-PSParameterCollection <Hashtable[]>

Hiermee geeft u verschillende algemene parameterwaarden voor werkstroom op voor verschillende doelcomputers.

Voer een door komma's gescheiden lijst met hashtabellen in met één hash-tabel voor elke doelcomputer. In elke hashtabel is de eerste sleutel PSComputerName en de waarde is de naam van de doelcomputer. Jokertekens zijn toegestaan in de computernaam. Voor de resterende sleutels in de hash-tabel is de sleutel de parameternaam en de waarde de parameterwaarde.

Voorbeeld:

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

In het bovenstaande voorbeeld hebben alle verbindingen een standaard PSElapsedTimeoutSec van seconden, met uitzondering van 20 Server01 die de standaardwaarde overschrijft door een eigen time-out van 10 seconden op te geven.

-PSPersist <Booleaanse waarde>

Voegt controlepunten toe aan de werkstroom, naast eventuele controlepunten die zijn opgegeven in de werkstroom.

Deze parameter kan de controlepunten in een werkstroom niet onderdrukken, zoals de parameters die zijn opgegeven met behulp van de algemene parameter psPersist-activiteit , de Checkpoint-Workflow activiteit of de $PSPersistPreference variabele.

Een controlepunt of persistentiepunt is een momentopname van de werkstroomstatus en gegevens die worden vastgelegd terwijl de werkstroom wordt uitgevoerd en wordt opgeslagen in een persistentiearchief op schijf of in een SQL-database. Windows PowerShell Workflow gebruikt de opgeslagen gegevens om een onderbroken of onderbroken werkstroom te hervatten vanaf het laatste persistentiepunt in plaats van de werkstroom opnieuw op te starten.

Geldige waarden:

(Standaard) Als u deze parameter weglaat, wordt er een controlepunt toegevoegd aan het begin en einde van de werkstroom, naast eventuele controlepunten die zijn opgegeven in de werkstroom.
$True. Voegt een controlepunt toe aan het begin en einde van de werkstroom en een controlepunt na elke activiteit, naast eventuele controlepunten die zijn opgegeven in de werkstroom.
$False. Er worden geen controlepunten toegevoegd. Controlepunten worden alleen gebruikt wanneer deze zijn opgegeven in de werkstroom.

-PSPort <Int32>

Hiermee geeft u de netwerkpoort op de doelcomputers. De standaardpoorten zijn 5985 (de WinRM-poort voor HTTP) en 5986 (de WinRM-poort voor HTTPS).

Gebruik de PSPort-parameter alleen als u dit moet doen. De poort die in de opdracht is ingesteld, is van toepassing op alle computers of sessies waarop de opdracht wordt uitgevoerd. Een alternatieve poortinstelling kan verhinderen dat de opdracht wordt uitgevoerd op alle computers. Voordat u een alternatieve poort gebruikt, moet u de WinRM-listener op de externe computer configureren om naar die poort te luisteren.

-PSPrivateMetadata <Hashtable>

Biedt aangepaste informatie voor werkstroomtaken. Voer een hash-tabel in. De sleutels en waarden worden aangepast voor elke werkstroom. Zie het Help-onderwerp voor de werkstroom voor informatie over de persoonlijke metagegevens van een werkstroom.

Deze parameter wordt niet verwerkt door de Windows PowerShell Workflow-engine. In plaats daarvan geeft de engine de hash-tabel rechtstreeks door aan de werkstroom.

-PSRunningTimeoutSec <UInt32>

Hiermee geeft u de actieve tijd van de werkstroom in seconden op, met uitzondering van elk moment dat de werkstroom wordt onderbroken. Als de uitvoering van de werkstroom niet is voltooid wanneer de tijd verloopt, stopt de Windows PowerShell Workflow-engine de uitvoering van de werkstroom geforceerd.

-PSSessionOption <PSSessionOption>

Hiermee stelt u geavanceerde opties voor de sessies in op de doelcomputers. Voer een PSSessionOption-object in, zoals een object dat u maakt met behulp van de New-PSSessionOption cmdlet.

De standaardwaarden voor de sessieopties worden bepaald door de waarde van de $PSSessionOption voorkeursvariabele, als deze is ingesteld. Anders gebruikt de sessie de waarden die zijn opgegeven in de sessieconfiguratie.

Zie new-PSSessionOption voor een beschrijving van de sessieopties, inclusief de standaardwaarden. Zie about_Preference_Variables voor meer informatie over de $PSSessionOption voorkeursvariabele.

-PSUseSSL <SwitchParameter>

Maakt gebruik van het SSL-protocol (Secure Sockets Layer) om verbinding te maken met de doelcomputer. Standaard wordt SSL niet gebruikt.

WS-Management versleutelt alle Windows PowerShell-inhoud die via het netwerk wordt verzonden. UseSSL is een extra beveiliging waarmee de gegevens via een HTTPS worden verzonden in plaats van HTTP. Als u deze parameter gebruikt, maar SSL niet beschikbaar is op de poort die voor de opdracht wordt gebruikt, mislukt de opdracht.