Over WorkflowCommonParameters
KORTE BESCHRIJVING
In dit onderwerp worden de parameters beschreven die geldig zijn voor alle Windows PowerShell werkstroomopdrachten. Omdat de Windows PowerShell-engine ze 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 van Windows PowerShell Workflow zijn een set cmdlet-parameters die u kunt gebruiken voor alle Windows PowerShell werkstromen en activiteiten. Ze worden toegevoegd door de Windows PowerShell-werkstroomengine, niet door de auteur van de werkstroom, en ze zijn automatisch beschikbaar voor werkstromen en activiteiten. Werkstromen die drie niveaus diep genest zijn, bieden echter geen ondersteuning voor algemene parameters, waaronder algemene parameters voor werkstromen.
Alle werkstroomparameters zijn optioneel en benoemd (niet positioneel). Ze nemen geen invoer van de pijplijn.
De meeste algemene werkstroomparameters hebben een PS-voorvoegsel, zoals PSComputerName en PSCredential. De parameters met ps-voorvoegsel configureren de verbinding en de uitvoeringsomgeving voor de doelcomputers, ook wel 'externe knooppunten' genoemd.
Veel van de algemene werkstroomparameters, zoals PSAllowRedirection en AsJob, hebben namen die vergelijkbaar zijn met parameters die worden gebruikt in Windows PowerShell externe communicatie en achtergrondtaken. Deze parameters werken op dezelfde manier als de parameters voor externe communicatie en taak, zodat u de kennis die u hebt ontwikkeld in externe communicatie en taken kunt gebruiken om werkstromen te beheren.
Werkstromen worden geïntroduceerd in Windows PowerShell 3.0.
PARAMETERBESCHRIJVINGEN
In deze sectie worden de algemene werkstroomparameters beschreven.
-AsJob <SwitchParameter>
Voert de werkstroom uit als een werkstroomtaak. De werkstroomopdracht retourneert onmiddellijk een object dat een bovenliggende taak vertegenwoordigt. De bovenliggende taak bevat de onderliggende taken die worden uitgevoerd op elk van de doelcomputers. Gebruik de taak-cmdlets om de taak te beheren. Gebruik Receive-Job om de taakresultaten op te halen.
-JobName-tekenreeks <>
Hiermee geeft u een beschrijvende naam voor de werkstroomtaak. Standaard hebben taken de naam 'Taak<n>', waarbij <n> een rangnummer is.
Als u de parameter JobName gebruikt in een werkstroomopdracht, wordt de werkstroom uitgevoerd als een taak en retourneert de werkstroomopdracht een taakobject, zelfs als u de AsJob parameter 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 PSConnectionURI parameter gebruikt, kan de externe bestemming een instructie retourneren om om te leiden naar een andere URI. Standaard leidt Windows PowerShell verbindingen niet om, maar u kunt de PSAllowRedirection parameter gebruiken om omleiding van de verbinding naar de doelcomputer toe te staan.
U kunt ook het aantal keren beperken dat de verbinding wordt omgeleid door de MaximumConnectionRedirectionCount eigenschap van de $PSSessionOption voorkeursvariabele of de eigenschap van de MaximumConnectionRedirectionCount waarde van in PSSessionOption parameterte stellen. De standaardwaarde is 5. Zie de beschrijving van de PSSessionOption parameter en New-PSSessionOption voor meer informatie.
-PSApplicationName-tekenreeks <>
Hiermee geeft u het toepassingsnaamsegment 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 ConnectionURI parameter in de opdracht niet gebruikt.
De standaardwaarde is de waarde van de $PSSessionApplicationName voorkeursvariabele op de lokale computer. Als deze voorkeursvariabele niet is gedefinieerd, is de standaardwaarde WSMAN. 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 om de verbindingsaanvraag te verwerken. De waarde van deze parameter moet overeenkomen met de waarde van de URLPrefix eigenschap 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:
- Standaard
- Basic
- Credssp
- Samenvatting
- Kerberos
- Onderhandelen
- NegotiateWithImplicitCredential
De standaardwaarde is Standaard.
Zie de beschrijving van de opsomming in MSDN voor meer informatie over de System.Management.Automation.Runspaces.AuthenticationMechanism waarden van deze parameter.
Waarschuwing
CredSSP-verificatie (Credential Security Service Provider), waarbij de referenties van de gebruiker worden doorgegeven aan een externe computer om te worden geverifieerd, is ontworpen voor opdrachten waarvoor verificatie op meer dan één resource is vereist, zoals toegang tot een externe netwerkshare. Dit mechanisme verhoogt het beveiligingsrisico van de externe bewerking. Als de externe computer is gecompromitteerd, 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 Standaard.
Geldige waarden zijn:
| Naam | Beschrijving |
|---|---|
| Ongewijzigd | Het verificatieniveau is hetzelfde als de vorige opdracht. |
| Standaard | Windows-verificatie. |
| Geen | Geen COM-verificatie. |
| Verbinding maken | COM-verificatie op verbindingsniveau. |
| Call | COM-verificatie op oproepniveau. |
| Pakket | COM-verificatie op pakketniveau. |
| PacketIntegrity | COM-verificatie op pakketintegriteitsniveau. |
| PacketPrivacy | COM-verificatie op pakketprivacyniveau. |
-PSCertificateThumbprint-tekenreeks <>
Hiermee geeft u het digitale openbare sleutelcertificaat (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] (xref:Microsoft.PowerShell.Management.Get-Childitem) in het station Windows PowerShell 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 Fully Qualified Domain Name van een of meer computers in een door komma's gescheiden lijst. Als u de lokale computer wilt opgeven, typt u de computernaam, localhost of een punt (.).
Als u de lokale computer wilt opnemen in de waarde van de PSComputerName parameter, opent u Windows PowerShell met de optie Als administrator uitvoeren.
Als deze parameter wordt weggelaten uit de opdracht, of als de waarde een lege tekenreeks is$null, is het werkstroomdoel de lokale computer en wordt Windows PowerShell externe communicatie niet gebruikt om de opdracht uit te voeren.
Als u een IP-adres in de waarde van de ComputerName parameter wilt gebruiken, 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 'Een computer toevoegen aan de lijst met vertrouwde hosts' in about_Remote_Troubleshooting voor instructies voor het toevoegen van een computernaam aan de lijst met vertrouwde hosts.
-PSConfigurationName-tekenreeks <>
Hiermee geeft u de sessieconfiguraties 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.
-PSConnectionRetryCount <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.
-PSConnectionRetryIntervalSec <UInt>
Hiermee geeft u de vertraging tussen verbindingspogingen in seconden op. De standaardwaarde is nul (0). Deze parameter is alleen geldig als de waarde van PSConnectionRetryCount ten minste 1 is.
-PSConnectionURI <System.Uri>
Hiermee geeft u een URI (Uniform Resource Identifier) op die het verbindingseindpunt voor de werkstroom op de doelcomputer definieert. De URI moet volledig zijn gekwalificeerd.
De indeling van deze tekenreeks is als volgt:
<Transport>://<ComputerName>:<Port>/<ApplicationName>
De standaardwaarde is https://localhost:5985/WSMAN.
Als u geen opgeeft PSConnectionURI, kunt u de PSUseSSLparameters , PSComputerName, PSPorten PSApplicationName gebruiken om de PSConnectionURI waarden op te geven.
Geldige waarden voor het segment Transport van de URI zijn HTTP en HTTPS. Als u een verbindings-URI met een Transport-segment opgeeft, maar geen poort opgeeft, wordt de sessie gemaakt met standaardpoorten: 80 voor HTTP en 443 voor HTTPS. Als u de standaardpoorten voor Windows PowerShell externe toegang wilt gebruiken, geeft u 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 object dat door de Get-Credential cmdlet wordt geretourneerd. Als u alleen een gebruikersnaam invoert, wordt u gevraagd om een wachtwoord.
-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 de werkstroom op voor verschillende doelcomputers.
Voer een door komma's gescheiden lijst met hash-tabellen in met één hash-tabel voor elke doelcomputer. In elke hashtabel is PSComputerName de eerste sleutel en de waarde ervan is de naam van de doelcomputer. Jokertekens zijn toegestaan in de computernaam. Voor de resterende sleutels in de hashtabel is de sleutel de parameternaam en de waarde de parameterwaarde.
Bijvoorbeeld:
-PSParameterCollection @{PSComputerName="*"; PSElapsedTimeoutSec=20},
@{PSComputerName="Server02"},
@{PSComputerName="Server03"},
@{PSComputerName="Server01"; PSElapsedTimeoutSec=10}
In het bovenstaande voorbeeld hebben alle verbindingen een standaard PSElapsedTimeoutSec van 20 seconden, met uitzondering van Server01 die de standaardwaarde overschrijft door een eigen time-out van 10 seconden op te geven.
-PSPersist <Booleaanse waarde>
Hiermee voegt u 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 controlepunten die zijn opgegeven met behulp van de PSPersist algemene parameter 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 worden opgeslagen in een persistentieopslag op schijf of in een SQL-database. Windows PowerShell Werkstroom gebruikt de opgeslagen gegevens om een onderbroken of onderbroken werkstroom te hervatten vanaf het laatste persistentiepunt, in plaats van om de werkstroom opnieuw 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 parameter PSPort 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 op alle computers wordt uitgevoerd. Voordat u een alternatieve poort gebruikt, moet u de WinRM-listener op de externe computer configureren om op die poort te luisteren.
-PSPrivateMetadata <Hashtable>
Biedt aangepaste informatie voor werkstroomtaken. Voer een hashtabel 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-werkstroomengine. In plaats daarvan geeft de engine de hash-tabel rechtstreeks door aan de werkstroom.
-PSRunningTimeoutSec <UInt32>
Hiermee geeft u de duur van de werkstroom in seconden op, met uitzondering van het moment dat de werkstroom wordt onderbroken. Als de uitvoering van de werkstroom niet is voltooid wanneer de tijd is verstreken, stopt de Windows PowerShell werkstroomengine de uitvoering van de werkstroom geforceerd.
-PSSessionOption <PSSessionOption>
Hiermee stelt u geavanceerde opties voor de sessies op de doelcomputers. Voer een PSSessionOption object in, bijvoorbeeld 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 het Help-onderwerp voor de cmdlet (xref:Microsoft.PowerShell.Core.New-PSSessionOption) voor een beschrijving van de sessieopties, inclusief de New-PSSessionOption standaardwaarden. Zie about_Preference_Variables voor meer informatie over de$PSSessionOption voorkeursvariabele.
-PSUseSSL <SwitchParameter>
Maakt gebruik van het SSL-protocol (Secure Sockets Layer) om een verbinding met de doelcomputer tot stand te brengen. Standaard wordt SSL niet gebruikt.
WS-Management versleutelt alle Windows PowerShell inhoud die via het netwerk wordt verzonden. UseSSL is een extra beveiliging die de gegevens verzendt via een HTTPS 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.