New-PSWorkflowExecutionOption
Erstellt ein Objekt, das Sitzungskonfigurationsoptionen für Workflowsitzungen enthält.
Syntax
Default (Standard)
New-PSWorkflowExecutionOption
[-PersistencePath <String>]
[-MaxPersistenceStoreSizeGB <Int64>]
[-PersistWithEncryption]
[-MaxRunningWorkflows <Int32>]
[-AllowedActivity <String[]>]
[-OutOfProcessActivity <String[]>]
[-EnableValidation]
[-MaxDisconnectedSessions <Int32>]
[-MaxConnectedSessions <Int32>]
[-MaxSessionsPerWorkflow <Int32>]
[-MaxSessionsPerRemoteNode <Int32>]
[-MaxActivityProcesses <Int32>]
[-ActivityProcessIdleTimeoutSec <Int32>]
[-RemoteNodeSessionIdleTimeoutSec <Int32>]
[-SessionThrottleLimit <Int32>]
[-WorkflowShutdownTimeoutMSec <Int32>]
[<CommonParameters>]
Beschreibung
Das Cmdlet New-PSWorkflowExecutionOption erstellt ein Objekt, das erweiterte Optionen für Workflowsitzungskonfigurationen enthält, d. h. Sitzungskonfigurationen, die zum Ausführen von Windows PowerShell-Workflowworkflows entwickelt wurden.
Sie können das PSWorkflowExecutionOption-Objekt verwenden, das New-PSWorkflowExecutionOption als Wert des SessionTypeOption- Parameters von Cmdlets generiert, die eine Sitzungskonfiguration erstellen oder ändern, z. B. die Register-PSSessionConfiguration und Set-PSSessionConfiguration Cmdlets.
Jeder Parameter des cmdlets New-PSWorkflowExecutionOption stellt eine Eigenschaft des Workflowsitzungskonfigurationsoptionsobjekts dar, das das Cmdlet zurückgibt. Wenn Sie einen Parameter weglassen, erstellt das Cmdlet das Objekt mit einem Standardwert für die Eigenschaft.
Das cmdlet New-PSWorkflowExecutionOption ist Teil des Windows PowerShell-Workflowfeatures.
Sie können diesem Befehl auch allgemeine Workflowparameter hinzufügen. Weitere Informationen zu allgemeinen Workflowparametern finden Sie unter about_WorkflowCommonParameters.
Dieses Cmdlet wird in Windows PowerShell 3.0 eingeführt.
Beispiele
Beispiel 1: Erstellen eines Workflow options-Objekts
New-PSWorkflowExecutionOption -MaxSessionsPerWorkflow 10 -MaxDisconnectedSessions 200
SessionThrottleLimit : 100
PersistencePath : C:\Users\User01\AppData\Local\Microsoft\Windows\PowerShell\WF\PS
MaxPersistenceStoreSizeGB : 10
PersistWithEncryption : False
MaxRunningWorkflows : 30
AllowedActivity : {PSDefaultActivities}
OutOfProcessActivity : {InlineScript}
EnableValidation : True
MaxDisconnectedSessions : 200
MaxConnectedSessions : 100
MaxSessionsPerWorkflow : 10
MaxSessionsPerRemoteNode : 5
MaxActivityProcesses : 5
ActivityProcessIdleTimeoutSec : 60
RemoteNodeSessionIdleTimeoutSec : 60
WorkflowShutdownTimeoutMSec : 500
Dieser Befehl verwendet das Cmdlet New-PSWorkflowExecutionOption, um den wert MaxSessionsPerWorkflow auf 10 zu erhöhen und den MaxDisconnectedSessions- wert auf 200 zu verringern.
Die Ausgabe zeigt das Objekt an, das das Cmdlet zurückgibt.
Beispiel 2: Verwenden eines Workflow options-Objekts
# Create a Workflow Options object and save it in a variable
$wo = New-PSWorkflowExecutionOption -MaxSessionsPerWorkflow 10 -MaxDisconnectedSessions 200
# Create the ITWorkflow session configuration
Register-PSSessionConfiguration -Name ITWorkflows -SessionTypeOption $wo -Force
WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin
Type Keys Name
---- ---- ----
Container {Name=ITWorkflows} ITWorkflows
Get-PSSessionConfiguration ITWorkflows | Format-List -Property *
Architecture : 64
Filename : %windir%\system32\pwrshplugin.dll
ResourceUri : http://schemas.microsoft.com/powershell/ITWorkflows
MaxConcurrentCommandsPerShell : 1000
allowedactivity : PSDefaultActivities
UseSharedProcess : false
ProcessIdleTimeoutSec : 0
xmlns : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
MaxConcurrentUsers : 5
maxsessionsperworkflow : 10
lang : en-US
sessionconfigurationdata : <SessionConfigurationData>
<Param Name='PrivateData'>
<PrivateData>
<ParamName='enablevalidation' Value='True'/>
<Param Name='allowedactivity'Value='PSDefaultActivities' />
<Param Name='outofprocessactivity' Value='InlineScript'/>
<Param Name='maxdisconnectedsessions' Value='200' />
<ParamName='maxsessionsperworkflow' Value='10'/>
</PrivateData>
</Param>
</SessionConfigurationData>
SupportsOptions : true
ExactMatch : true
RunAsUser :
IdleTimeoutms : 7200000
PSVersion : 3.0
OutputBufferingMode : Block
AutoRestart : false
MaxShells : 25
MaxMemoryPerShellMB : 1024
MaxIdleTimeoutMs : 43200000
outofprocessactivity : InlineScript
SDKVersion : 2
Name : ITWorkflows
XmlRenderingType : text
Capability : {Shell}
RunAsPassword :
MaxProcessesPerShell : 15
enablevalidation : True
Enabled : True
maxdisconnectedsessions : 200
MaxShellsPerUser : 25
Permission :
Die ersten beiden Befehle erstellen ein neues Sitzungskonfigurationsobjekt und registrieren es.
Der dritte Befehl verwendet das cmdlet Get-PSSessionConfiguration zum Abrufen der ITWorkflows-Sitzungskonfiguration und des Format-List, um alle Eigenschaften der Sitzungskonfiguration in einer Liste anzuzeigen. Die Ausgabe zeigt, dass die Workflowoptionen in der Sitzungskonfiguration angezeigt werden. Insbesondere verfügt die Sitzungskonfiguration über eine MaxSessionsPerWorkflow--Eigenschaft mit dem Wert 10 und einer MaxDisconnectedSessions Eigenschaft mit dem Wert 200.
Parameter
-ActivityProcessIdleTimeoutSec
Bestimmt, wie lange jeder Aktivitätshostprozess beibehalten wird, nachdem der Prozess im Leerlauf ist. Wenn das Intervall abläuft, wird der Prozess geschlossen.
Geben Sie einen Wert in Sekunden ein. Der Standardwert ist 60.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 60 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-AllowedActivity
Gibt die Aktivitäten an, die in der Sitzung ausgeführt werden dürfen.
Geben Sie namespacequalifizierte Aktivitätsnamen ein, z. B. Microsoft.PowerShell.HyperV.Activities.*.
Wildcardzeichen werden unterstützt. Der Standardwert PSDefaultActivitiesenthält die integrierten Windows Workflow Foundation-Aktivitäten und die Aktivitäten, die die wichtigsten Windows PowerShell-Cmdlets darstellen.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | PSDefaultActivities |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-EnableValidation
Überprüft, ob alle Workflowaktivitäten in der Sitzung in der Liste der zulässigen Aktivitäten enthalten sind.
Der Standardwert ist True. Verwenden Sie zum Deaktivieren der Überprüfung das folgende Befehlsformat: -EnableValidation:$false.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | True |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxActivityProcesses
Gibt die maximale Anzahl von Prozessen an, die in der Sitzung erstellt werden können, um Workflowaktivitäten zu unterstützen. Der Standardwert ist 5.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 5 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxConnectedSessions
Gibt die maximale Anzahl von Remotesitzungen an, die sich in einem Betriebszustand befinden. Dieses Kontingent wird auf Sitzungen angewendet, die mit allen Remoteknoten (Zielcomputern) verbunden sind. Der Standardwert ist 100.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 100 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxDisconnectedSessions
Gibt die maximale Anzahl von Remotesitzungen an, die sich in einem getrennten Zustand befinden. Dieses Kontingent wird auf Sitzungen angewendet, die mit allen Remoteknoten (Zielcomputern) verbunden sind. Der Standardwert lautet „1000“.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 1000 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxPersistenceStoreSizeGB
Gibt die maximale Größe des Persistenzspeichers in Gigabyte an, der Workflows zugeordnet ist, die in der Sitzung ausgeführt werden. Wenn die Größe überschritten wird, wird der Persistenzspeicher erweitert, um alle gespeicherten Daten zu speichern, es wird jedoch eine Warnung angezeigt, und eine Meldung wird in das Workflowereignisprotokoll geschrieben. Der Standardwert ist 10.
Der Persistenzspeicher enthält Daten für alle Workflowaufträge. Mit der Möglichkeit zum Speichern von Daten können die Aufträge fortgesetzt werden, ohne den Zustand zu verlieren.
Parametereigenschaften
| Typ: | Int64 |
| Standardwert: | 10 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxRunningWorkflows
Gibt an, dass die maximale Anzahl von Workflows, die gleichzeitig in der Sitzung ausgeführt werden können. Der Standardwert ist 30.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 30 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxSessionsPerRemoteNode
Gibt die maximale Anzahl von Sitzungen an, die mit jedem Remoteknoten (Zielcomputer) verbunden werden können. Der Standardwert ist 5.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 5 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-MaxSessionsPerWorkflow
Gibt die maximale Anzahl von Sitzungen an, die erstellt werden können, um jeden Workflow zu unterstützen. Der Standardwert ist 5.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 5 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-OutOfProcessActivity
Bestimmt, welche zulässigen Aktivitäten (angegeben durch den parameter AllowedActivities) außerhalb des Prozesses ausgeführt werden. Der Standardwert ist InlineScript-.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | InlineScript |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-PersistencePath
Gibt den Speicherort auf dem Datenträger an, auf dem workflowstatus und -daten gespeichert werden. Das Speichern des Workflowzustands und der Daten ermöglicht das Anhalten und Fortsetzen von Workflows und das Wiederherstellen von Unterbrechungen und Netzwerkfehlern.
Der Standardwert ist $Env:LOCALAPPDATA\Microsoft\Windows\PowerShell\WF\PS.
Parametereigenschaften
| Typ: | String |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-PersistWithEncryption
Gibt an, dass der Workflow die Daten im Persistenzspeicher verschlüsselt. Erwägen Sie die Verwendung dieses Features beim Speichern von Persistenzdaten in einer Netzwerkfreigabe.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | $Env:LOCALAPPDATA\Microsoft\Windows\PowerShell\WF\PS |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-RemoteNodeSessionIdleTimeoutSec
Gibt an, wie lange eine Sitzung, die mit einem Remoteknoten (Zielcomputer) verbunden ist, beibehalten wird, wenn sie im Leerlauf ist.
Geben Sie einen Wert in Sekunden ein. Der Standardwert ist 60.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 60 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-SessionThrottleLimit
Gibt an, wie viele Vorgänge erstellt werden, um alle in der Sitzung gestarteten Workflows zu unterstützen. Der Standardwert ist 100.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 100 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-WorkflowShutdownTimeoutMSec
Gibt an, wie lange die Sitzung beibehalten wird, nachdem alle Workflows in der Sitzung vorübergehend angehalten wurden. Wenn das Timeout abläuft, schließt Windows PowerShell die Sitzung, auch wenn alle Workflows noch nicht angehalten sind.
Geben Sie einen Wert in Millisekunden ein. Der Standardwert ist 500.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 500 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
Eingaben
None
Sie können keine Objekte an dieses Cmdlet weiterleiten.
Ausgaben
PSWorkflowExecutionOption
Hinweise
Wenn der von einer Option festgelegte Maximalwert überschritten wird, schlägt der Befehl zum Erstellen einer anderen Instanz in der Sitzung fehl, sofern nicht in der Parameterbeschreibung angegeben. Wenn beispielsweise der Wert von MaxConnectedSessions 100 ist. Der Befehl zum Erstellen der 101. Sitzung mit einem Remoteknoten (Zielcomputer) schlägt fehl.
Die Eigenschaften eines Sitzungskonfigurationsobjekts variieren je nach den für die Sitzungskonfiguration festgelegten Optionen und den Werten dieser Optionen. Außerdem verfügen Sitzungskonfigurationen, die eine Sitzungskonfigurationsdatei verwenden, über zusätzliche Eigenschaften.
Insbesondere variieren die Eigenschaften von Sitzungskonfigurationen, die eine PSWorkflowExecutionOptions Objekt enthalten, je nach den Workflowoptionswerten. Wenn die Sitzungskonfiguration beispielsweise ein PSWorkflowExecutionOptions- -Objekt enthält, das einen nicht standardmäßigen Wert für die SessionThrottleLimit-eigenschaft-Eigenschaft festlegt, verfügt die Sitzungskonfiguration über eine SessionThrottleLimit--Eigenschaft. Andernfalls ist dies nicht der Fall.
