---
title: SSH Command
slug: aiops-documentacao-tecnica/ssh-command
docTags: 
createdAt: 2024-07-18T19:52:59.281Z
---

## Resumo

- Execute comandos em um Client SSH.

| **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*<br />(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          &#x20;*       | 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<br />(default)                | Tempo limite (em segundos) para aguardar uma resposta de autenticação.                |
| timeout                                     | integer                | - 60<br />(default)                | Tempo limite (em segundos) para aguardar a conexão TCP.                               |
| stderr\_lines                               | boolean                | Escolhas:<br />- false<br />- true | Mostra ou oculta o comando stderr.                                                    |
| stdout\_lines                               | boolean                | Escolhas:<br />- false<br />- 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

```yaml
# 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: 23
```

## Valores 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  |