Criação de uma atividade PowerShell

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • Crie uma atividade PowerShell personalizada para retornar dados a um fluxo de trabalho a partir de um host usando o Microsoft PowerShell.

    Antes de Iniciar

    Funções necessárias: activity_creator ou workflow_admin

    Por Que e Quando Desempenhar Esta Tarefa

    ServiceNow é compatível com o PowerShell 3.0 ao 5.1.

    Procedimento

    1. Crie uma atividade personalizada.
      Esta ação cria uma atividade personalizada usando um modelo.
    2. Depois de configurar as propriedades gerais e criar variáveis de entrada, configure o Comando de Execução PowerShell.
      OpçãoDescrição
      Mapear as variáveis de entrada Use as variáveis que você criou para configurar o comando que a Orquestração executa no MID Server.
      Host de destino Nome do host ou endereço IP do servidor de destino para esta atividade do PowerShell.
      Tipo de script Tipo de script do PowerShell a ser executado no host do PowerShell. Opções disponíveis incluem:
      • Comando PowerShell personalizado
      • Arquivo de script do MID Server
      Arquivo de script do MID Server O arquivo de script do MID Server contém os scripts do PowerShell. Este campo está disponível quando o tipo de script selecionado é o arquivo de script do MID Server.
      Comando Comando do PowerShell que a atividade executa. Este campo está disponível quando o tipo de script selecionado é o comando PowerShell personalizado. Você pode criar seus comandos arrastando e soltando variáveis de entrada do construtor de variáveis para este campo.
      Variáveis do PowerShell Pares de nome-valor a serem passados para o host com o PowerShell. Você pode criar essas variáveis manualmente ou arrastar variáveis de entrada para o campo Valor. As variáveis de entrada criptografadas mantêm sua criptografia, independentemente das configurações de tipo de dados neste campo. Se você digitar um valor e selecionar o tipo de dado Criptografado, o valor aparecerá em texto sem formatação. Ele só é criptografado quando passa para a Fila do ECC.
      Usar conta de serviço do MID Se marcada, esta atividade autentica no host de destino usando somente as credenciais da conta de serviço do MID Server, sem tentar nenhuma outra credencial.
      Nota:
      O campo de marcador de credencial não está disponível.
      Marcador de credencial Marcador de credencial que esta atividade deve usar para executar comandos do PowerShell no host. Se este campo for deixado em branco, o MID Server tentará todas as credenciais disponíveis até encontrar uma credencial válida, terminando com a conta de serviço do MID Server. Se um marcador de credencial for definido, o MID Server tentará as credenciais somente para esse marcador e não tentará a conta de serviço do MID Server.
      Nota:
      Este campo não está disponível quando a caixa de seleção Usar conta de serviço do MID está marcada.
      Requer recursos do MID Server MID Server a ser usado pelos recursos para consultar o PowerShell. Por padrão, o sistema seleciona um PowerShell MID Server.
      Nota:
      Você pode mapear valores de parâmetro em uma carga de teste para variáveis na guia Saídas automaticamente. Consulte variáveis de saída do mapeamento automático.

    O que Fazer Depois

    Conclua a criação da sua atividade PowerShell criando variáveis de saída, criando uma regra de análise ou Condições. Consulte o tópico criar atividades personalizadas para conhecer as opções de modelo.

    Parâmetros de execução do modelo PowerShell

    Você usa parâmetros de execução para criar o script do processo de entrada no formulário de pré-processamento do designer de atividades.

    Para obter descrições dos campos de comando do PowerShell, consulte a tabela em Configuração do comando de execução do PowerShell.
    Nota:
    É necessário usar o prefixo executionParam. com todas as variáveis nesta tabela.
    Tabela 1. Parâmetros de execução do PowerShell
    Nome Variável Tipo Uso
    Origem origem Cadeia de caracteres Host de destino no qual o comando será executado.
    Tipo de script script_type Enumeração Tipo de script a ser executado. Os tipos possíveis são:
    • command: comando PowerShell personalizado.
    • file: identifica o arquivo de script do MID Server a ser executado.
    Comando comando Cadeia de caracteres Comando enviado ao MID Server para ser executado no host de destino.
    MidScriptFile midScriptFile Referência Sys_id de referência do arquivo de script do MID Server a ser executado, quando o script_type for file.
    PowershellVariables powershellVariables Matriz de hashmap Hashmap de objetos JavaScript com nome, valore tipo de cada objeto. O tipo de cada objeto pode ser simples, criptografado, boolianoou nulo, correspondendo ao tipo de variável do PowerShell selecionada na guia de entradas. Por exemplo, você pode inserir:
    var newParameter = {"name":"parameterName","value":"parameterValue", "type": "plain" };
    executionParam.powershellVariables.push(newParameter);
    Marcador de credencial credential_tag Cadeia de caracteres Marcador de credencial específico que esta atividade deve usar para executar comandos do PowerShell no host.
    MidCapabilities midCapabilities Cadeia de caracteres (separados por vírgulas) Lista de recursos MID Server exigidos.
    ValueCapabilities valueCapabilities Matriz de hashmap Valores de recursos usados para selecionar o MID Server. Para obter mais informações, consulte Recursos do MID Server. Se houver recursos adicionais atribuídos por valor, use este exemplo para personalizar a seleção do MID Server:
    var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'};
    executionParam.valueCapabilities.push(valueCapability);

    Análise de carga e parâmetros de pós-processamento do PowerShell

    Use esses parâmetros para criar um script de pós-processamento, análide se carga e marcação.

    Tabela 2. Parâmetros de pós-processamento do PowerShell
    Nome Variável Tipo Uso
    Marcadores marcadores Hashmap de valores de marcador a serem retornados do comando do PowerShell. Contém os marcadores usados para extrair a saída usando os comandos do PowerShell. A saída do marcador é delimitada por sinais de porcentagem dupla, como em %%tagname%%...%%. Configure o comando usando o formato neste exemplo:
    Write-Host %%tagname1%%
    output1 line 1
    output1 line 2
    …
    Write-Host%%
    
    Write-Host %%tagname2%%
    output2 line 1
    output2 line 2
    …
    Write-Host%%

    Os marcadores retornados são objetos de hashmap JavaScript em que cada chave é prefixada com tag anexada ao tagname.

    {"__text__": "", 
    "tagtagname1":"output1 line1\noutput1 line2\n", 
    "tagtagname2":"output2 line1\noutput2 line2\n"}
    Hresult hresult Cadeia de caracteres Contém qualquer hresult retornado do comando do PowerShell. Se nenhum hresult for retornado, este parâmetro será nulo.
    Saída saída Cadeia de caracteres Contém a saída bruta do comando do PowerShell.
    EccSysID eccSysID Cadeia de caracteres Contém o ID de referência associado à mensagem de entrada da Fila do ECC retornada pela atividade.
    ErrorMessages errorMessages Cadeia de caracteres Contém qualquer mensagem de erro retornada do comando do PowerShell. Este valor será nulo se não houver mensagens de erro.