SFTP Close Connection

The SFTP Close Connection activity closes the connection for the configured HostIP, Port, and username. This activity enables the user to close the used connection even when the Quit check box is not selected on the activity level configuration.

General

The General tab has the following fields.

Field	Literal Value/Module Property	Visual Difference?	Description
Name	No	Yes	The name to be displayed as the label for the resource.
SFTP Connection	Yes	Yes	The path to the shared configuration resource containing the user information such as Host, Port, and User Name, Private Key or Password, and Known Host File. For configuration details, refer to SFTP Connection.
Quit (post-command)	No	Yes	When this check box is selected, it specifies that the SFTP Connection should be closed after completing this command. If this check box is not selected, the SFTP Connection remains open so that all SFTP activities specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed.

Field

Literal Value/Module Property

Visual

Difference?

Description

Name

Yes

The name to be displayed as the label for the resource.

SFTP Connection

Yes

The path to the shared configuration resource containing the user information such as Host, Port, and User Name, Private Key or Password, and Known Host File.

For configuration details, refer to SFTP Connection.

Quit (post-command)

Yes

When this check box is selected, it specifies that the SFTP Connection should be closed after completing this command.

If this check box is not selected, the SFTP Connection remains open so that all SFTP activities specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed.

Description

In the Description tab, you can enter a short description for the SFTP Close Connection activity.

Input

The following is the input for the activity.

Input Item	Datatype	Description
Host	string	The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Port	integer	The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
UserName	string	The user name for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Proxy Host	string	Specifies the host name or IP address of the proxy server.
Proxy Port	integer	Specifies the port number of the proxy server.
Proxy User Name	string	Specifies the user name used to connect to the proxy server, if necessary.

Fault

The Fault tab lists the possible exceptions that can be thrown by this activity.

Exception	Thrown When...
CommandExecutionException	An error occurs when executing the SFTP command.
ConnectionErrorException	An error occurs when connecting to the SFTP server.

Did you find this helpful?

Yes No