SFTP adapter request and response for a lpwd command
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.
BMC recommends that you do not include unused elements in the adapter configuration because they might cause errors.
The following table describes the elements of an SFTP adapter request with an lpwd command.
Elements of an SFTP adapter request with an Ipwd command
The following figure shows an XML template of the adapter request for the SFTP adapter with the lpwd command.
XML template of the SFTP adapter request with lpwd 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>
<lpwd/>
</commands>
</sftp-request>
The following figure shows an XML sample of the adapter request for the SFTP adapter with the lpwd 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 lpwd 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>
<lpwd/>
</commands>
</sftp-request>
The lpwd command request for a SFTP adapter returns an adapter response that contains the present working directory on the local server.
The following table describes the elements of an SFTP adapter response to a request with lpwd command.
Elements of an SFTP adapter response to a request with lpwd command
The following figure illustrates the adapter response for the SFTP adapter with lpwd command.
XML sample of the SFTP adapter response with the lpwd 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>lpwd</command>
<execution-milliseconds>value</execution-milliseconds>
<status>success</status>
<error>Present only with status of 'error'</error>
</metadata>
<output>
<lpwd>/tmp</lpwd>
</output>
</command-output>
</commands-output>
</target-output>
</targets-output>
</sftp-command-output>