Partilhar via


SSH@0 - Tarefa SSH v0

Use esta tarefa para executar comandos shell ou um script em uma máquina remota usando SSH. Esta tarefa permite que você se conecte a uma máquina remota 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.

Insumos

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

Especifica o nome de uma conexão de serviço SSH contendo detalhes de conexão para a máquina remota. O nome do host ou endereço IP da máquina remota, 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 máquinas Linux remotas, mas isso não é suportado para sistemas macOS ou Windows.

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

Executa comandos shell ou um shell script na máquina remota.


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

Especifica os comandos do shell a serem executados na máquina remota. Esse parâmetro está disponível somente quando Comandos é selecionado para a opção Executar. Insira cada comando juntamente 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 separados 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 que são interdependentes (por exemplo, alterar a pasta atual antes de executar um comando), use a opção Inline Script em vez disso.


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

Especifica o caminho para o arquivo de shell script a ser executado na máquina remota. Esse parâmetro está disponível somente quando de script do Shell é selecionada para a opção Executar.


inline - Script Inline
string. Necessário quando runOptions = inline.

Grava o shell script para ser executado na máquina remota.


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

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


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

Especifica os argumentos a serem passados para o shell script. Esse parâmetro está disponível somente quando de script do Shell é selecionada para a opção Executar.


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

Se o valor for true, a compilação falhará quando os comandos remotos ou o script gravarem em STDERR.


interactiveSession - Ativar 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 de aperto de mão SSH
string. Obrigatório. Valor padrão: 20000.

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


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

Permite a autenticação de teclado interativo. Defina como true se o servidor SSH de destino exigir Autenticação de Teclado Interativa (PasswordAuthentication estiver desabilitado na máquina de destino/definido como Não na sshd_config).


Opções de controlo de tarefas

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

Variáveis de saída

Nenhum.

Observações

Use esta tarefa para executar comandos shell ou um script em uma máquina remota usando SSH. Esta tarefa permite que você se conecte a uma máquina remota usando SSH e execute comandos ou um script.

Pré-requisitos

  • A tarefa suporta o uso de um par de chaves SSH para se conectar à(s) máquina(s) remota(s).
  • A chave pública deve ser pré-instalada ou copiada para a(s) máquina(s) remota(s).

Algoritmos suportados

Algoritmos de par de chaves

  • RSA
  • DSA

Algoritmos de encriptação

  • AES256-CBC
  • AES192-CBC
  • AES128-CBC
  • Blowfish-CBC
  • 3DES-CBC
  • Arcfour256
  • arco128
  • cast128-CBC
  • arco quatro

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

Requerimentos

Requisito Descrição
Tipos de pipeline YAML, Construção clássica, Versão clássica
Funciona em Agente, DeploymentGroup
Exigências Nenhum
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 2.206.1 ou superior
Categoria de tarefa Desplegar
Requisito Descrição
Tipos de pipeline YAML, Construção clássica, Versão clássica
Funciona em Agente, DeploymentGroup
Exigências Nenhum
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 2.144.0 ou superior
Categoria de tarefa Desplegar

Ver também