name

String, Mandatory

Remote name, usually this is same as host name.

host

String, Mandatory

Hostname or IP address of the remote host.

port

int

Port. Defaults to port 22.

user

String, Mandatory

User name.

allowAnyHosts

boolean

If this is true, knownHosts is optional. Defaults to false.

knownHosts

String, Mandatory

Known hosts file for host key checking.

password

String, one of password, identity or identityFile is required

Password for password authentication.

identity

String, one of password, identity or identityFile is required

Private key for public-key authentication.

identityFile

String, one of password, identity or identityFile is required

Private key file name for public-key authentication.

passphrase

String

Pass-phrase for the private key.

agent

boolean

If this is true, Putty Agent or ssh-agent is used on authentication. Defaults to false.

timeoutSec

int

Connection timeout and socket read timeout. Defaults to 0 (OS default).

retryCount

int

Retry count to establish connection. Defaults to 0 (no retry).

retryWaitSec

int

Interval time between each retries. Defaults to 0 (immediately).

keepAliveSec

int

Interval time of keep alive messages sent to the remote host. Defaults to 60 seconds.

agentForwarding

boolean

If this is true, the agent forwarding is requested on the command execution. Defaults to false.

fileTransfer

String

File transfer method, that is SFTP or SCP. Defaults to SFTP.

encoding

String

Encoding of input and output on the command or shell execution. Defaults to UTF-8.

proxy

Proxy, refer below.

If this is set, the proxy server is used to reach the remote host. Defaults to no proxy.

gateway

Remote

Gateway remote host. If this is set, the port-forwarding tunnel is used to reach the remote host. Defaults to no gateway.

appendName

boolean

If this is true, name is prefixed to each line in the log output. New format: name|log.

logLevel

String

pty

boolean

If this is true, a PTY (pseudo-terminal) is allocated on the command execution. Defaults to false.