Adapter requests and responses for the SFTP adapter

The SFTP adapter uses the commands listed in SFTP adapter commands as tag names in the request.

The SFTP adapter supports different methods for designating the target information in an adapter request. For more information about the different methods for designating the target information in an adapter request, see Dynamic targets.

Note

Starting with the 20.12.02 release, the SFTP adapter supports Internet Protocol version 6 (IPv6) for directing internet traffic and for routing. For details, see Support for IPv6.

You can specify an IPv6 address with a zone ID for the <host> element in the adapter requests—for example, <host>fe80::20c:29ff:fe5d:38f0%eth0</host>.
To find the zone ID of the required computer, see Zone ID for an IPv6 address.

The sample requests and responses are provided for each of the commands available for this adapter. These samples are basic and do not reflect all the available features for this adapter.

Use the adapter request XML when you create a custom process by using the Call Adapter activity in TrueSight Orchestration Development Studio.

The SFTP adapter supports the following commands:

SFTP adapter commands

Command

Description

cd

Changes the directory on the remote server

chgrp

Changes the group for a specified file

chmod

Changes the permissions for a specified file

chown

Changes the owner for a specified file

get

Obtains a file from the remote server and places it on the local server

get-dir

Obtains the contents of a specified directory from a remote server

lcd

Changes the directory on the local server

lpwd

Prints the working directory on the local server

ls

Lists the files on the remote server

mkdir

Creates a directory in an existing directory path on the remote server

mkdirs

Creates a single or many directories in the path that does not currently exist on the remote server

put

Transfers a file from the local server to the remote server

put-dir

Transfers the contents of a specified directory to the remote server

pwd

Prints the working directory on the remote server

rename

Changes the name of a file on the remote server

rm

Deletes a specified file from the remote server

symlink

Creates a symbolic link on the remote server for a specified file

Was this page helpful? Yes No Submitting... Thank you

Comments