about_WorkflowCommonParameters

Aplica-se a: Windows PowerShell 3.0

TÓPICO

about_Workflow_Common_Parameters

DESCRIÇÃO BREVE

Este tópico descreve os parâmetros que são válidos em todos os Windows PowerShell® comandos de fluxo de trabalho. Como o Windows PowerShell mecanismo os adiciona aos fluxos de trabalho, você pode usar esses parâmetros em qualquer fluxo de trabalho e eles serão automaticamente habilitados nos fluxos de trabalho que você criar.

DESCRIÇÃO LONGA

Windows PowerShell Os parâmetros comuns de fluxo de trabalho são um conjunto de parâmetros do cmdlet que você pode usar com todos os Windows PowerShell fluxos de trabalho e atividades. Eles são adicionados pelo Windows PowerShell mecanismo de fluxo de trabalho, não pelo autor do fluxo de trabalho, e são disponibilizados automaticamente em todo fluxo de trabalho e atividade. No entanto, os fluxos de trabalho aninhados a três níveis de profundidade não dão suporte a nenhum parâmetro comum, inclusive parâmetros comuns de fluxo de trabalho.

Todos os parâmetros de fluxo de trabalho são opcionais e recebem um nome (não posicionais). Eles não podem receber entradas do pipeline.

A maioria dos parâmetros comuns de fluxo de trabalho têm prefixo PS, como PSComputerName e PSCredential. Os parâmetros de prefixo PS configuram a conexão e o ambiente de execução para os computadores de destino, também conhecidos como "nós remotos."

Muitos dos parâmetros comuns do fluxo de trabalho, como PSAllowRedirection e AsJob, têm nomes semelhantes aos parâmetros usados nos Windows PowerShell trabalhos em segundo plano e de comunicação remota. Esses parâmetros funcionam da mesma forma que os parâmetros de comunicação remota e de tarefa com nomes semelhantes, assim você pode usar o conhecimento que você desenvolveu em comunicação remota e nas tarefas de gerenciamento de fluxos de trabalho.

Os fluxos de trabalho são introduzidos no Windows PowerShell 3.0.

DESCRIÇÕES DE PARÂMETRO

Esta seção descreve os parâmetros comuns de fluxo de trabalho.

AsJob <SwitchParameter>

