Compartilhar via


SSH@0 – Tarefa SSH v0

Use essa tarefa para executar comandos de shell ou um script em um computador remoto usando SSH. Essa tarefa permite que você se conecte a um computador remoto usando SSH e execute comandos ou um script.

Sintaxe

# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #interactiveKeyboardAuthentication: false # boolean. Use interactive-keyboard authentication. Default: false.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.

Entradas

sshEndpoint - de conexão de serviço SSH
string. Obrigatório

Especifica o nome de uma conexão de serviço SSH que contém detalhes de conexão para o computador remoto. O nome do host ou endereço IP do computador remoto, o número da porta e o nome de usuário são necessários para criar uma conexão de serviço SSH.

  • A chave privada e a frase secreta devem ser especificadas para autenticação.
  • Uma senha pode ser usada para autenticar em computadores Linux remotos, mas isso não tem suporte para sistemas macOS ou Windows.

runOptions - executar
string. Obrigatório Valores permitidos: commands, script (Arquivo de Script), inline (Script Embutido). Valor padrão: commands.

Executa comandos de shell ou um script de shell no computador remoto.


comandos commands -
string. Necessário quando runOptions = commands.

Especifica os comandos do shell a serem executados no computador remoto. Esse parâmetro só está disponível quando Commands é selecionado para a opção Executar. Insira cada comando junto com seus argumentos em uma nova linha da caixa de texto de várias linhas. Para executar vários comandos juntos, insira-os na mesma linha separada por ponto-e-vírgula. Exemplo: cd /home/user/myFolder;build.

Observação

Cada comando é executado em um processo separado. Se você quiser executar uma série de comandos interdependentes (por exemplo, alterando a pasta atual antes de executar um comando), use a opção Script Embutido em vez disso.


scriptPath - caminho de script do Shell
string. Necessário quando runOptions = script.

Especifica o caminho para o arquivo de script do shell a ser executado no computador remoto. Esse parâmetro só está disponível quando script shell é selecionado para a opção Executar.


inline - script embutido
string. Necessário quando runOptions = inline.

Grava o script de shell a ser executado no computador remoto.


de comando do Interpretador de interpreterCommand -
string. Opcional. Use quando runOptions = inline. Valor padrão: /bin/bash.

Especifica o caminho para o interpretador de comando usado para executar o script. Adiciona uma linha shebang ao início do script. Relevante apenas para sistemas operacionais semelhantes a UNIX. Use uma cadeia de caracteres vazia para hosts remotos baseados no Windows. Saiba mais sobre shebang (#!).


argumentos args -
string. Opcional. Use quando runOptions = script.

Especifica os argumentos a serem passados para o script de shell. Esse parâmetro só está disponível quando script shell é selecionado para a opção Executar.


failOnStdErr - falha no STDERR
boolean. Valor padrão: true.

Se o valor for true, o build falhará quando os comandos remotos ou a gravação de script STDERR.


interactiveSession - Habilitar de sessão interativa
boolean. Valor padrão: false.

Inicia uma sessão interativa. As solicitações de senha são preenchidas pela senha do usuário. Sessões interativas podem ser úteis para executar comandos, como sudo.


readyTimeout - tempo limite do handshake SSH
string. Obrigatório Valor padrão: 20000.

Especifica por quanto tempo (em milissegundos) a tarefa aguarda a conclusão do handshake SSH.


interactiveKeyboardAuthentication - usar de autenticação de teclado interativo
boolean. Valor padrão: false.

Habilita a autenticação de teclado interativo. Defina como true se o servidor SSH de destino exigir Autenticação Interativa de Teclado (PasswordAuthentication estiver desabilitado no computador de destino/definido como Não em sshd_config).


Opções de controle de tarefa

Todas as tarefas têm opções de controle além das suas entradas de tarefas. Para obter mais informações, consulte as opções de Controle de e as propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Observações

Use essa tarefa para executar comandos de shell ou um script em um computador remoto usando SSH. Essa tarefa permite que você se conecte a um computador remoto usando SSH e execute comandos ou um script.

Pré-requisitos

  • A tarefa dá suporte ao uso de um par de chaves SSH para se conectar aos computadores remotos.
  • A chave pública deve ser pré-instalada ou copiada para as máquinas remotas.

Algoritmos com suporte

Algoritmos de par de chaves

  • RSA
  • DSA

Algoritmos de criptografia

  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • blowfish-cbc
  • 3des-cbc
  • arcfour256
  • arcfour128
  • cast128-cbc
  • arcfour

Para OpenSSL v1.0.1 e superior (no agente):

  • aes256-ctr
  • aes192-ctr
  • aes128-ctr

Para OpenSSL v1.0.1 e superior, NodeJS v0.11.12 e superior (no agente):

  • aes128-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm
  • aes256-gcm@openssh.com

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Execuções em Agent, DeploymentGroup
de demandas Nenhum
recursos Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando Qualquer
variáveis settable Qualquer
Versão do agente 2.206.1 ou superior
Categoria de tarefa Implantar
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Execuções em Agent, DeploymentGroup
de demandas Nenhum
recursos Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando Qualquer
variáveis settable Qualquer
Versão do agente 2.144.0 ou superior
Categoria de tarefa Implantar
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Execuções em Agent, DeploymentGroup
de demandas Nenhum
recursos Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando Qualquer
variáveis settable Qualquer
Versão do agente 2.102.0 ou superior
Categoria de tarefa Implantar

Consulte também