FTP adapter request and response for ls command
When you use a context item as an input for an adapter request, you must enclose the adapter request in <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 empty elements in the adapter request because they might cause errors.
The following table describes the elements of an FTP adapter request with an ls command:
Elements of an FTP adapter request with an ls command
The following figure shows an XML template of the adapter request for the FTP adapter with ls command.
XML template of the FTP adapter request with ls command
<ftp-request>
<targets>
<target name=""/>
</targets>
<data-transfer-mode></data-transfer-mode>
<commands>
<ls></ls>
</commands>
</ftp-request>
The following figure shows an XML sample of the adapter request for the FTP adapter with ls command.
XML sample of the FTP adapter request with ls command
<ftp-request>
<targets>
<target name="host1"/>
<character-set>Shift_JIS</character-set>
</targets>
<data-transfer-mode>PASSIVE or ACTIVE</data-transfer-mode>
<commands>
<ls>/tmp</ls>
</commands>
</ftp-request>
The ls command request for the FTP adapter returns an adapter response containing the details about the files contained in the specified directory. The following table describes the elements of an FTP adapter response to a request with ls command:
Elements of an FTP adapter response to a request with ls command
The following figure illustrates an XML sample of the adapter response for the FTP adapter with ls command.
XML sample of the FTP adapter response with ls command
<ftp-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>ls</command>
<execution-milliseconds>value</execution-milliseconds>
<status>success</status>
<error>Present only with status of 'error'</error>
</metadata>
<output>
<file>
<name>Sample File1</name>
<owner>user1</owner>
<group>tester</group>
<permission>-rw-r--r--</permission>
<modification-time>Jan 01 01:00</modification-time>
<size-bytes>195</size-bytes>
</file>
</output>
</command-output>
</commands-output>
</target-output>
</targets-output>
</ftp-command-output>