Open Session
If you try to run two policies containing SSH objects at the same time, then unexpected errors can occur. For example, the first policy can send commands in the SSH session created by the second policy. These errors occur because a class which handles the SSH connection is static.
Open/Connect SSH session to a device. This object is a prerequisite for all other SSH objects.
If this Object is used in an Automation Manager Policy that attempts to connect to a target device that is configured to use only SSH-2, the Policy may fail as the connection can be refused due to an invalid server version string error. This error will not occur for target devices that are configured to use only SSH-1 or to use either SSH-1 or SSH-2.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
Server Name or IP |
String |
Yes |
FQDN or IP of the device to which the SSH session will connect. |
|
User Name |
String |
Yes |
Username used to authenticate with the device. |
|
Password |
String |
Yes |
Password used to authenticate with the device. |
Output Parameters
| Name | Type | Description |
|---|---|---|
|
IO |
String |
Name of the IO Connection DLL of the SSH connection to the remote device. |
|
ExpectPattern |
String |
Set ExpectPattern of the SSH session to the remote device (usually blank). |
|
Cipher |
String |
Encryption type used in the SSH connection to the remote device. |
|
Mac |
String |
Message type for the encryption (usually hmac-md5). |
|
ServerVersion |
String |
Version of SSH used by the connecting device. |
|
ClientVersion |
String |
Version of SSH for the remote device to which the connection is made. |
|
Host |
String |
Host name or IP of the device to which the connection is made. |
|
HostKey |
String |
Key Name used in connection to the remote device. |
|
Port |
Number |
Port number used in the SSH connection. |
|
Password |
String |
Password used to authenticate the remote session. |
|
UserName |
String |
User Name used to authenticate the remote session. |
|
SSHOutput |
String |
The Output produced from connecting to the remote device. |
|
Result |
Number |
Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
|
Server Name or IP |
String |
Yes |
192.168.1.1 |
|
User Name |
String |
Yes |
admin |
|
Password |
String |
Yes |
<link to start parameter> |