Run SSH Commands

SSHExec32x32

Description

Connects to a remote host with SSH, opens a noninteractive shell on the remote server, and runs a set of commands.

You can enter commands in multiple places:

In the Expression Editor for the action, one command per line.
In one of the command options.
In an external file, one command per line.

This remote SSH session does not load user environment or profile scripts. If you need to use them, you can execute source and its arguments as the first command of the session.

Parameters

Name	Mandatory	Default	Description
SSH Host	Yes		SSH hostname 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		A single command to execute on the remote server. Alternately, you can enter the command in the Expression Editor, or in a file for the SSH Command File parameter.
SSH Command File	No		A file containing a list of commands to execute on the remote server. Alternately, you can enter the command in the Expression Editor or the SSH Command parameter.
SSH Output File	No		File to store the command output.
SSH Output Property	No	SSH_RET_MESS	Name of a session variable to store the command output.
SSH Error Output Property	No	SSH_ERR_MESS	Name of a session variable to store 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		Maximum amount of time that the SSH session can remain idle or inactive before it is closed, in milliseconds.
SSH Trust Hosts	No	true	Accept all remote hosts. If set to false, you must provide a list of trusted hosts with the SSH Known Hosts File parameter.
SSH Known Hosts File	No		File containing the list of trusted remote 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		Hostname 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 hostname 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

A single command to execute on the remote server.

Alternately, you can enter the command in the Expression Editor, or in a file for the SSH Command File parameter.

SSH Command File

A file containing a list of commands to execute on the remote server.

Alternately, you can enter the command in the Expression Editor or the SSH Command parameter.

SSH Output File

File to store the command output.

SSH Output Property

SSH_RET_MESS

Name of a session variable to store the command output.

SSH Error Output Property

SSH_ERR_MESS

Name of a session variable to store 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

Maximum amount of time that the SSH session can remain idle or inactive before it is closed, in milliseconds.

SSH Trust Hosts

true

Accept all remote hosts. If set to false, you must provide a list of trusted hosts with the SSH Known Hosts File parameter.

SSH Known Hosts File

File containing the list of trusted remote 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

Hostname 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 command-line tool.