Create an SSH activity

Create an activity that extracts data from a target host that uses the SSH network protocol.

Before you begin

Role required: activity_creator or workflow_admin

About this task

For instructions on using the activity template process flow, see create custom activities.


  1. Create a custom activity.
    This action creates a custom activity using a template.
  2. After setting up general properties and creating input variables, configure the SSH Execution Command:
    Map the input variables Use the variables you created to configure the command that Orchestration executes.
    Target host Host name or IP address of the target server for this activity.
    Command Command this activity runs on the target host. You can invoke a MID Server script from this field using any script type that the SSH command line supports. For more information, see Advanced SSH script options below the table.
    Directory Directory on the target host where the command is run.
    Credential tag The Orchestration credential tag to use when running the command.
    Required MID Server capabilities MID Server with the appropriate capabilities for connecting to the host. By default, the system selects a MID Server with SSH capabilities.
    Long running If checked, disables the SSH connection timeout for commands that might take longer to run than the default 60 seconds. Orchestration periodically checks the running process to determine its status until it is finished.
    Must Sudo If checked, enables the use of sudo to run commands.
    Note: You can map parameter values in a test payload to variables in the Outputs tab automatically. See automap output variables.

What to do next