SSH invocation mechanism
With an <invocation–mechanism> value of 'ssh', the <adapter–name> element is used to designate a SSH Actor Adapter that has been configured in Grid Manager. If an <adapter–name> value is not defined, the default value of 'SSHAdapter' will be used.
All the connection information required by the Adapter can be retrieved from the Adapter configuration. In the case of a SSH Adapter that contains multiple configuration nodes, the default node will be used.
To designate a configuration node other than the default node, define a static value for the <target> element. This value should correspond with the name attribute of the <config> element in the Adapter configuration.
To configure this activity to communicate with a host that is not defined in the Adapter configuration, a dynamic target can be designated by assigning values for the <hostname>, <port>, <username> and <password> elements. In addition to these required elements, an optional <password–encryption–type> can also be defined. The value of 'Base64' can be designated for the password–encryption–type element to indicate that the password provided is encrypted using Base64. These elements work as a set; partial information cannot be retrieved from the configuration.
The <command–encryption–type> element can be used to define the encryption method used for the command. The value of 'Base64' can be designated for <command–encryption–type> element to indicate that the command provided is encrypted using Base64. If a <command–encryption–type> value is not provided, the command is assumed to be non–encrypted.
The <timeout> element can be used to designate the length of time, in seconds, that the system should wait for the executed command to complete. If the executed command is not completed before the timeout period elapses, an error message will be returned in the Adapter response.
The <connection–name> and <terminate–connection> elements are used to establish and terminate persistent connectivity. With the definition of a <connection–name> value, the connection established in this activity can be reused in a subsequent activity. This <connection–name> should be used in any activity that is expected to re–use this connection. If a dynamic target is defined for this connection, that target will need to be defined in each activity that will re–use this connection. The only targets that can be referenced with the <target> element are those defined in the Adapter's configuration. To close the connection after a specific activity, the <terminate–connection> value should be set to 'true'. By default, this value is set to 'false'. The <terminate–connection> element is only used in the presence of a <connection–name> element.
The <known–hosts–config>, <allow–unknown–hosts> and <preferred–pk–algorithm> elements are used for key verification of the connection. The path to the known_hosts file on the target should be defined for the <known–hosts–config> value. If no value is defined, a default value of '<home dir>/.ssh/known_hosts' will be used. If hosts not present in the known_hosts file should be allowed to connect, a value of 'true' should be defined for the <allow–unknown–hosts> element. The default value for this element is 'false', which will cause the connection to be terminated for any host not present in the known_hosts file. The default pk algorithm used in key verification is ssh–rsa Alternately, the value of 'ssh–dss' can be defined for the <preferred–pk–algorithm> element.
The <prompt> and <working–dir> elements are not used with a defined <invocation–mechanism> value of 'ssh'.
| Element | Use with SSH invocation mechanism | Description |
|---|---|---|
| target | Optional | The name of the target defined in the Adapter configuration in Grid Manager. |
| hostname | Conditional | The hostname or IP address of the remote host. |
| port | Conditional Default value is '22'. | The port on which the remote server is listening. |
| username | Conditional | A valid username with which to log on to the remote server. |
| password | Conditional | The corresponding password for the username provided. |
| password–encryption–type |
Optional Default value is 'Plain' |
The type of encryption to use for the password provided.
Valid values: Base64, Plain (The password encryption type value is not case sensitive)
Note: If you use an encryption value of 'Base64', the password value provided is presumed to be Base64 encrypted. |
|
command–encryption–type |
Optional. |
The type of encryption to use for the command to be executed.
If you specify an encryption value of 'Base64', the command value provided is presumed to be Base64 encrypted.
Valid values: Base64, Plain. (The command encryption type value is not case sensitive) |
|
timeout |
Optional. Default value is '60' (in seconds). |
Time, in whole seconds, allotted to complete the execution of a command. |
|
connection–name |
Optional. |
The name to be referenced in subsequent requests to re–use this same connection. |
|
terminate–connection |
Optional. Default value is 'false'. |
Used in conjunction with the connection–name element.
The default value is 'false' which will keep the named connection open until the terminating activity of the workflow is reached, or until another request is made that includes a 'true' value for this element. Valid values: true, false |
|
known–hosts–config |
Optional. |
The path to the local known_hosts file. This file will be used when performing key verification. (Applicable only with an invocation–mechanism of 'ssh') |
|
allow–unknown–hosts |
Optional. Default value is 'false'. |
Indicates whether a connection should continue if key verification fails.
With a value of 'true', the connection will be maintained when connecting to an unknown or mismatched system. With a value of 'false' the connection will be dropped and the Adapter response will return an error. (Applicable only with an invocation–mechanism of 'ssh')
Valid values: true, false |
|
preferred–pk–algorithm |
Optional. Default value is 'ssh–rsa'. |
Preference of the algorithm used to encrypt the public key. (Applicable only with an invocation–mechanism of 'ssh')
Valid values: ssh–dss, ssh–rsa |
Related topics
Using the common object to provide the information required to create the adapter request
Comments
Log in or register to comment.