about_WorkflowCommonParameters

Se aplica a: Windows PowerShell 3.0

TEMA

about_Workflow_Common_Parameters

DESCRIPCIÓN BREVE

En este tema se describen los parámetros válidos en todos los comandos de flujo de trabajo de Windows PowerShell®. Dado que el motor de Windows PowerShell los agrega a los flujos de trabajo, puede usar estos parámetros en cualquier flujo de trabajo y se habilitarán automáticamente en los flujos de trabajo que cree.

DESCRIPCIÓN LARGA

Los parámetros comunes de flujo de trabajo de Windows PowerShell son un conjunto de parámetros de cmdlet que puede usar con todos los flujos de trabajo y actividades de Windows PowerShell. Los agrega el motor de flujo de trabajo de Windows PowerShell, no el autor del flujo de trabajo, y están disponibles automáticamente en todos los flujos de trabajo y actividades. Sin embargo, los flujos de trabajo que están anidados a tres niveles de profundidad no admiten parámetros comunes, incluidos los parámetros comunes de flujo de trabajo.

Todos los parámetros de flujo de trabajo son opcionales y tiene un nombre (no son posicionales). No toman información de entrada de la canalización.

La mayoría de los parámetros comunes de flujo de trabajo tienen un prefijo PS, como PSComputerName y PSCredential. Los parámetros con el prefijo PS configuran la conexión y el entorno de ejecución de los equipos de destino, también denominados "nodos remotos".

Muchos de los parámetros comunes de flujo de trabajo, como PSAllowRedirection y AsJob, tienen nombres similares a los parámetros usados en los trabajos de comunicación remota y en segundo plano de Windows PowerShell. Estos parámetros funcionan igual que los parámetros de trabajos y de comunicación remota de nombre similar, para que pueda aprovechar los conocimientos adquiridos en la comunicación remota y los trabajos para administrar los flujos de trabajo.

Los flujos de trabajo se introdujeron en Windows PowerShell 3.0.

DESCRIPCIONES DE PARÁMETROS

En esta sección se describen los parámetros comunes de flujo de trabajo.

AsJob <SwitchParameter>

