To configure an adapter request to communicate with a host that is not defined in the adapter configuration, you can designate a dynamic target by assigning values for the required configuration elements. These elements work as a set. You cannot retrieve partial information from the configuration node.
You can omit the <targets> block from the adapter request. In the absence of a <targets> block, the default target from the adapter configuration is used.
When you use a context item as an input for an adapter request, you must enclose the adapter request in the <request-data> elements. However, when you create a static request, <request-data> is not required and the adapter request starts with the <adapterName-adapter-request> element.
The following table describes the elements of an SFTP adapter request with an lcd command.
Elements of an SFTP adapter request with an lcd command
Element | Description | Required |
|---|---|---|
| Contains the | Conditional; required if a target is referenced or defined in the request |
| Contains the Default value: Default target in the adapter configuration | Conditional; required if a target is referenced or defined in the request |
| Specifies the host name or the IP address of the remote host | Conditional; required when defining a dynamic target |
| Specifies the port on which the remote host listens This element applies to a dynamic target. Default value: 22 | Conditional |
| Specifies the user name to be used for remote host authentication This element applies to a dynamic target. This element might be needed based on the requirements of the remote host. | Conditional; required when defining a dynamic target |
| Specifies the password that corresponds to the This element applies to a dynamic target computer. The The | Conditional |
| Indicates whether the password specified is encrypted; is an attribute of the Valid values: Base64, Plain (default) | No |
| Specifies the time, in seconds, to wait for the expected prompt to return If the expected prompt is not returned before the specified period has elapsed, an error message is returned. Default value: 60 seconds | No |
| Identifies the path to the local known_hosts file This file is used when performing key verification. This element applies to a dynamic target. Default value: homeDir/.ssh/known_hosts | Conditional |
| Determines whether a connection must continue if key verification fails This element applies to a dynamic target. Valid values: true (default), false Note: With a value of true, the connection is maintained when connecting to an unknown or mismatched system. Else, the connection is dropped and the adapter response returns an error. | Conditional |
| Specifies the preference of the algorithm used to encrypt the public key This element applies to a dynamic target. Valid values: ssh-dss, ssh-rsa (default) | Conditional |
| Specifies the time, in seconds, to wait for user authentication on the target server If authentication is not successful within this time, an error message is returned. Default value: 60 seconds | No |
| Creates an extra channel session for use with Sun Solaris 9 This value must be false when connecting to network appliances. Valid values: true, false (default) | No |
| Contains the SFTP command element | Yes |
| Indicates the directory the local host must use as the working directory A directory must be specified for this element. | Yes |
| Specifies the supporting CharSet CharSet is also called Character set that are identifiers describing a series of universal characters. | No |
The following figure shows an XML template of the adapter request for the SFTP adapter with the lcd command.
XML template for a SFTP adapter request with lcd command
<sftp-request> <targets> <target name=""/> <target> <host></host> <port></port> <user-name></user-name> <password encryption-type=""></password> <timeout-secs></timeout-secs> <known-hosts-config></known-hosts-config> <allow-unknown-hosts></allow-unknown-hosts> <preferred-pk-algorithm></preferred-pk-algorithm> <establish-connection-timeout-secs></establish-connection-timeout-secs> <network-environment></network-environment> <character-set></character-set> </target> </targets> <commands> <lcd></lcd> </commands>
</sftp-request>
The following figure shows an XML sample of the adapter request for the SFTP adapter with the lcd command. In this sample, the first target references the adapter configuration and the second target is a dynamic target.
XML sample of the SFTP adapter request with lcd command
<sftp-request> <targets> <target name="host1"/> <target> <host>server1</host> <port>2200</port> <user-name>user</user-name> <password encryption-type="Plain">test</password> <timeout-secs>90</timeout-secs> <known-hosts-config>/path/to/known_hosts</known-hosts-config> <allow-unknown-hosts>false</allow-unknown-hosts> <preferred-pk-algorithm>ssh-dss</preferred-pk-algorithm> <establish-connection-timeout-secs>90</establish-connection-timeout-secs> <network-environment>true</network-environment> <character-set>Shift_JIS</character-set> </target> </targets> <commands> <lcd>/tmp</lcd> </commands>
</sftp-request>
The lcd command request for a SFTP adapter returns an adapter response containing the summary information for the command.
The following table describes the elements of an SFTP adapter response to a request with lcd command.
Elements of an SFTP adapter response to a request with Icd command
Element | Description |
|---|---|
| Contains the request level summary information |
| Indicates the status of the request Valid values: success, error |
| Indicates the error message returned when the value of the When the value of the |
| Contains the command output for all the targets |
| Contains the command output for a specific target The |
| Contains the target level summary information |
| Indicates the status of the target connection Valid values: success, error |
| Contains the error message if a target level error occurs When the value of the |
| Contains the command responses for all the commands executed on the target computer |
| Contains the command response for a specific command |
| Contains the command summary information. |
| Specifies the sequence in which the command is executed |
| Specifies the command executed |
| Specifies the duration of the command execution, in milliseconds |
| Indicates the status of the command execution Valid values: success, error |
| Contains the error message if a command level error occurs When the value of the If the transfer is interrupted, a partial file might exist in the destination location. |
| Contains the lines that result from the command This command does not return a detailed response. |
The following figure illustrates an XML sample of the adapter response for the SFTP adapter with the lcd command.
XML sample of the SFTP adapter response with lcd command
<sftp-command-output> <request-metadata> <status>success</status> <error>Present only with status of 'error'</error> </request-metadata> <targets-output> <target-output host="server1"> <target-metadata> <status>success</status> <error>Present only with status of 'error'</error> </target-metadata> <commands-output> <command-output> <metadata> <id>1</id> <command>lcd</command> <execution-milliseconds>value</execution-milliseconds> <status>success</status> <error>Present only with status of 'error'</error> </metadata> <output/> </command-output> </commands-output> </target-output> </targets-output>
</sftp-command-output>