Executa o fluxo de trabalho como uma tarefa de fluxo de trabalho. O comando de fluxo de trabalho retorna imediatamente um objeto que representa uma tarefa mãe. A tarefa mãe contém as tarefas filho que estão sendo executadas em cada um dos computadores de destino. Para gerenciar o trabalho, use os cmdlets Job. Para obter os resultados da tarefa, use o cmdlet Receive-Job (https://go.microsoft.com/fwlink/?LinkID=113372).

JobName <Cadeia de caracteres>

Especifica um nome amigável para a tarefa de fluxo de trabalho. Por padrão, as tarefas recebem o nome de "Job<n>", em que <n> é um número ordinal.

Se você usar o parâmetro JobName em um comando de fluxo de trabalho, o fluxo de trabalho é executado como uma tarefa e o comando de fluxo de trabalho retorna um objeto de tarefa, mesmo que você não inclua o parâmetro AsJob no comando.

Para obter mais informações sobre Windows PowerShell as tarefas em segundo plano, consulte about_Jobs (https://go.microsoft.com/fwlink/?LinkID=113251).

PSAllowRedirection <SwitchParameter>

Permite o redirecionamento da conexão para os computadores de destino.

Quando você usa o parâmetro PSConnectionURI, o destino remoto pode retornar uma instrução de redirecionamento para um URI diferente. Por padrão, Windows PowerShell não redireciona conexões, mas você pode usar o parâmetro PSAllowRedirection para permitir o redirecionamento da conexão com o computador de destino.

Você também pode limitar o número de vezes em que a conexão é redirecionada, definindo a propriedade MaximumConnectionRedirectionCount da variável preferencial $PSSessionOption ou a propriedade MaximumConnectionRedirectionCount do valor do parâmetro PSSessionOption. O valor padrão é 5. Para obter mais informações, consulte a descrição do parâmetro PSSessionOption e do cmdlet New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=135237).

PSApplicationName <Cadeia de caracteres>

Especifica o segmento de nome de aplicativo da conexão URI que é usado para conexão aos computadores de destino. Use esse parâmetro para especificar o nome do aplicativo quando você não estiver usando o parâmetro ConnectionURI no comando.

O valor padrão é o valor da variável preferencial $PSSessionApplicationName no computador local. Se essa variável preferencial não estiver definida, o valor padrão é WSMAN. Esse valor é adequado para a maioria dos usos. Para obter mais informações, consulte about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

O serviço WinRM usa o nome do aplicativo para selecionar um ouvinte para atender à solicitação de conexão. O valor desse parâmetro deve corresponder ao valor da propriedade URLPrefix de um ouvinte no computador remoto.

PSAUTHENTICATION <AuthenticationMechanism>

Especifica o mecanismo usado para autenticar as credenciais do usuário que se conecta aos computadores de destino. Os valores válidos são Default, Basic, Credssp, Digest, Kerberos, Negotiate e NegotiateWithImplicitCredential. O valor padrão é Default.

Para obter informações sobre os valores desse parâmetro, consulte a descrição da enumeração System.Management.Automation.Runspaces.AuthenticationMechanism no MSDN.

CUIDADO:

A autenticação de segurança de credencial Service Provider (CredSSP), na qual as credenciais do usuário são passadas para um computador remoto para serem autenticadas, foi projetada para comandos que exijam autenticação em mais de um recurso, como acessar um compartilhamento de rede remota. Esse mecanismo aumenta o risco de segurança da operação remota. Se o computador remoto estiver comprometido, as credenciais passadas a ele poderão ser usadas para controlar a sessão de rede.

PSAUTHENTICATIONLEVEL <AuthenticationLevel>

Especifica o nível de autenticação para conexões aos computadores de destino. O valor padrão é Default.

Os valores válidos são:

Inalterado:

O nível de autenticação é o mesmo do comando anterior.

Padrão:

Autenticação do Windows.

Nenhuma:

Nenhuma autenticação de COM.

Conectar:

Autenticação COM em nível de conexão.

Chame:

Autenticação COM em nível de chamada.

Pacote:

Autenticação COM em nível de pacote.

Privacidade:

Autenticação COM de pacote em nível de integridade.

Privacidade do pacote:

Autenticação COM de pacote em nível de privacidade.

PSCERTIFICATETHUMBPRINT <cadeia de caracteres>

Especifica o certificado de chave pública digital (X509) de uma conta de usuário com permissão para executar essa ação. Insira a impressão digital do certificado.

Os certificados são utilizados na autenticação baseada em certificado do cliente. Eles podem ser mapeados somente para contas locais de usuário; eles não funcionam com contas de domínio.

Para obter um certificado, use o Get-Item (https://go.microsoft.com/fwlink/?LinkID=113319) ou os cmdlets Get-ChildItem (https://go.microsoft.com/fwlink/?LinkID=113308) no Windows PowerShell Cert: unidade.

PSComputerName <Cadeia de caracteres[]>

Especifica a lista de computadores que são os nós de destino do fluxo de trabalho. Os comandos ou atividades em um fluxo de trabalho são executados nos computadores que são especificados por meio desse parâmetro. O padrão é o computador local.

Digite o nome NETBIOS, o endereço IP ou o nome de domínio totalmente qualificado de um ou mais computadores em uma lista separada por vírgulas. Para especificar o computador local, digite o nome do computador, um ponto (.) ou então "localhost".

Para incluir o computador local no valor do parâmetro PSComputerName, abra Windows PowerShell com a opção "Executar como administrador".

Se esse parâmetro for omitido do comando, ou se seu valor for $null ou uma cadeia de caracteres vazia, o destino do fluxo de trabalho será o computador local e a comunicação remota do Windows PowerShell não será usada para executar o comando.

Para usar um endereço IP no valor do parâmetro ComputerName, o comando deve incluir o parâmetro PSCredential. Além disso, o computador deve ser configurado para o transporte HTTPS ou o endereço IP do computador remoto deve ser incluído na lista WinRM TrustedHosts no computador local. Para obter instruções sobre como adicionar um nome de computador à lista TrustedHosts, consulte "Como adicionar um computador na Lista de Hosts Confiáveis" em about_Remote_Troubleshooting (https://go.microsoft.com/fwlink/?LinkID=135188).

PSCONFIGURATIONNAME <Cadeia de caracteres>

Especifica as configurações de sessão usadas para configurar sessões nos computadores de destino. Insira uma configuração de sessão nos computadores de destino (não no computador do servidor de fluxo de trabalho). O padrão é Microsoft.PowerShell.Workflow.

PSCONNECTIONRETRYCOUNT <UInt>

Especifica o número máximo de tentativas de conexão para cada computador de destino se a primeira tentativa de conexão falhar. Digite um número entre 1 e 4.294.967.295 (UInt.MaxValue). O valor padrão, zero (0), representa nenhuma tentativa de repetição.

PSCONNECTIONRETRYINTERVALSEC <UInt>

Especifica o intervalo entre tentativas de conexão em segundos. O valor padrão é zero (0). Este parâmetro é válido somente quando o valor de PSConnectionRetryCount for no mínimo 1.

PSCONNECTIONURI <System.Uri>

Especifica um URI (Uniform Resource Identifier) que define o ponto de extremidade da conexão para o fluxo de trabalho no computador de destino. O URI deve ser totalmente qualificado.

O formato dessa cadeia de caracteres é o seguinte:

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

O valor padrão é https://localhost:5985/WSMAN.

Se você não especificar um PSConnectionURI, você pode usar os parâmetros PSUseSSL, PSComputerName, PSPort e PSApplicationName para especificar os valores de PSConnectionURI.

Os valores válidos para o segmento de transporte do URI são HTTP e HTTPS. Se você especificar uma conexão URI com um segmento de Transporte, mas não especificar uma porta, a sessão é criada com portas padrão: 80 para HTTP e 443 para HTTPS. Para usar as portas padrão para a comunicação remota do Windows PowerShell, especifique a porta 5985 para HTTP ou 5986 para HTTPS.

PSCREDENTIAL <PSCredential>

Especifica uma conta de usuário que tem permissão para executar um fluxo de trabalho no computador de destino. O padrão é o usuário atual. Este parâmetro é válido somente quando o parâmetro PSComputerName é incluído no comando.

Digite um nome de usuário, como "Usuário01" ou "Domínio01\Usuário01", ou insira uma variável que contém um objeto PSCredential, por exemplo, um que o cmdlet Get-Credential retorna. Se você digitar apenas um nome de usuário, uma senha será solicitada.

PSELAPSEDTIMEOUTSEC <UInt32>

Determina quanto tempo o fluxo de trabalho e todos os recursos relacionados são mantidos no sistema. Quando o tempo limite expira, o fluxo de trabalho é excluído, mesmo se ainda estiver processando. Digite um valor entre 10 e 4.294.967.295. O valor padrão, 0 (zero), significa que não há tempo limite vencido.

PSPARAMETERCOLLECTION <Hashtable[]>

Especifica valores de parâmetros comuns do fluxo de trabalho diferentes para diferentes computadores de destino.

Digite uma lista separada por vírgulas das tabelas de hash com uma tabela de hash para cada computador de destino. Em cada tabela de hash, a primeira chave é PSComputerName e seu valor é o nome do computador de destino. Caracteres curinga são permitidos no nome do computador. Para obter as chaves restantes da tabela de hash, a chave é o nome do parâmetro e o valor é o valor do parâmetro.

Por exemplo:

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

PSPERSIST <Boolean>

Adiciona pontos de verificação ao fluxo de trabalho, além de quaisquer pontos de verificação especificados no fluxo de trabalho.

Esse parâmetro não pode suprimir os pontos de verificação do fluxo de trabalho, como aqueles especificados usando o parâmetro comum de atividade PSPersist, a atividade de fluxo de trabalho de ponto de verificação, nem a variável $PSPersistPreference.

"Ponto de verificação" ou "ponto de persistência" é um instantâneo do estado do fluxo de trabalho e de dados capturados durante a execução de fluxo de trabalho e é salvo em armazenamento de persistência em disco ou em um banco de dados SQL. Windows PowerShell O fluxo de trabalho usa os dados salvos para retomar um fluxo de trabalho suspenso ou interrompido a partir do último ponto de persistência, em vez de reiniciar o fluxo de trabalho.

Valores válidos:

(Padrão)

Se você omitir esse parâmetro, um ponto de verificação é adicionado no início e no final do fluxo de trabalho, além de quaisquer pontos de verificação especificados no fluxo de trabalho.

valor booliano como

Adiciona um ponto de verificação no início e no final do fluxo de trabalho e um ponto de verificação após cada atividade, além de quaisquer pontos de verificação especificados no fluxo de trabalho.

valor booliano como

Nenhum ponto de verificação é adicionado. Os pontos de verificação são executados somente quando especificados no fluxo de trabalho.

PSPORT <Int32>

Especifica a porta de rede nos computadores de destino. As portas padrão são 5985 (a porta de WinRM para HTTP) e 5986 (a porta de WinRM para HTTPS).

Não use o parâmetro PSPort a menos que seja absolutamente necessário. A porta definida no comando se aplica a todos os computadores ou sessões em que o comando é executado. Uma configuração de porta alternativa pode impedir que o comando seja executado em todos os computadores. Antes de usar uma porta alternativa, você deve configurar o ouvinte do WinRM no computador remoto para ouvir nessa porta.

PSPRIVATEMETADATA <Tabela de hash>

Fornece informações personalizadas para tarefas de fluxo de trabalho. Insira uma tabela de hash. As chaves e os valores são personalizados para cada fluxo de trabalho. Para obter informações sobre os metadados particulares de um fluxo de trabalho, consulte o tópico da Ajuda para o fluxo de trabalho.

Esse parâmetro não é processado pelo Windows PowerShell mecanismo de fluxo de trabalho. Em vez disso, o mecanismo passa a tabela de hash diretamente para o fluxo de trabalho.

PSRUNNINGTIMEOUTSEC <UInt32>

Especifica o tempo de execução do fluxo de trabalho em segundos, excluindo o tempo de suspensão do fluxo de trabalho. Se a execução do fluxo de trabalho não estiver concluída quando o tempo expirar, o Windows PowerShell mecanismo de fluxo de trabalho força a interrupção da execução do fluxo de trabalho.

PSSESSIONOPTION <PSSessionOption>

Define opções avançadas para as sessões nos computadores de destino. Insira um objeto PSSessionOption, por exemplo, um que você cria usando o cmdlet New-PSSessionOption.

Os valores padrão para as opções da sessão são determinados pelo valor da variável preferencial $PSSessionOption, se ela estiver definida. Caso contrário, a sessão usa os valores especificados na configuração da sessão.

Para obter uma descrição das opções de sessão, inclusive os valores padrão, consulte o tópico de ajuda do cmdlet New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=144305). Para obter informações sobre a variável preferencial $PSSessionOption, consulte about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

PSUSESSL <SwitchParameter>

Usa o protocolo SSL (Secure Sockets Layer) para estabelecer uma conexão com o computador de destino. Por padrão, SSL não é usado.

WS-Management criptografa todo o conteúdo do Windows PowerShell transmitido pela rede. UseSSL é uma proteção adicional que envia os dados por um HTTPS, em vez de HTTP. Se você usar esse parâmetro, mas o SSL não estiver disponível na porta usada para o comando, o comando falhará.

PALAVRAS-CHAVE

about_Workflow_Common_Parameters

about_Workflow_CommonParameters

CONSULTE TAMBÉM

about_ActivityCommonParameters

about_Workflows

Invoke-AsWorkflow

New-PSWorkflowExecutionOption

New-PSWorkflowSession