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.