Config2_GatewayConnection

Gateway connection settings for FTP/SFTP/SCP connections. Provides comprehensive configuration for connecting to remote file transfer servers.

Instances of this class are obtained from:

Properties

PropertyTypeDescription
accountInfo String

Account information for ACCT command.
activePortRange Config2_ActivePortRange

Active mode port range settings.
authenticationMethod String

SSH authentication method.
autoPassiveIPSubstitution Boolean

Whether to automatically substitute the server's IP in PASV responses.
autoSecure Boolean

Whether to automatically use SSL/TLS if available.
cacheListings Boolean

Whether to cache directory listings.
cipherSuites String

Cipher suites for SSL/TLS.
clientCertificate String

Client certificate for SSL/TLS authentication.
clientPrivateKey String

Client private key for public key authentication (PEM format).
clientPrivateKeyPassphrase String

Passphrase for encrypted private key.
commandEncoding String

Character encoding for FTP commands (e.
compressionPreferred Boolean

Whether compression is preferred.
connectMode String

FTP connection mode.
dataEncoding String

Character encoding for data transfers.
detectTransferMode Boolean

Whether to automatically detect transfer mode (ASCII/binary).
forceConnectModeExtensions Boolean

Whether to force extended passive mode (EPSV) commands.
kbiPrompts String

Keyboard-interactive prompts configuration.
keepAliveIdle Boolean

Whether to send keep-alive packets when idle.
keepAlivePeriodSecs Number

Keep-alive period in seconds.
keepAliveTransfer Boolean

Whether to send keep-alive packets during transfers.
maxSSLVersion String

Maximum SSL/TLS version to use.
maxTransferRate Number

Maximum transfer rate in bytes per second (0 = unlimited).
minSSLVersion String

Minimum SSL/TLS version to use.
name String

Connection name/label.
parallelTransferMode Boolean

Whether to use parallel transfer mode for SFTP.
parsingCulture String

Culture for parsing server responses.
password String

Password for authentication.
preferredCipherAlgorithms String

Preferred SSH cipher algorithms.
preferredCompressionAlgorithms String

Preferred SSH compression algorithms.
preferredHostKeyAlgorithms String

Preferred SSH host key algorithms.
preferredKeyExchangeMethods String

Preferred SSH key exchange methods.
preferredMACAlgorithms String

Preferred SSH MAC algorithms.
protocol String

File transfer protocol.
proxySettings Config2_ProxySettings

Proxy settings for the connection.
publicIPAddress String

Public IP address to report in PORT commands.
retryCount Number

Number of times to retry failed operations.
retryDelay Number

Delay between retries in milliseconds.
sendInitialWindowAdjust Boolean

Whether to send initial window adjust message.
serverAddress String

Remote server hostname or IP address.
serverCommonName String

Expected server common name for certificate validation.
serverCompatibility String

Server compatibility flags.
serverDirectory String

Initial directory on the remote server.
serverLineTerminator String

Server line terminator type.
serverPort Number

Remote server port number.
serverValidation String

Server validation type.
serverValidationCertificate String

Server certificate for validation.
sshMaxPacketSize Number

Maximum SSH packet size.
sshMaxQueuedReadRequests Number

Maximum queued read requests for SFTP.
sshWindowSize Number

SSH window size.
synchronizePassiveConnections Boolean

Whether to synchronize passive data connections.
tcpBufferSize Number

TCP socket buffer size in bytes.
timeDifferenceSecs Number

Time difference from server in seconds.
timeout Number

Connection timeout in milliseconds.
transferBufferSize Number

Size of the transfer buffer in bytes.
transferType String

Transfer type.
umask String

umask for file creation permissions.
useUnencryptedCommands Boolean

Whether to use unencrypted commands before AUTH TLS.
userName String

Username for authentication.

Property Details

accountInfo :String

Description:

  • Account information for ACCT command.

Account information for ACCT command.

Type:
  • String

activePortRange :Config2_ActivePortRange

Description:

  • Active mode port range settings.

Active mode port range settings.

Type:

authenticationMethod :String

Description:

  • SSH authentication method. Valid values: 'Password', 'PublicKey', 'KeyboardInteractive'.

SSH authentication method. Valid values: 'Password', 'PublicKey', 'KeyboardInteractive'.

Type:
  • String

autoPassiveIPSubstitution :Boolean

Description:

  • Whether to automatically substitute the server's IP in PASV responses.

Whether to automatically substitute the server's IP in PASV responses.

Type:
  • Boolean

autoSecure :Boolean

Description:

  • Whether to automatically use SSL/TLS if available.

Whether to automatically use SSL/TLS if available.

Type:
  • Boolean

cacheListings :Boolean

Description:

  • Whether to cache directory listings.

Whether to cache directory listings.

Type:
  • Boolean

cipherSuites :String

Description:

  • Cipher suites for SSL/TLS.

Cipher suites for SSL/TLS.

Type:
  • String

clientCertificate :String

Description:

  • Client certificate for SSL/TLS authentication.

Client certificate for SSL/TLS authentication.

Type:
  • String

clientPrivateKey :String

Description:

  • Client private key for public key authentication (PEM format).

Client private key for public key authentication (PEM format).

Type:
  • String

clientPrivateKeyPassphrase :String

Description:

  • Passphrase for encrypted private key.

Passphrase for encrypted private key.

Type:
  • String

commandEncoding :String

Description:

  • Character encoding for FTP commands (e.g., 'utf-8', 'iso-8859-1').

Character encoding for FTP commands (e.g., 'utf-8', 'iso-8859-1').

Type:
  • String

compressionPreferred :Boolean

Description:

  • Whether compression is preferred.

Whether compression is preferred.

Type:
  • Boolean

connectMode :String

Description:

  • FTP connection mode. Valid values: 'PASV', 'ACTIVE'.

FTP connection mode. Valid values: 'PASV', 'ACTIVE'.

Type:
  • String

dataEncoding :String

Description:

  • Character encoding for data transfers.

Character encoding for data transfers.

Type:
  • String

detectTransferMode :Boolean

Description:

  • Whether to automatically detect transfer mode (ASCII/binary).

Whether to automatically detect transfer mode (ASCII/binary).

Type:
  • Boolean

forceConnectModeExtensions :Boolean

Description:

  • Whether to force extended passive mode (EPSV) commands.

Whether to force extended passive mode (EPSV) commands.

Type:
  • Boolean

kbiPrompts :String

Description:

  • Keyboard-interactive prompts configuration.

Keyboard-interactive prompts configuration.

Type:
  • String

keepAliveIdle :Boolean

Description:

  • Whether to send keep-alive packets when idle.

Whether to send keep-alive packets when idle.

Type:
  • Boolean

keepAlivePeriodSecs :Number

Description:

  • Keep-alive period in seconds.

Keep-alive period in seconds.

Type:
  • Number

keepAliveTransfer :Boolean

Description:

  • Whether to send keep-alive packets during transfers.

Whether to send keep-alive packets during transfers.

Type:
  • Boolean

maxSSLVersion :String

Description:

  • Maximum SSL/TLS version to use.

Maximum SSL/TLS version to use.

Type:
  • String

maxTransferRate :Number

Description:

  • Maximum transfer rate in bytes per second (0 = unlimited).

Maximum transfer rate in bytes per second (0 = unlimited).

Type:
  • Number

minSSLVersion :String

Description:

  • Minimum SSL/TLS version to use.

Minimum SSL/TLS version to use.

Type:
  • String

name :String

Description:

  • Connection name/label.

Connection name/label.

Type:
  • String

parallelTransferMode :Boolean

Description:

  • Whether to use parallel transfer mode for SFTP.

Whether to use parallel transfer mode for SFTP.

Type:
  • Boolean

parsingCulture :String

Description:

  • Culture for parsing server responses.

Culture for parsing server responses.

Type:
  • String

password :String

Description:

  • Password for authentication.

Password for authentication.

Type:
  • String

preferredCipherAlgorithms :String

Description:

  • Preferred SSH cipher algorithms.

Preferred SSH cipher algorithms.

Type:
  • String

preferredCompressionAlgorithms :String

Description:

  • Preferred SSH compression algorithms.

Preferred SSH compression algorithms.

Type:
  • String

preferredHostKeyAlgorithms :String

Description:

  • Preferred SSH host key algorithms.

Preferred SSH host key algorithms.

Type:
  • String

preferredKeyExchangeMethods :String

Description:

  • Preferred SSH key exchange methods.

Preferred SSH key exchange methods.

Type:
  • String

preferredMACAlgorithms :String

Description:

  • Preferred SSH MAC algorithms.

Preferred SSH MAC algorithms.

Type:
  • String

protocol :String

Description:

  • File transfer protocol. Valid values: 'FTP', 'FTPSExplicit', 'FTPSImplicit', 'SFTP', 'SCP', 'HTTP'.

File transfer protocol. Valid values: 'FTP', 'FTPSExplicit', 'FTPSImplicit', 'SFTP', 'SCP', 'HTTP'.

Type:
  • String

proxySettings :Config2_ProxySettings

Description:

  • Proxy settings for the connection.

Proxy settings for the connection.

Type:

publicIPAddress :String

Description:

  • Public IP address to report in PORT commands.

Public IP address to report in PORT commands.

Type:
  • String

retryCount :Number

Description:

  • Number of times to retry failed operations.

Number of times to retry failed operations.

Type:
  • Number

retryDelay :Number

Description:

  • Delay between retries in milliseconds.

Delay between retries in milliseconds.

Type:
  • Number

sendInitialWindowAdjust :Boolean

Description:

  • Whether to send initial window adjust message.

Whether to send initial window adjust message.

Type:
  • Boolean

serverAddress :String

Description:

  • Remote server hostname or IP address.

Remote server hostname or IP address.

Type:
  • String

serverCommonName :String

Description:

  • Expected server common name for certificate validation.

Expected server common name for certificate validation.

Type:
  • String

serverCompatibility :String

Description:

  • Server compatibility flags.

Server compatibility flags.

Type:
  • String

serverDirectory :String

Description:

  • Initial directory on the remote server.

Initial directory on the remote server.

Type:
  • String

serverLineTerminator :String

Description:

  • Server line terminator type.

Server line terminator type.

Type:
  • String

serverPort :Number

Description:

  • Remote server port number.

Remote server port number.

Type:
  • Number

serverValidation :String

Description:

  • Server validation type.

Server validation type.

Type:
  • String

serverValidationCertificate :String

Description:

  • Server certificate for validation.

Server certificate for validation.

Type:
  • String

sshMaxPacketSize :Number

Description:

  • Maximum SSH packet size.

Maximum SSH packet size.

Type:
  • Number

sshMaxQueuedReadRequests :Number

Description:

  • Maximum queued read requests for SFTP.

Maximum queued read requests for SFTP.

Type:
  • Number

sshWindowSize :Number

Description:

  • SSH window size.

SSH window size.

Type:
  • Number

synchronizePassiveConnections :Boolean

Description:

  • Whether to synchronize passive data connections.

Whether to synchronize passive data connections.

Type:
  • Boolean

tcpBufferSize :Number

Description:

  • TCP socket buffer size in bytes.

TCP socket buffer size in bytes.

Type:
  • Number

timeDifferenceSecs :Number

Description:

  • Time difference from server in seconds.

Time difference from server in seconds.

Type:
  • Number

timeout :Number

Description:

  • Connection timeout in milliseconds.

Connection timeout in milliseconds.

Type:
  • Number

transferBufferSize :Number

Description:

  • Size of the transfer buffer in bytes.

Size of the transfer buffer in bytes.

Type:
  • Number

transferType :String

Description:

  • Transfer type. Valid values: 'ASCII', 'BINARY'.

Transfer type. Valid values: 'ASCII', 'BINARY'.

Type:
  • String

umask :String

Description:

  • umask for file creation permissions.

umask for file creation permissions.

Type:
  • String

useUnencryptedCommands :Boolean

Description:

  • Whether to use unencrypted commands before AUTH TLS.

Whether to use unencrypted commands before AUTH TLS.

Type:
  • Boolean

userName :String

Description:

  • Username for authentication.

Username for authentication.

Type:
  • String