Run SSH Commands

SSHExec32x32

Description

Runs a SSH script containing a list of commands on a remote host.
The script is entered in the code of the action.

Parameters

Name	Mandatory	Default	Description
SSH Host	Yes		SSH host name or IP address.
SSH Port	No	22	Connection port.
SSH User	Yes		SSH user.
SSH Password	No		This user’s encrypted password.
SSH Unencrypted Password	No		This user’s password in plain text.
SSH Command	No		Command to execute. The command can be alternately provided in the action’s code or in the SSH Command File.
SSH Command File	No		File containing the commands to execute. The command can be alternately provided in the action’s code or in the SSH Command parameter.
SSH Output File	No		File storing the output of the command.
SSH Output Property	No	SSH_RET_MESS	Name of the session variable storing the output of the command.
SSH Error Output Property	No	SSH_ERR_MESS	Name of the session variable storing the error output of the command.
SSH Append Output File	No	false	If set to true, appends the command output to the output file.
SSH Timeout	No		SSH connection timeout.
SSH Trust Hosts	No	true	Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.
SSH Known Hosts File	No		File containing the list of trusted hosts.
SSH Public Key File	No		Public keys used.
SSH Password Phrase	No		Encrypted Password Phrase.
SSH Unencrypted Password Phrase	No		Password Phrase in plain text.
SSH Additional Connection Properties	No		To define additional connection properties in the form of Java Properties. (key=value lines separated with line returns)
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

Name

Mandatory

Default

Description

SSH Host

Yes

SSH host name or IP address.

SSH Port

Connection port.

SSH User

Yes

SSH user.

SSH Password

This user’s encrypted password.

SSH Unencrypted Password

This user’s password in plain text.

SSH Command

Command to execute. The command can be alternately provided in the action’s code or in the SSH Command File.

SSH Command File

File containing the commands to execute. The command can be alternately provided in the action’s code or in the SSH Command parameter.

SSH Output File

File storing the output of the command.

SSH Output Property

SSH_RET_MESS

Name of the session variable storing the output of the command.

SSH Error Output Property

SSH_ERR_MESS

Name of the session variable storing the error output of the command.

SSH Append Output File

false

If set to true, appends the command output to the output file.

SSH Timeout

SSH connection timeout.

SSH Trust Hosts

true

Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.

SSH Known Hosts File

File containing the list of trusted hosts.

SSH Public Key File

Public keys used.

SSH Password Phrase

Encrypted Password Phrase.

SSH Unencrypted Password Phrase

Password Phrase in plain text.

SSH Additional Connection Properties

To define additional connection properties in the form of Java Properties. (key=value lines separated with line returns)

Proxy Host

Host name for the proxy server.

Proxy Port

1080

Port of the proxy server.

Proxy User

Proxy server user.

Proxy Password

Proxy server user password, encrypted.

Proxy Unencrypted Password

Proxy server user password in plain text.

Proxy Protocol

Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

Passwords are encrypted using the encrypt <password> command on the Runtime engine console (engine command line tool).