FTP adapter request and response for a rmdir command

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 FTP adapter request with a rmdir command.

Elements of an FTP adapter request with a rmdir command

Element

Description

Required

<targets>

Contains the <target> elements

Conditional; required if a target computer is referenced or defined in the request

<target>

Contains a name attribute that references a configuration node from the adapter configuration, or contains the elements that define a dynamic target computer

If not provided, the default target in the adapter configuration is used.

Conditional; required if a target computer is referenced or defined in the request

<data-transfer-mode>

Indicates the mode to be used for data transfer

Valid values: PASSIVE, ACTIVE (default)

No

<commands>

Contains the FTP command element

Yes

<rmdir>

Indicates the remote path for the directory to be removed from the remote server

Yes

<character-set>

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 FTP adapter with rmdir command.

XML template of the FTP adapter request with the rmdir command


<ftp-request>
   <targets>
     <target name=""/>
   </targets>
   <data-transfer-mode></data-transfer-mode>
   <commands>
     <rmdir></rmdir>
   </commands>
</ftp-request>


The following figure shows an XML sample of the adapter request for the FTP adapter with the rmdir command.

XML sample of the FTP adapter request with rmdir command


<ftp-request>
   <targets>
     <target name="host1"/>
     <character-set>Shift_JIS</character-set>
   </targets>
   <data-transfer-mode>PASSIVE</data-transfer-mode>
   <commands>
     <rmdir>/path/to/directory</rmdir>
   </commands>
</ftp-request>


The rmdir command request for a 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 rmdir command.

Elements of an FTP adapter response to a request with rmdir command

Element

Description

<request-metadata>

Contains the request level summary information

<status>

Indicates the status of the request

Valid values: success, error

<error>

Indicates the error message returned when the value of the <status> element is error

When the value of the <status> element is success, this element is absent.

<targets-output>

Contains the command output for all the targets

<target-output>

Contains the command output for a specific target

The host attribute provides the host name or the IP address of the target.

<target-metadata>

Contains the target level summary information

<status>

Indicates the status of the target connection

Valid values: success, error

<error>

Contains the error message if a target level error occurs

When the value of the <status> element is success, this element is absent.

<commands-output>

Contains the command responses for all the commands executed on the target computer

<command-output>

Contains the command response for a specific command

<metadata>

Contains the command summary information

<id>

Specifies the sequence in which the command is executed

<command>

Specifies the command executed

<execution-milliseconds>

Specifies the duration of the command execution, in milliseconds

<status>

Indicates the status of the command execution

Valid values: success, error

<error>

Contains the error message if a command level error occurs

When the value of the <status> element is success, this element is absent.

<output>

Contains any 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 FTP adapter with rmdir command.

XML sample of the FTP adapter response with rmdir 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>rmdir</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>

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments