Etapa de SSH

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 6 min. de leitura

    • A etapa SSH executa comandos SSH em um sistema externo *nix por meio de um ServiceNow® MID Server. A etapa também armazena scripts e comandos para os sistemas *nix.

    Nota:

    Funções e disponibilidade

    A etapa SSH está disponível como uma etapa de ação Workflow Studio. Usuários com a função action_designer podem criar uma ação personalizada com uma ou mais etapas de ação.

    Limpeza de entradas

    Escape todas as entradas do usuário para eliminar a possibilidade de um usuário mal-intencionado executar comandos arbitrários no servidor de destino. Escape e valide as cápsulas de dados antes que o campo de comando as use, limpando argumentos usando funções de transformação Limpar argumentos de shell. Esta categoria de função de transformação aparece automaticamente quando uma cápsula de dados é solta na entrada Comando.

    Campos

    Campo Descrição
    Detalhes da Conexão
    Conexão Tipo de conexão a ser usada.
    • Definir conexão em linha: Defina as informações de conexão na etapa de ação.
    • Usar alias de conexão: Defina as informações de conexão usando a tabela de alias de conexão. Usar um alias elimina a necessidade de configurar várias credenciais e perfis de informações de conexão ao usar uma ação em vários ambientes. Da mesma forma, se as informações de conexão forem alteradas, você não precisará atualizar sua ação personalizada.

    Para saber mais sobre conexões e credenciais, consulte Introdução a credenciais, conexões e aliases.
    Alias de conexão Registro de alias de conexão e credencial que o sistema usa para executar a etapa de ação. Usuários com a função flow_designer ou admin podem criar ou selecionar um registro de conexão associado. Usar um alias elimina a necessidade de configurar várias credenciais e perfis de informações de conexão ao usar uma ação em vários ambientes. Da mesma forma, se as informações de conexão mudarem, você não precisará atualizar sua ação personalizada. Para saber mais sobre conexões e credenciais, consulte credenciais, conexões e aliases. O valor da credencial é exibido como uma cápsula de dados de senha (criptografada bidirecional) no painel de dados. Este campo está disponível quando Usar alias de conexão é selecionado na lista Conexão.
    Alias de credencial Alias de credencial que o sistema usa para executar a etapa de ação. Usuários com a função flow_designer ou admin podem criar ou selecionar um registro de conexão associado. O uso de um alias elimina a necessidade de configurar várias credenciais ao usar uma ação em vários ambientes. Da mesma forma, se as informações de credencial mudarem, você não precisará atualizar sua ação personalizada. Para saber mais sobre conexões e credenciais, consulte credenciais, conexões e aliases. O valor da credencial é exibido como uma cápsula de dados de senha (criptografada bidirecional) no painel de dados. Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexões.
    Nota:
    A etapa SSH requer um registro de credencial que ofereça suporte a credenciais de chave privada SSH ou credenciais SSH. Esta etapa não oferece suporte a credenciais do Windows em que a opção Usar conta de serviço do MID Server está selecionada.
    Host Nome do host ou do endereço IP do servidor de meta. Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexões.
    Porta Número da porta para se comunicar com o servidor. Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexões.
    Seleção de MID Opção para selecionar o MID Server ou Cluster do MID específico.
    • Seleção automática do MID Server: seleciona o MID Server automaticamente.
    • MID Server específico: usa o MID Server selecionado.
    • Cluster do MID específico: usa o Cluster do MID selecionado.
    Este campo fica disponível quando Definir conexão em linha é selecionado na lista Conexão.
    Aplicação de MID Opção para usar um MID Server para executar a etapa SSH. Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexão e Seleção automática de MID Server é selecionado na lista Seleção de MID.
    Capacidades Capacidade do MID Server. Selecione SSH. Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexão e Seleção automática de MID Server é selecionado na lista Seleção de MID.
    MID Server Cápsula de dados do MID Servernecessário. Este campo está disponível quando Definir conexão em linha é selecionado na lista de conexões e MID Server específico é selecionado na lista de seleção de MID.
    Cluster do MID Cápsula de dados para o cluster MID que você deseja usar. Este campo fica disponível quando Definir conexão em linha é selecionado na lista Conexão, Cluster MID específico estiver selecionado na lista Seleção de MID.
    Configuração do SSH
    Diretório de Trabalhos Diretório de destino opcional no host de destino em que o comando é executado.
    Comando Comando que é executado no diretório de destino. O comando também pode incluir scripts MID Server. Consulte Opções avançadas de script SSH para obter mais informações.
    Nota:
    Escape e valide as cápsulas de dados antes que o campo de comando as use, limpando os argumentos usando uma etapa de scriptde pré-processamento. Para obter mais informações, consulte Limpeza de argumentos usando a classe e a função de escape.
    Execução longa Opção para desabilitar o tempo limite da conexão SSH para comandos que podem levar mais tempo do que o tempo padrão de 120 segundos para serem executados. Quando selecionado, o mecanismo é desconectado do thread de execução até a conclusão.
    Modo Sudo Opção para elevar privilégios para executar o script.
    Para obter mais informações, consulte Credenciais SSH.

    Avaliação de erro de ação

    Se esta etapa falhar
    Tipo de dados: Choice

    Opção para continuar executando a próxima etapa ou ir para a avaliação de erro. Para usar o código de status da etapa ou a mensagem para uma condição de erro de ação personalizada, consulte Avaliação de erro de ação.

    Opções de script SSH avançadas

    Para executar um script MID Server no host de destino, especifique o tipo de script e passe o nome do script para o parâmetro ${syncFile()}. O sistema usa este parâmetro para localizar o script nomeado na tabela MID Server Arquivo de script [ecc_agent_script_file] e executá-lo no host de destino. Por exemplo, um script bash pode ser expresso como: 
    bash ${syncFile("<MID script name>")} argument1 argument2 argument3
    Um script de base (main_script.bash) pode fazer referência a outro script (my_include.bash), bem como a um arquivo separado (.my_profile) localizado no host de destino. Os scripts e o arquivo referenciado devem ser sincronizados com o MID Server, usando o parâmetro ${syncFile()}, para serem executados corretamente.
    source ${syncFile(".my_profile")}
cp ${syncFile("my_include.bash")} /usr/ssmith/my_include.bash
bash ${syncFile("main_script.bash")} one two three four five six 
rm /usr/ssmith/my_include.bash
    Um exemplo de Python com comentários em linha pode ser semelhante a este: 
    set $LIB_DIR=/usr/bin;. 
# Sync a file that is referenced inside myF5CreateLBPool.py 
cp ${syncFile("specialFunctions.py")} ~/specialFunctions.py 
# set up environment variables 
source ${syncFile(".python_profile")} 
# call script that sets up dependencies on the box from remote package repos 
python ${syncFile("setupPythonDependencies.py")} pycontrol 
# call a script that requires functions from the package as well as a function from myIncludedFile 
python ${syncFile("myF5CreateLBPool.py")} snow_pool myActualValue 
# user is responsible for their own cleanup 
rm ~/specialFunctions.py

    Para ver a lista de scripts MID Server disponíveis, navegue até MID Server > Arquivos de Script.