Elements for the ConnectionDetails common object
This topic describes the available elements in the Using the common object to provide the information required to create the adapter request.
The following table describes the elements:
| Element | Description |
|---|---|
<adapter-name> | Specifies the name of the adapter as configured on the Grid Manager |
<invocation-mechanism> | Specifies the type of the adapter to be used to execute the workflow
Valid values: command–line, ssh, telnet or windows–command |
<target> | Specifies the name of the target as defined in the adapter configuration on the Grid Manager |
<host-name> | Specifies the host name or IP address of the remote host |
<port> | Specifies the port on which the remote server is listening |
<user-name> | Specifies the user name to log on to the remote server |
<password> | Specifies the password that matches the user name |
<password-encryption-type> | Indicates whether the password specified is encrypted; is an attribute of the The password encryption type value is not case sensitive. Valid values: Base64, Plain (default) |
<prompt> | Specifies the console prompt displayed when the system is waiting for a command. Applicable only with an invocation–mechanism of 'telnet'. |
<working-dir> | Specifies the directory in which to execute a command. Applicable only with an invocation–mechanism of 'command–line' |
<command-dir> | Specifies the directory in which to search for a script to execute. Applicable only with an invocation–mechanism of 'command–line' |
<command-encryption-type> | Specifies 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> | Specifies the time, in whole seconds, allotted to complete the execution of a command Default value: 60 |
<connection-name> | Specifies the name to be referenced in subsequent requests to reuse this same connection |
<terminate-connection> | Used in conjunction with the The default value is 'false' which keeps 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> | Valid value: known_hosts |
<allow-unknown-hosts> | Indicates whether a connection should continue if the 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> | Specifies the reference of the algorithm used to encrypt the public key. Applicable only with an invocation–mechanism of 'ssh' Valid values: |
The following figure shows a sample ConnectionDetails concept for the AutoPilot OA Common Utilities.
ConnectionDetails concept for the AutoPilot OA Common Utilities
<ConnectionDetails xmlns="AutoPilot-OA-Common_Utilities">
<adapter-name xmlns=""></adapter-name>
<invocation-mechanism xmlns=""></invocation-mechanism>
<hostname xmlns="" />
<port xmlns="" />
<username xmlns="" />
<password xmlns="" />
<password-encryption-type xmlns="" />
<target xmlns="" />
<prompt xmlns="" />
<login-prompt xmlns="" />
<password-prompt xmlns="" />
<working-dir xmlns=""></working-dir>
<command-dir xmlns=""></command-dir>
<command-encryption-type xmlns=""></command-encryption-type>
<timeout xmlns=""></timeout>
<connection-name xmlns="" />
<terminate-connection xmlns="" />
<known-hosts-config xmlns="" />
<allow-unknown-hosts xmlns="" />
<preferred-pk-algorithm xmlns="" />
</ConnectionDetails>The following table provides an overview of the dependencies of the other connection details elements on the <invocation–mechanism> value.
| Element | Command Line | SSH | Telnet | Windows Command |
|---|---|---|---|---|
<target> | NA | Optional | Optional | Optional |
<host-name> | NA | Conditional | Conditional | Conditional |
<port> | NA | Conditional; default value is 22 | Conditional; default value is 23 | NA |
<user-name> | NA | Conditional | Conditional | Conditional |
<password> | NA | Conditional | Conditional | Conditional |
<password-encryption-type> | NA | Conditional; default value is Plain | Conditional; default value is Plain | NA |
<prompt> | NA | NA | Conditional | NA |
<working-dir> | Optional | NA | NA | NA |
<command-dir> | Optional | NA | NA | NA |
<command-encryption-type> | Optional | Optional | Optional | NA |
<timeout> | Optional; default value is 60 (in seconds) | Optional; default value is 60 (in seconds) | Optional; default value is 60 (in seconds) | Optional; default value is 60 (in seconds) |
<connection-name> | NA | Optional | Optional | NA |
<terminate-connection> | NA | Optional; default value is false | Optional; default value is false | NA |
<known-hosts-config> | NA | Optional | NA | NA |
<allow-unknown-hosts> | NA | Optional; default value is false | NA | NA |
<preferred-pk-algorithm> | NA | Optional; default value is ssh-rsa | NA | NA |
For details on assigning element values for <invocation–mechanism> for each of the adapters, see the following topics:
Comments
Log in or register to comment.