SSH Engine state in Circuit | Qntrl | Circuit | Online Help | Execute commands in a remote Linux or Unix machine

SSH Engine

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

For more details about the SSH module in Bridge, the keys, and its description, click here.


Example Use Case: In the employee onboarding scenario, when it comes to the employee asset allocation process, the system administrator is responsible for installing the operating system on the assigned employee systems. To facilitate this, the SSH Engine state can be utilized specifically for LINUX machines. It enables the connection to the employee's machine and the execution of remote commands for OS installation.

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 the Add Configuration section, fill in the following fields:

    1. Credential ID - 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.

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

    3. 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, refer to Scripts.

  1. In Input / Output, enter the required paths. Learn more about I/O paths.

      


Code view

 In Code View, the JSON to execute a shell command and perform an SSH task in Circuit is given below:
"Linux OS Installation": {
      "type": "ssh_engine",
      "next": "Licence Key Activation-Linux",
      "bridge_id": "bridge-1368_1",
      "payload": {
            "credential_id": "ssh_cred_4",
            "host": "localhost",
            "command": "display.sh"
      }
}





    • Related Articles

    • SSH Engine

      SSH Engine module in Bridge is used to perform actions in the client network/client's machine by executing a command/script in Linux/UNIX OS. Prerequisite While creating credentials for SSH Engine, choose the Credential type as SSH. Click here to ...

    • DB Engine

      This state enables a connection with the database hosted on a private or local network and executes the defined SQL query in the database. Prerequisite An active Bridge agent. Refer here to install and configure Bridge. Create the necessary ...

    • PowerShell Task Engine

      These states are used to perform any actions in the Windows machines of a private network using PowerShell commands. There are six states available in the PowerShell Task Engine for performing different operations. PowerShell Engine Install ...

    • Task Engine

      Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...

    • Task Engine

      In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in Bridge ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.