FTP adapter request and response for a rename 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 a rename command:
Elements of an FTP adapter request with a rename command
The following figure shows an XML template of the adapter request for the FTP adapter with rename command.
XML template of the FTP adapter request with rename command
<ftp-request>
<targets>
<target name=""/>
</targets>
<data-transfer-mode></data-transfer-mode>
<commands>
<rename>
<old-file></old-file>
<new-file></new-file>
</rename>
</commands>
</ftp-request>
The following figure shows an XML sample of the adapter request for the FTP adapter with the rename command.
XML sample of the FTP adapter request with rename command
<ftp-request>
<targets>
<target name="host1"/>
<character-set>Shift_JIS</character-set>
</targets>
<data-transfer-mode>PASSIVE</data-transfer-mode>
<commands>
<rename>
<old-file>/path/to/file/filename</old-file>
<new-file>/path/to/file/new filename</new-file>
</rename>
</commands>
</ftp-request>
The rename command request for the FTP adapter returns an adapter response containing the summary information for the command.
The following table describes the elements of an FTP adapter response to a request with rename command:
Elements of an FTP adapter response to a request with rename command
The following figure illustrates the adapter response for the FTP adapter with rename command.
XML sample of the FTP adapter response with rename 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>rename</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>
</ftp-command-output>