SSH Engine state is configured to connect to a client's machine or network and remotely execute commands or scripts on the client's Linux/UNIX operating system.

Prerequisite

• Bridge must be installed and should be active. To learn how to install and configure Bridge, click here.

• A Credential must be created for the SSH module by selecting the credential type SSH.
  

Builder View

For associating an SSH Engine state to a Circuit:

1. In Builder View, drag and drop the SSH Engine state from the left pane into your Circuit or click the required SSH Engine state of the Circuit.

2. In the Configuration, update the common state field attributes.
   

3. In Bridge ID, click and select the Bridge to be configured to the state from the drop-down list.
   

4. Under Add Configuration section, fill in the following fields:

• Credential ID - Click and select the Credential from the dropdown list. The Credential ID of all the credentials created for the SSH module type will be displayed in the list.

• Host - Enter the hostname of the machine in which the shell command has to be executed. Enter the hostname as localhost, if the shell command is executed on the same Bridge-installed machine.

• Command - Either input the shell command directly for execution or input a command that includes the name of the Script file to be executed. To create a new script file, go to Scripts.

5. Under Error Handling, you can optionally select and configure error handling options. Refer to Error Handling in Circuit states for further information.
   

6. In the Input/Output section, enter the required paths. To learn more about I/O paths, click here. 
   

      

Code view

"Linux OS Installation": {
      "type": "ssh_engine",
      "next": "Licence Key Activation-Linux",
      "bridge_id": "bridge-employee onboarding",
      "payload": {
            "credential_id": "ssh_cred_4",
            "host": "localhost",
            "command": "sudo apt-get update"
      }
}