Create SFTP Connection Configuration

Description

Creates a set of properties needed to open a connection to an SFTP server.

Assembly: iCore.Workflow.Activities.Ftp
Category: SFTP/FTP

Arguments

Name	Type	Description
Name	String	Name of the activity.
Result	IFileTransferConnectionConfiguration	The created connection configuration.
Server	String	Name or IP address of SFTP server.
Port	Int32	Port that the SFTP service is listening on for incoming connections. Default: 22
User	String	User name on SFTP server.
Password	String	Password associated with the user name.
Server validation	SftpServerValidation	Specifies how the server is validated. Turning validation off by selecting 'None' is not recommended.
Server public key file	String	File containing the server's public key. Used for validation of server. Note that file needs to be accessible at runtime.
Private key file	String	File containing the client’s private key. Set if public key authentication is to be used.
Private key file password	String	Password used to open the encrypted private key file.
Transfer type	SftpTransferType	Specifies how data is transferred. Options are: ASCII Binary
Retries	Int32	Number of times the activity will retry to issue a failed command before an error occurs. Default: 0
Time between retries	TimeSpan	Time in seconds to wait between each retry. Default: 0
Socket timeout	Int32	Specifies the maximum time of inactivity (in milliseconds), after which socket operation is cancelled and is considered expired. A value of 0 implies that operation never will expire.
Download blockSize	Int32	Controls the size, in bytes, of the single request for data reading from the remote server. The default value is 0, which means "use optimal value". Optimal value is set to 2Mb - 256b.
Upload blockSize	Int32	Controls the size, in bytes, of the single request for data writing to the remote server. The default value is 0, which means "use optimal value". Optimal value is set to 32Kb - 256b since not all servers support larger values.
Force compression	Boolean	Specifies whether file lists are handled as case sensitive. True means lists will be case sensitive.
Versions	SftpVersion	Specifies SFTP versions which can be used during the connection.
Interactive logon	SortedList<string, object>	Used when the client needs to support interactive logon but cannot implicitly resolve server prompts. Named values where each name/value pair is server prompt and client response. For example username: 'User: ' and 'user001'. You can use the following syntax for setting the property: New SortedList(Of String, Object) From {{"User: ", "user001"}, {"Password: ", "passwordofuser001"}}
Implicit interactive logon	Boolean	Set to true when client needs to support interactive logon. The client will try to resolve server prompts for username and password.
Pipeline length	Int32	Specifies the pipeline length, i.e. the number of concurrent read/write operations sent within a single download/upload. A high value will improve performance but requires more resources (memory).
Auto adjust transfer block	Boolean	Specifies whether the block sizes and pipeline length is adjusted for optimal performance. The default value is true, which means that block sizes and pipeline length are adjusted to an optimal value.
Use HTTP proxy	Boolean	Enables the use of SFTP with HTTP proxy.
HTTP proxy server	String	The client certificate that the server may request.
HTTP proxy port	Int32	Port that the HTTP proxy server listens to for incoming connections. Default: 80
Authentication method	Boolean	What authentication method should be used for the HTTP proxy connection.
HTTP proxy username	String	Username for the HTTP proxy authentication.
HTTP proxy password	String	Password for the HTTP proxy authentication.
Use SOCKS	Boolean	Enables to use SFTP with SOCKS.
SOCKS server	String	Name or IP address of the SOCKS server.
SOCKS port	Int32	Port that the SOCKS server listens to for incoming connections. Default: 1080
SOCKS version	SocksVersion	The version of the SOCKS protocol.
Use IpV6	Boolean	If set to True, SOCKS connection will use IPv6.
SOCKS resolve address on server	Boolean	If set to True, the server should try to resolve the hostname of the SFTP destination server.
Enable authentication	Boolean	If set to True, the SOCKS connection will use authentication.
SOCKS username	String	Username for the SOCKS authentication.
SOCKS password	String	Password for the SOCKS authentication.
Use UTF8	Boolean	If set to True, the filename will be parsed using UTF8.
Suppress additional operations	Boolean	Set to True to suppress any additional file operations, which lets you overcome problems which may occur with some SFTP servers. True means that all operations related to upload and download of files are discarded. If the target directory does not exist when uploading a file, an exception is thrown. An existing file on the server is always overwritten during upload regardless of the Store mode option set on relevant activities (see for example Upload SFTP/FTP File From Stream). Resuming is not supported during download.
Initialize KEX	Boolean	Set to True if you want the client to send KEX (key exchange) initialization to the server immediately after the connection is established. Doing so can solve issues with some SFTP servers that expect the client to initialize KEX.

See Also

Open SFTP/FTP Connection