Document toolboxDocument toolbox

SSH

Owned by Jonas Gonzalez
Last updated: Nov 29, 2024
2 min read
[ 1 Connect SSH with Devo SOAR ] [ 2 Actions for SSH ] [ 2.1 Execute Command ] [ 2.1.1 Input Field ] [ 2.1.2 Output ] [ 3 Release Notes ]

SSH lets you run a command on a remote host

Connect SSH with Devo SOAR

  1. Navigate to Automations > Integrations.

  2. Search for SSH.

  3. Click Details, then the + icon. Enter the required information in the following fields.

  4. Label: Enter a connection name.

  5. Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.

  6. Verify SSL: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).

  7. Remote Agent: Run this integration using the Devo SOAR Remote Agent.

  8. SSH Server: The server that you would like to connect to. Hostname or IP is fine.

  9. SSH User Name: Client Token for accessing Akamai API.

  10. SSH Host Key (Optional): The public ssh-rsa key of the server (Default is Empty value).

  11. SSH Password (Optional): Your SSH password is required, only if you don't provide an SSH private key and SSH private key file.

  12. SSH Private Key (Optional): Your SSH private key, only if you don't provide an SSH password and SSH private key file (Default is Empty value). The key needs to be base 64 encoded.

    • Command-line example: "cat | base64". Paste the output into the SSH Private Key box.

  13. SSH Private Key file (Optional): Your SSH Private key file. Only if you don't provide an SSH password and SSH private key (Default is Empty value).

  14. After you've entered all the details, click Connect.

Actions for SSH

Execute Command

Executes a remote command and retrieves its result.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Input Name

Description

Required

Command

Enter jinja-templated command to execute.

 

For example: ls {{dir_name_column}}.

Required

 

SSH Server

Jinja-templated text containing the server that you would like to connect to. Hostname or IP is fine.

 

Example: {{ssh_server}}

Required

 

Output

A JSON object containing multiple rows of result:

  • has_error: True/False

  • error: message/null

  • stdout: messages emitted in stdout after running the ssh command

  • stderr: error messages emitted in stderr after running the ssh command
    Additionally, stdout of SSH command is also forwarded in stdout column

Release Notes

  • v4.0.0 - Updated architecture to support IO via filesystem