SSH Connector | X4Documentation

This adapter connects to SSH servers using the Secure Shell protocol.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

Execute: Executes the input command on the server

Parameters

`host`	Server host Possible values: Any valid host or IP, e. g. `localhost` or any other IP direction
`user`	User to log in to the server Possible values: String containing the user name, e. g. `userName`
`password`	Password to log in to the server Possible values: String containing the password, e. g. `myPassword`
`port`	Server port Possible values: `22` (default) any other Integer with the port
`timeout`	Timeout in milliseconds for waiting until the connection to the server is established Possible values: 30000 ms (default) any other Integer with the time in milliseconds

Status values

`0`	The operation was executed successfully.
Distinct to `0`	An error occurred during the operation's execution

Input

The adapter expects a specific XML document as input:

Sample input

XML

<?xml version="1.0" encoding="UTF-8"
<Root>
    <Command>netstat -plnt |grep 8080</Command>
</Root>

The <Command> element contains the command to be executed on the server.

Output

The adapter returns an XML document with the output and the status.

Output corresponding to the sample input

XML

<?xml version="1.0" encoding="UTF-8"
<Output>
    <CommandOutput>tcp 0 0 0.0.0.0:8080 0.0.0.0:* LISTEN - </CommandOutput>
	<ExitStatus>0</ExitStatus>
</Output>