SSH

LAST UPDATED: MAY 5, 2025

Overview

The SSH integration enables organizations to generate a SSH connection and run SSH commands.

D3 SOAR is providing REST operations to function with SSH.

SSH is available for use in:

Connection

To connect to SSH from D3 SOAR, gather the following information:

Configuring SSH to Work with D3 SOAR

See https://www.ssh.com/academy/ssh/keygen for instructions on generating SSH key pairs.

Configuring D3 SOAR to Work with SSH

1. Log in to D3 SOAR.

2. Find the SSH integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type SSH in the search box to find the integration, then click it to select it.

   4. Click on the + Connection button on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to SSH.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add a description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, users have the option to choose the specific tenant sites to share the connection with. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the checkbox to ensure the connection is available for use.

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      Authentication Type: Basic - UserName/Password

      

      1. Input the SSH server.
      2. Select the Basic - UserName/Password authentication type.
      3. Input the username.
      4. Input the password.
      5. Input the SSH port. By default, the value is 22.
      Authentication Type: SSH Private Key

      

      1. Input the SSH server.
      2. Select the SSH Private Key authentication type.
      3. Input the username.
      4. Input the private key.
      5. Input the passphrase.
      6. Input the SSH port. By default, the value is 22.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.

       

   11. Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.

4. Test the connection.

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

SSH includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the SSH API, refer to the SSH API reference.

Execute SSH Command

Executes SSH commands on a remote SSH server.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Test Connection

Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.