New-PSWorkflowExecutionOption

Módulo:

PSWorkflow

Crea un objeto que contiene opciones de configuración de sesión para las sesiones de flujo de trabajo.

Sintaxis

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

El cmdlet New-PSWorkflowExecutionOption crea un objeto que contiene opciones avanzadas para configuraciones de sesión de flujo de trabajo, es decir, configuraciones de sesión diseñadas para ejecutar flujos de trabajo de flujo de trabajo de Windows PowerShell.

Puede usar el objeto PSWorkflowExecutionOption que New-PSWorkflowExecutionOption genera como el valor del parámetro SessionTypeOption de cmdlets que crean o cambian una configuración de sesión, como los cmdlets Register-PSSessionConfiguration y Set-PSSessionConfiguration.

Cada parámetro del cmdlet New-PSWorkflowExecutionOption representa una propiedad del objeto de opción de configuración de sesión de flujo de trabajo que devuelve el cmdlet. Si omite un parámetro, el cmdlet crea el objeto con un valor predeterminado para la propiedad .

El cmdlet New-PSWorkflowExecutionOption forma parte de la característica flujo de trabajo de Windows PowerShell.

También puede agregar parámetros comunes de flujo de trabajo a este comando. Para obtener más información sobre los parámetros comunes del flujo de trabajo, consulte about_WorkflowCommonParameters.

Este cmdlet se presenta en Windows PowerShell 3.0.

Ejemplos

Ejemplo 1: Crear un objeto de opciones de flujo de trabajo

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

Este comando usa el cmdlet para aumentar el valor de MaxSessionsPerWorkflow a 10 y reducir el valor de MaxDisconnectedSessions a 200.

La salida muestra el objeto que devuelve el cmdlet.

Ejemplo 2: Usar un objeto De opciones de flujo de trabajo

# 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                    :

Los dos primeros comandos crean un nuevo objeto de configuración de sesión y lo registran.

El tercer comando usa el cmdlet Get-PSSessionConfiguration para obtener la configuración de sesión itWorkflows y el Format-List para mostrar todas las propiedades de la configuración de sesión en una lista. La salida muestra que las opciones de flujo de trabajo en la configuración de sesión. En concreto, la configuración de sesión tiene una propiedad MaxSessionsPerWork flow con un valor de 10 y una propiedad MaxDisconnectedSessions con un valor de 200.

Parámetros

-ActivityProcessIdleTimeoutSec

Determina cuánto tiempo se mantiene cada proceso de host de actividad después de que el proceso quede inactivo. Cuando expira el intervalo, se cierra el proceso.

Escriba un valor en segundos. El valor predeterminado es 60.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	60
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-AllowedActivity

Especifica las actividades que se pueden ejecutar en la sesión.

Escriba nombres de actividad calificados para espacios de nombres, como Microsoft.Powershell.HyperV.Activities.*. Se admiten caracteres comodín. El valor predeterminado, PSDefaultActivities, incluye las actividades integradas de Windows Workflow Foundation y las actividades que representan los cmdlets de Windows PowerShell Core.

Tipo:	String[]
Posición:	Named
Valor predeterminado:	PSDefaultActivities
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-EnableValidation

Comprueba que todas las actividades de flujo de trabajo de la sesión se incluyen en la lista de actividades permitidas.

El valor predeterminado es True. Para deshabilitar la validación, use el siguiente formato de comando: -EnableValidation:$false.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	True
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxActivityProcesses

Especifica el número máximo de procesos que se pueden crear en la sesión para admitir actividades de flujo de trabajo. El valor predeterminado es 5.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	5
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxConnectedSessions

Especifica el número máximo de sesiones remotas que se encuentran en un estado operativo. Esta cuota se aplica a las sesiones conectadas a todos los nodos remotos (equipos de destino). El valor predeterminado es 100.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	100
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxDisconnectedSessions

Especifica el número máximo de sesiones remotas que están en estado desconectado. Esta cuota se aplica a las sesiones conectadas a todos los nodos remotos (equipos de destino). El valor predeterminado es 1000.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	1000
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxPersistenceStoreSizeGB

