Elements for the ConnectionDetails common object

This table describes the available elements in the Using the common object to provide the information required to create the adapter request.

Element Description
adapter–name The name of the Adapter to be used for the workflow, as configured in Grid Manager
invocation–mechanism

The type of Adapter to be used to execute the workflow.

 

Valid values: command–line, ssh, telnet, windows–command

hostname The hostname or IP address of the remote host.
port The port on which the remote server is listening.
username A valid username with which to log on to the remote server.
password The corresponding password for the username provided.
password–encryption–type

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.

target The name of the target defined in the Adapter configuration in Grid Manager.
prompt The console prompt displayed when the system is waiting for a command. (Applicable only with an invocation–mechanism of 'telnet')
working–dir Directory in which to execute a command. (Applicable only with an invocation–mechanism of 'command–line')
command–dir Directory in which to search for a script to execute. (Applicable only with an invocation–mechanism of 'command–line')
command–encryption–type

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 Time, in whole seconds, allotted to complete the execution of a command.
connection–name The name to be referenced in subsequent requests to re–use this same connection.
terminate–connection

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 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

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

Preference of the algorithm used to encrypt the public key. (Applicable only with an invocation–mechanism of 'ssh')

 

Valid values: ssh–dss, ssh–rsa

The <invocation–mechanism> is the only element for which a value must be assigned. Valid values for the <invocation–mechanism> are: command–line, ssh, telnet or windows–command. 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 n/a Optional Optional Optional
hostname n/a Conditional Conditional

Conditional.

port n/a Conditional Default value is '22'. Conditional Default value is '23'.

n/a

username n/a Conditional Conditional

Conditional.

password n/a Conditional Conditional

Conditional.

password–encryption–type n/a

Optional

Default value is 'Plain'

Optional.

Default value is 'Plain'.

n/a

prompt

n/a

n/a

Conditional.

n/a

working–dir

Optional.

n/a

n/a

n/a

command–dir

Optional.

n/a

n/a

n/a

command–encryption–type

Optional.

Optional.

Optional.

n/a

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

n/a

Optional.

Optional.

n/a

terminate–connection

n/a

Optional.

Default value is 'false'.

Optional.

Default value is 'false'.

n/a

known–hosts–config

n/a

Optional.

n/a

n/a

allow–unknown–hosts

n/a

Optional.

Default value is 'false'.

n/a

n/a

preferred–pk–algorithm

n/a

Optional.

Default value is 'ssh–rsa'.

n/a

n/a

For details on assigning element values for each <invocation–mechanism> see the following topics.

Command line invocation mechanism

SSH invocation mechanism

Telnet invocation mechanism

Windows command invocation mechanism

Was this page helpful? Yes No Submitting... Thank you

Comments