SSH

Edit online

The SSH block is a network protocol for secure data communication, command execution, and remote shell services. This block is also used to provide security services between two networked computers over a secure channel on an insecure network.

Procedure

  1. Drag and drop the SSH block onto your workflow.
  2. Provide the block values. The authKey and command values are mandatory.
    • In the authKey, enter the authentication key that you created to connect to the target server. The authKey serves as the foundation for a generic application programming interface (API) authentication scheme, with the flexibility to extend it.
    • In the command field, enter the command that you want to execute on the target server.
    • Optional: Click Show more variables to access the following variables:
      Table 1. SSH block input variables
      Variable name More information
      connectionPool If you want the block to cache and reuse established connections, set this value to true. The default value is false.
      host The hostname.
      port The port name.
      username Your username.
      password Your password.
      privateKey The openSSH key.
      timeout The response timeout in seconds. This command exits with an error if no response is received within the specified timeout period. Any received data resets the timer.
  3. Optional: Run the workflow and check the relevant response at the bottom of the editor.

Disabling the SSH block

To disable the SSH block without deleting it, turn off the switch in the block header.