Especifica el tamaño máximo, en gigabytes, del almacén de persistencia asignado a los flujos de trabajo que se ejecutan en la sesión. Cuando se supera el tamaño, el almacén de persistencia se expande para guardar todos los datos persistentes, pero se muestra una advertencia y se escribe un mensaje en el registro de eventos de flujo de trabajo. El valor predeterminado es 10.

El almacén de persistencia contiene datos para todos los trabajos de flujo de trabajo. La capacidad de almacenar datos permite que los trabajos se reanuden sin perder el estado.

Tipo:	Int64
Posición:	Named
Valor predeterminado:	10
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxRunningWorkflows

Especifica el número máximo de flujos de trabajo que se pueden ejecutar en la sesión simultáneamente. El valor predeterminado es 30.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	30
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxSessionsPerRemoteNode

Especifica el número máximo de sesiones que se pueden conectar a cada nodo remoto (equipo de destino). El valor predeterminado es 5.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	5
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-MaxSessionsPerWorkflow

Especifica el número máximo de sesiones que se pueden crear para admitir cada flujo de trabajo. El valor predeterminado es 5.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	5
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-OutOfProcessActivity

Determina qué actividades permitidas (especificadas por el parámetro AllowedActivities) se ejecutan fuera de proceso. El valor predeterminado es inlineScript.

Tipo:	String[]
Posición:	Named
Valor predeterminado:	InlineScript
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-PersistencePath

Especifica la ubicación en el disco donde se almacenan los datos y el estado del flujo de trabajo. Almacenar el estado del flujo de trabajo y los datos permite suspender y reanudar los flujos de trabajo y recuperarse de interrupciones y errores de red.

El valor predeterminado es $env:LocalAppData\Microsoft\Windows\PowerShell\WF\PS.

Tipo:	String
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-PersistWithEncryption

Indica que el flujo de trabajo cifra los datos en el almacén de persistencia. Considere la posibilidad de usar esta característica al almacenar datos de persistencia en un recurso compartido de red.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	$env:LocalAppData\Microsoft\Windows\PowerShell\WF\PS
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-RemoteNodeSessionIdleTimeoutSec

Especifica cuánto tiempo se mantiene una sesión conectada a un nodo remoto (equipo de destino) si está inactiva.

Escriba un valor en segundos. El valor predeterminado es 60.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	60
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-SessionThrottleLimit

Especifica cuántas operaciones se crean para admitir todos los flujos de trabajo iniciados en la sesión. El valor predeterminado es 100.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	100
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-WorkflowShutdownTimeoutMSec

Especifica cuánto tiempo se mantiene la sesión después de que todos los flujos de trabajo de la sesión se suspendan forzosamente. Cuando expire el tiempo de espera, Windows PowerShell cierra la sesión, incluso si aún no se suspenden todos los flujos de trabajo.

Escriba un valor en milisegundos. El valor predeterminado es 500.

Tipo:	Int32
Posición:	Named
Valor predeterminado:	500
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

None

No se puede canalizar la entrada a este cmdlet.

Salidas

PSWorkflowExecutionOption

Notas

Cuando se supera el valor máximo establecido por una opción, se produce un error en el comando para crear otra instancia en la sesión, a menos que se indique en la descripción del parámetro. Por ejemplo, si el valor de MaxConnectedSessions es 100. Se produce un error en el comando para crear la sesión 101st en un nodo remoto (equipo de destino).

Las propiedades de un objeto de configuración de sesión varían con las opciones establecidas para la configuración de sesión y los valores de esas opciones. Además, las configuraciones de sesión que usan un archivo de configuración de sesión tienen propiedades adicionales.

En concreto, las propiedades de las configuraciones de sesión que incluyen una PSWorkflowExecutionOptions objeto varían en función de los valores de opción de flujo de trabajo. Por ejemplo, si la configuración de sesión incluye un objeto PSWorkflowExecutionOptions que establece un valor no predeterminado para la propiedad sessionThrottleLimit , la configuración de sesión tiene una propiedad SessionThrottleLimit. De lo contrario, no lo hace.

Vínculos relacionados

• New-PSWorkflowSession
• about_Workflows
• about_WorkflowCommonParameters