SFTP adapter request and response for a chmod 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.
The following table describes the elements of an SFTP adapter request with the chmod command.
Elements of an SFTP adapter request with chmod command
The following figure shows an XML template of the adapter request for the SFTP adapter with the chmod command.
XML template of the SFTP adapter request with chmod 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>
<chmod>
<file></file>
<permissions></permissions>
</chmod>
</commands>
</sftp-request>
The following figure shows an XML sample of the adapter request for the SFTP adapter with chmod 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 chmod 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>
<chmod>
<file>/path/to/file/filename</file>
<permissions>0777</permissions>
</chmod>
</commands>
</sftp-request>
The chmod command request for the SFTP adapter returns an adapter response that contains the summary information for the command. The following figure shows an XML sample of the adapter request for the SFTP adapter with the chmod command.
XML sample of the SFTP adapter response with chmod command
<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>chmod</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>
<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>chmod</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>
The following table describes the elements of an SFTP adapter response to a request with chmod command.
Elements of an SFTP adapter response to a request with chmod command