New-PSWorkflowExecutionOption

Modul:

PSWorkflow Module

Vytvoří objekt, který obsahuje možnosti konfigurace relace pro relace pracovního postupu.

Syntax

Default (Výchozí)

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>]

Description

Rutina New-PSWorkflowExecutionOption vytvoří objekt, který obsahuje pokročilé možnosti konfigurace relací pracovního postupu, což jsou konfigurace relací navržené pro spouštění pracovních postupů windows PowerShellu.

Můžete použít objekt PSWorkflowExecutionOption, který New-PSWorkflowExecutionOption vygeneruje jako hodnotu SessionTypeOption parametr rutin, které vytvářejí nebo mění konfiguraci relace, například rutiny Register-PSSessionConfiguration a Set-PSSessionConfiguration.

Každý parametr rutiny New-PSWorkflowExecutionOption představuje vlastnost objektu možnosti konfigurace relace pracovního postupu, který rutina vrátí. Pokud parametr vynecháte, rutina vytvoří objekt s výchozí hodnotou vlastnosti.

Rutina New-PSWorkflowExecutionOption je součástí funkce pracovního postupu Windows PowerShellu.

Do tohoto příkazu můžete také přidat běžné parametry pracovního postupu. Další informace o běžných parametrech pracovního postupu naleznete v tématu about_WorkflowCommonParameters.

Tento cmdlet je zaveden ve Windows PowerShell 3.0.

Příklady

Příklad 1: Vytvoření objektu Možnosti pracovního postupu

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

Tento příkaz používá rutinu New-PSWorkflowExecutionOption ke zvýšení hodnoty MaxSessionsPerWorkflow na 10 a snížení hodnoty MaxDisconnectedSessions na 200.

Výstup ukazuje objekt, který rutina vrací.

Příklad 2: Použití objektu Možnosti pracovního postupu

# 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                   : https://schemas.microsoft.com/powershell/ITWorkflows
MaxConcurrentCommandsPerShell : 1000
allowedactivity               : PSDefaultActivities
UseSharedProcess              : false
ProcessIdleTimeoutSec         : 0
xmlns                         : https://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                    :

První dva příkazy vytvoří nový objekt konfigurace relace a zaregistruje ho.

Třetí příkaz používá rutinu Get-PSSessionConfiguration k získání konfigurace relace ITWorkflows a Format-List k zobrazení všech vlastností konfigurace relace v seznamu. Výstup ukazuje, že možnosti pracovního postupu v konfiguraci relace. Konkrétně má konfigurace relace MaxSessionsPerWorkflow vlastnost s hodnotou 10 a MaxDisconnectedSessions vlastnost s hodnotou 200.

Parametry

-ActivityProcessIdleTimeoutSec

Určuje, jak dlouho je každý proces hostitele aktivity zachován po nečinnosti procesu. Po vypršení intervalu se proces zavře.

Zadejte hodnotu v sekundách. Výchozí hodnota je 60.

Vlastnosti parametru

Typ:	Int32
Default value:	60
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-AllowedActivity

Určuje aktivity, které jsou povoleny ke spuštění v relaci.

Zadejte názvy aktivit kvalifikovaných pro obor názvů, například Microsoft.Powershell.HyperV.Activities.*. Zástupné znaky jsou podporovány. Výchozí hodnota, PSDefaultActivities, zahrnuje integrované aktivity Windows Workflow Foundation a aktivity, které představují rutiny Windows PowerShell Core.

Vlastnosti parametru

Typ:	String[]
Default value:	PSDefaultActivities
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-EnableValidation

Ověřuje, že všechny aktivity pracovního postupu v relaci jsou zahrnuty do seznamu povolených aktivit.

Výchozí hodnota je True. Chcete-li zakázat ověřování, použijte následující formát příkazu: -EnableValidation:$false.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	True
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxActivityProcesses

Určuje maximální počet procesů, které lze vytvořit v relaci pro podporu aktivit pracovního postupu. Výchozí hodnota je 5.

Vlastnosti parametru

Typ:	Int32
Default value:	5
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxConnectedSessions

Určuje maximální počet vzdálených relací, které jsou v provozním stavu. Tato kvóta se použije u relací připojených ke všem vzdáleným uzlům (cílovým počítačům). Výchozí hodnota je 100.

Vlastnosti parametru

Typ:	Int32
Default value:	100
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxDisconnectedSessions

Určuje maximální počet vzdálených relací, které jsou v odpojeném stavu. Tato kvóta se použije u relací připojených ke všem vzdáleným uzlům (cílovým počítačům). Výchozí hodnota je 1000.

Vlastnosti parametru

Typ:	Int32
Default value:	1000
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxPersistenceStoreSizeGB

Určuje maximální velikost úložiště trvalosti přiděleného pracovním postupům spuštěným v relaci v gigabajtech. Při překročení velikosti se úložiště trvalosti rozšíří, aby se uložila všechna trvalá data, ale zobrazí se upozornění a zpráva se zapíše do protokolu událostí pracovního postupu. Výchozí hodnota je 10.

Úložiště trvalosti obsahuje data pro všechny úlohy pracovního postupu. Možnost ukládání dat umožňuje úlohům pokračovat bez ztráty stavu.

Vlastnosti parametru

Typ:	Int64
Default value:	10
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxRunningWorkflows

Určuje maximální počet pracovních postupů, které lze spustit v relaci současně. Výchozí hodnota je 30.

Vlastnosti parametru

Typ:	Int32
Default value:	30
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxSessionsPerRemoteNode

Určuje maximální počet relací, které lze připojit ke každému vzdálenému uzlu (cílovému počítači). Výchozí hodnota je 5.

Vlastnosti parametru

Typ:	Int32
Default value:	5
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxSessionsPerWorkflow

Určuje maximální počet relací, které lze vytvořit pro podporu každého pracovního postupu. Výchozí hodnota je 5.

Vlastnosti parametru

Typ:	Int32
Default value:	5
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-OutOfProcessActivity

Určuje, které povolené aktivity (zadané parametrem AllowedActivities) jsou mimo proces. Výchozí hodnota je inlineScript.

Vlastnosti parametru

Typ:	String[]
Default value:	InlineScript
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PersistencePath

Určuje umístění na disku, kde jsou uloženy stav pracovního postupu a data. Ukládání stavu pracovního postupu a dat umožňuje pozastavení a obnovení pracovních postupů a zotavení po přerušení a selhání sítě.

Výchozí hodnota je $env:LocalAppData\Microsoft\Windows\PowerShell\WF\PS.

Vlastnosti parametru

Typ:	String
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PersistWithEncryption

Označuje, že pracovní postup šifruje data v úložišti trvalosti. Při ukládání dat trvalosti do sdílené síťové složky zvažte použití této funkce.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	$env:LocalAppData\Microsoft\Windows\PowerShell\WF\PS
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RemoteNodeSessionIdleTimeoutSec

Určuje, jak dlouho je relace připojená ke vzdálenému uzlu (cílovému počítači), pokud je nečinná.

Zadejte hodnotu v sekundách. Výchozí hodnota je 60.

Vlastnosti parametru

Typ:	Int32
Default value:	60
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-SessionThrottleLimit

Určuje, kolik operací se vytvoří pro podporu všech pracovních postupů spuštěných v relaci. Výchozí hodnota je 100.

Vlastnosti parametru

Typ:	Int32
Default value:	100
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-WorkflowShutdownTimeoutMSec

Určuje, jak dlouho se relace udržuje po vynuceném pozastavení všech pracovních postupů v relaci. Po vypršení časového limitu Windows PowerShell relaci zavře, i když ještě nejsou všechny pracovní postupy pozastavené.

Zadejte hodnotu v milisekundách. Výchozí hodnota je 500.

Vlastnosti parametru

Typ:	Int32
Default value:	500
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Vstup do této rutiny nelze převést.

Výstupy

PSWorkflowExecutionOption

Poznámky

Pokud je překročena maximální hodnota nastavená možností, příkaz k vytvoření další instance v relaci selže, pokud není uvedeno v popisu parametru. Pokud je například hodnota MaxConnectedSessions 100. Příkaz pro vytvoření relace 101st do vzdáleného uzlu (cílového počítače) selže.

Vlastnosti objektu konfigurace relace se liší podle možností nastavených pro konfiguraci relace a hodnot těchto možností. Konfigurace relací, které používají konfigurační soubor relace, mají také další vlastnosti.

Konkrétně se vlastnosti konfigurací relací, které obsahují PSWorkflowExecutionOptions objektu, liší v závislosti na hodnotách možností pracovního postupu. Pokud například konfigurace relace zahrnuje PSWorkflowExecutionOptions objekt, který nastaví ne výchozí hodnotu pro SessionThrottleLimit vlastnost, má konfigurace relace SessionThrottleLimit vlastnost. V opačném případě to není.

Související odkazy

• New-PSWorkflowSession
• about_Workflows
• informace_o_běžných_parametrech_pracovního_postupu