SSH Engine module in Bridge | Qntrl | Bridge | Online Help

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 learn how to create a credential.

 

Request data

{
	"task_name": "ssh_task",
	"credential": {
		"name": "<CREDENTIAL_NAME>"
	},
	"task_details": {
		"host": "<HOST_NAME>",
		"command": "<COMMAND>"
		"args": {
			"<ARG_NAME1>": "<ARG_VALUE1>",
			"<ARG_NAME2>": "<ARG_VALUE2>"
		}
	}
}


Where,
  Keys
  Description
  task_name
  A system-defined name for the respective module. 'ssh_task' is the task name for SSH Engine.
  credential
  A JSON object that contains the details of the machine to be connected.
  name
  Name of the machine credential.
  task_details
  A JSON that contains details of the task.
  host
 Host name of the machine in which the SSH command has to be executed.
  command
  Command for the specific action.
  args
 (optional)
   For transmission of dynamic values during script execution.




    • Related Articles

    • 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 Bridge must be installed and should be active. Learn how to install and ...

    • 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.