SSH Command
Resumo
- Execute comandos em um Client SSH.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
username | string | | Usuário padrão para fazer o login/autenticação. |
password | string | | Senha padrão usada para fazer login no servidor ssh. |
hosts - required (Possíveis valores) | list / elements=dict | | Lista de nomes de host e/ou IPs. Pode conter um nome de usuário e uma chave de senha. |
port | int | - 22 (default) | Porta SSH. |
commands - required | list / elements=string | | Lista de comandos. |
private_key_file | string | | Caminho para um arquivo de chave privada. |
private_key_string | string | | Chave privada em formato de string. |
auth_timeout | integer | - 10 (default) | Tempo limite (em segundos) para aguardar uma resposta de autenticação. |
timeout | integer | - 60 (default) | Tempo limite (em segundos) para aguardar a conexão TCP. |
stderr_lines | boolean | Escolhas: - false - true | Mostra ou oculta o comando stderr. |
stdout_lines | boolean | Escolhas: - false - true | Mostra ou esconde o comando stdout. |
Subcampos da opção hosts
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
address | string | | Um endereço e/ou IP. |
username | string | | Usuário para fazer o login/autenticação. |
password | string | | Senha usada para fazer login no servidor ssh. |
private_key_file | string | | Caminho para um arquivo de chave privada. |
private_key_string | string | | Chave privada em formato de string. |
Exemplos
# Exemplo: Execute o comando via SSH e retorne a saída padrão e o erro.
- ssh_command:
username: "root"
password: "root"
hosts: [{"address": "localhost"}]
commands: ["echo $USER"]
stderr_lines: true
stdout_lines: true
# Exemplo: Execute o comando via SSH em uma porta custom.
- ssh_command:
username: "root"
password: "root"
hosts: [{"address": "localhost"}]
commands: ["echo $USER"]
stderr_lines: true
stdout_lines: true
port: 23Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
failed | boolean | sempre | status da execução |
reason | string | sempre | timeout |
address | string | sempre | O endereço ou IP. |
commands | list / elements=string | sempre | Lista de comandos |