Ejecuta el flujo de trabajo como una tarea del flujo de trabajo. El comando de flujo de trabajo devuelve inmediatamente un objeto que representa un trabajo primario. El trabajo primario contiene las tareas secundarias que se ejecutan en cada uno de los equipos de destino. Para administrar el trabajo, use los cmdlets Job. Para obtener los resultados del trabajo, use el cmdlet Receive-Job (https://go.microsoft.com/fwlink/?LinkID=113372).

JobName <String>

Especifica un nombre descriptivo para el trabajo del flujo de trabajo. De forma predeterminada, los trabajos se denominan "Job<n>", donde <n> es un número ordinal.

Si se usa el parámetro JobName en un comando de flujo de trabajo, el flujo de trabajo se ejecuta como un trabajo y el comando de flujo de trabajo devuelve un objeto de trabajo, incluso si no se incluye el parámetro AsJob en el comando.

Para más información sobre los trabajos en segundo plano de Windows PowerShell, consulte about_Jobs (https://go.microsoft.com/fwlink/?LinkID=113251).

PSAllowRedirection <SwitchParameter>

Permite la redirección de la conexión a los equipos de destino.

Cuando se usa el parámetro PSConnectionURI, el destino remoto puede devolver una instrucción para redirigir a otro URI. De forma predeterminada, Windows PowerShell no redirige las conexiones, pero puede usar el parámetro PSAllowRedirection para permitir la redirección de la conexión al equipo de destino.

También puede limitar el número de veces que se redirige la conexión estableciendo la propiedad MaximumConnectionRedirectionCount de la variable de preferencia $PSSessionOption o la propiedad MaximumConnectionRedirectionCount del valor del parámetro PSSessionOption. El valor predeterminado es 5. Para obtener más información, vea la descripción del parámetro PSSessionOption y el cmdlet New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=135237).

PSApplicationName <String>

Especifica el segmento del nombre de aplicación del URI de conexión que se usa para conectarse a los equipos de destino. Utilice este parámetro para especificar el nombre de la aplicación cuando no use el parámetro ConnectionURI en el comando.

El valor predeterminado es el valor de la variable de preferencia $PSSessionApplicationName en el equipo local. Si no se define esta variable de preferencia, el valor predeterminado es WSMAN. Este valor resulta apropiado en la mayoría de los casos. Para más información, consulte about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

El servicio WinRM usa el nombre de aplicación para seleccionar un agente de escucha que atienda la solicitud de conexión. El valor de este parámetro debe coincidir con el valor de la propiedad URLPrefix de un agente de escucha en el equipo remoto.

PSAUTHENTICATION <AuthenticationMechanism>

Especifica el mecanismo que se usa para autenticar las credenciales del usuario al conectarse a los equipos de destino. Los valores válidos son Default, Basic, Credssp, Digest, Kerberos, Negotiate y NegotiateWithImplicitCredential. El valor predeterminado es Default.

Para información sobre los valores de este parámetro, vea la descripción de la enumeración System.Management.Automation.Runspaces.AuthenticationMechanism en MSDN.

PRECAUCIÓN:

el proveedor del servicio de seguridad de credenciales (CredSSP), en el que se pasan las credenciales del usuario a un equipo remoto para autenticarse, está diseñado para comandos que requieren autenticación en más de un recurso, como el acceso a un recurso compartido de red remoto. Este mecanismo aumenta el riesgo de seguridad de la operación remota. Si el equipo remoto pierde su carácter confidencial, las credenciales que se le pasan pueden usarse para controlar la sesión de red.

PSAUTHENTICATIONLEVEL <AuthenticationLevel>

Especifica el nivel de autenticación de las conexiones a los equipos de destino. El valor predeterminado es Default.

Los valores válidos son:

Unchanged:

El nivel de autenticación es el mismo que el del comando anterior.

Default:

Autenticación de Windows

None:

Ninguna autenticación COM.

Connect:

Autenticación de COM de nivel de conexión.

Call:

Autenticación COM de nivel de llamada.

Packet:

Autenticación COM de nivel de paquete.

PacketIntegrity:

Autenticación COM de nivel de integridad de los paquetes.

PacketPrivacy:

Autenticación COM de nivel de privacidad de paquetes.

PSCERTIFICATETHUMBPRINT <String>

Especifica el certificado de clave pública digital (X509) de una cuenta de usuario que tiene permiso para realizar esta acción. Escriba la huella digital del certificado.

Los certificados se usan para la autenticación basada en certificados de cliente. Solo se pueden asignar a cuentas de usuario locales, no funcionan con cuentas de dominio.

Para obtener un certificado, use los cmdlets Get-Item (https://go.microsoft.com/fwlink/?LinkID=113319) o Get-ChildItem (https://go.microsoft.com/fwlink/?LinkID=113308) en la unidad Cert: de Windows PowerShell .

PSCOMPUTERNAME <String[]>

Especifica la lista de equipos que son los nodos de destino del flujo de trabajo. Los comandos o las actividades de un flujo de trabajo se ejecutan en los equipos que se especifican mediante este parámetro. El valor predeterminado es el equipo local.

Escriba el nombre NETBIOS, la dirección IP o el nombre de dominio completo de uno o más equipos en una lista separada por comas. Para especificar el equipo local, escriba el nombre del equipo, "localhost" o un punto (.).

Para incluir el equipo local en el valor del parámetro PSComputerName, abra Windows PowerShell con la opción "Ejecutar como administrador".

Si se omite este parámetro en el comando, o si su valor es $null o una cadena vacía, el destino del flujo de trabajo es el equipo local y no se usa la comunicación remota de Windows PowerShell para ejecutar el comando.

Para usar una dirección IP en el valor del parámetro ComputerName, el comando debe incluir el parámetro PSCredential. Además, el equipo debe estar configurado para el transporte HTTPS, o la dirección IP del equipo remoto debe incluirse en la lista WinRM TrustedHosts en el equipo local. Para instrucciones para agregar un nombre de equipo a la lista TrustedHosts, vea el tema sobre cómo agregar un equipo a la lista de hosts de confianza, en about_Remote_Troubleshooting (https://go.microsoft.com/fwlink/?LinkID=135188).

PSCONFIGURATIONNAME <String>

Especifica las configuraciones de sesión que se usan para configurar las sesiones en los equipos de destino. Especifique una configuración de sesión en los equipos de destino (no en el equipo de servidor de flujo de trabajo). El valor predeterminado es Microsoft.PowerShell.Workflow.

PSCONNECTIONRETRYCOUNT <UInt>

Especifica el número máximo de intentos para conectarse a cada equipo de destino si se produce un error en el primer intento de conexión. Escriba un número entre 1 y 4.294.967.295 (UInt.MaxValue). El valor predeterminado, cero (0), representa que no hay ningún reintento.

PSCONNECTIONRETRYINTERVALSEC <UInt>

Especifica el retardo entre los reintentos de conexión en segundos. El valor predeterminado es 0 (cero). Este parámetro solo es válido cuando el valor de PSConnectionRetryCount es al menos 1.

PSCONNECTIONURI <System.Uri>

Especifica un identificador uniforme de recursos (URI) que define el extremo de conexión del flujo de trabajo en el equipo de destino. El identificador URI debe ser completo.

El formato de esta cadena es:

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

El valor predeterminado es https://localhost:5985/WSMAN.

Si no especifica PSConnectionURI, puede usar los parámetros PSUseSSL, PSComputerName, PSPort y PSApplicationName para especificar los valores de PSConnectionURI.

Los valores válidos para el segmento Transporte del URI son HTTP y HTTPS. Si especifica un URI de conexión con un segmento Transport, pero no indica un puerto, la sesión se creará con los puertos estándar: 80 para HTTP y 443 para HTTPS. Para usar los puertos predeterminados para la comunicación remota de Windows PowerShell, especifique el puerto 5985 para HTTP o 5986 para HTTPS.

PSCREDENTIAL <PSCredential>

Especifica una cuenta de usuario que tiene permiso para ejecutar un flujo de trabajo en el equipo de destino. El valor predeterminado es el usuario actual. Este parámetro solo es válido cuando el parámetro PSComputerName está incluido en el comando.

Escriba un nombre de usuario, como "Usuario01" o "Dominio01\Usuario01", o una variable que contenga un objeto PSCredential, por ejemplo, uno devuelto por el cmdlet Get-Credential. Si escribe solo un nombre de usuario, se le solicitará una contraseña.

PSELAPSEDTIMEOUTSEC <UInt32>

Determina cuánto tiempo se conservan en el sistema el flujo de trabajo y todos los recursos relacionados. Cuando expira el tiempo de espera, se elimina el flujo de trabajo, aunque todavía esté procesando. Escriba un valor entre 10 y 4.294.967.295. El valor predeterminado, 0 (cero), significa que no transcurre tiempo de espera.

PSPARAMETERCOLLECTION <Hashtable[]>

Especifica diferentes valores de parámetro comunes del flujo de trabajo para equipos de destino diferentes.

Escriba una lista de tablas hash separadas por comas con una tabla hash para cada equipo de destino. En cada tabla hash, la primera clave es PSComputerName y su valor es el nombre del equipo de destino. Se permiten caracteres comodín en el nombre del equipo. En cuanto a las claves restantes de la tabla hash, la clave es el nombre del parámetro y el valor es el valor del parámetro.

Por ejemplo:

          -PSParameterCollection @{PSComputerName="Server01";
              PSElapsedTimeoutSec=10; PSConnectionRetryCount=6}, 
              @{PSComputerName="*"; PSElapsedTimeoutSec=20}

PSPERSIST <Boolean>

Agrega puntos de control al flujo de trabajo, además de todos los puntos de control que se especifican en el flujo de trabajo.

Este parámetro no puede suprimir los puntos de control de un flujo de trabajo, como los que se especifican mediante el parámetro común de actividad PSPersist, la actividad Checkpoint-Workflow o la variable $PSPersistPreference.

Un "punto de control" o "punto de persistencia" es una instantánea del estado y los datos del flujo de trabajo que se captura mientras el flujo de trabajo se está ejecutando y se guarda en un almacén de persistencia en disco o en una base de datos SQL. El flujo de trabajo de Windows PowerShell usa los datos guardados para reanudar un flujo de trabajo suspendido o interrumpido desde el último punto de persistencia, en lugar de reiniciar el flujo de trabajo.

Valores válidos:

(Valor predeterminado)

Si se omite este parámetro, se agrega un punto de control al principio y al final del flujo de trabajo, además de los puntos de control que se especifican en el flujo de trabajo.

$True

Agrega un punto de control al principio y al final del flujo de trabajo y un punto de control tras cada actividad, además de los puntos de control que se especifican en el flujo de trabajo.

$False

No se agregan puntos de control. Los puntos de control se toman solo cuando se especifica en el flujo de trabajo.

PSPORT <Int32>

Especifica el puerto de red de los equipos de destino. Los puertos predeterminados son 5985 (el puerto WinRM para HTTP) y 5986 (el puerto WinRM para HTTPS).

No use el parámetro PSPort a menos que sea imprescindible. El puerto establecido en el comando se aplica a todos los equipos o sesiones en los que se ejecuta el comando. Una configuración de puerto alternativo podría impedir que el comando se ejecutara en todos los equipos. Antes de usar un puerto alternativo, debe configurar el agente de escucha de WinRM en el equipo remoto para poder escuchar en ese puerto.

PSPRIVATEMETADATA <Hashtable>

Proporciona información personalizada a las tareas de flujo de trabajo. Especifique una tabla hash. Las claves y los valores se personalizan para cada flujo de trabajo. Para obtener información sobre los metadatos privados de un flujo de trabajo, vea el tema de ayuda del flujo de trabajo.

El motor de flujo de trabajo de Windows PowerShell no procesa este parámetro. En su lugar, el motor transfiere la tabla hash directamente al flujo de trabajo.

PSRUNNINGTIMEOUTSEC <UInt32>

Especifica el tiempo de ejecución del flujo de trabajo en segundos, excluidos los momentos en que el flujo de trabajo se suspenda. Si la ejecución del flujo de trabajo no finaliza antes de que expire el tiempo, el motor de flujo de trabajo de Windows PowerShell fuerza su detención.

PSSESSIONOPTION <PSSessionOption>

Establece opciones avanzadas para las sesiones en los equipos de destino. Especifique un objeto PSSessionOption, como el que creó mediante el cmdlet New-PSSessionOption.

Los valores predeterminados de las opciones de la sesión se determinan con el valor de la variable de preferencia $PSSessionOption, si se establece. De lo contrario, la sesión usa los valores especificados en la configuración de la sesión.

Para obtener una descripción de las opciones de la sesión, incluidos los valores predeterminados, vea el tema de ayuda del cmdlet New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=144305). Para obtener información sobre la variable de preferencia $PSSessionOption, consulte about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

PSUSESSL <SwitchParameter>

Use el protocolo Capa de sockets seguros (SSL) para establecer una conexión con el equipo de destino. De forma predeterminada, no se usa SSL.

WS-Management cifra todo el contenido de Windows PowerShell que se transmite por la red. UseSSL es una protección adicional que envía los datos a través de HTTPS en lugar de HTTP. Si se usa este parámetro, pero SSL no está disponible en el puerto utilizado para el comando, el comando producirá un error.

PALABRAS CLAVE

about_Workflow_Common_Parameters

about_Workflow_CommonParameters

VEA TAMBIÉN

about_ActivityCommonParameters

about_Workflows

Invoke-AsWorkflow

New-PSWorkflowExecutionOption

New-PSWorkflowSession