YADE Parameter Reference - SFTPFragment

This attribute identifies the current fragment. Any number of fragments can be used and are distinguished by YADE according their name.

A fragment is referenced by a transfer profile using the value of this attribute.

• Schema: BasicConnection, BasicConnection

A connection specifies parameters for a Hostname and a Port to which a connection is established.

• Schema: SSHAuthentication, SSHAuthentication

The SSHAuthentication element specifies the credentials for authentication with a server, e.g. an FTP Server or a Proxy. Child elements include:

• Account for authentication. For Windows Systems an account could include the domain.
• PreferredAuthentications. Specifies the order in which the client should try protocol 2 authentication methods.
• RequiredAuthentications. Specifies the authentication methods that must be successfully completed for a user to be granted access.
• AuthenticationMethodPassword for authentication.
  • Password Passwords are not displayed in the YADE log files.
• AuthenticationMethodPublicKey for authentication. Public/private key authentiction with an
  • AuthenticationFile
  • Passphrase
• AuthenticationMethodKeyboardInteractive for authentication.

• Schema: PreferredAuthentications
• Mapping:
  • preferred_authentications
• Release:
  • YADE-462 Availability starting with 1.12.1.

Specifies the order in which the client should try protocol 2 authentication methods.

This allows a client to prefer one method (e.g. publickey) over another method (e.g. password).

• Schema: RequiredAuthentications
• Mapping:
  • required_authentications
• Release:
  • YADE-462 Availability starting with 1.12.1.

Specifies the authentication methods that must be successfully completed for a user to be granted access.

See SSH configuration:

• AuthenticationMethods
• RequiredAuthentications2

• Schema: AuthenticationMethodKeyboardInteractive
• Mapping:
  • ssh_auth_method
• Release:
  • YADE-495 Availability starting with 1.12.2.

Usage only with the YADE Client on the command shell.

The use of this element specifies that for SSHAuthentication an authentication method for keyboard interactive authentication, which allows the YADE Client on the command shell to ask a password question and the user to input a response.

As an alternative to keyboard interactive authentication the authentication methods:

• AuthenticationMethodPassword
• AuthenticationMethodPublickey

• Schema: CredentialStoreFragmentRef, CredentialStoreFragmentRef

This element references the fragment that is used to insert configuration items from a secure store into a file transfer configuration.

Any number of reusable CredentialStoreFragment elements can be configured and are distinguished by YADE based on their name attribute.

The reference to a fragment is based on the value of the ref attribute of this element to the corresponding name attribute of the CredentialStoreFragment element.

Support for a jump host.

Note: Availability starting with YADE-488.

• Schema: JumpFragmentRef, JumpFragmentRef

Any number of reusable JumpFragment elements can be configured and are distinguished by YADE based on their name attribute.

This element identifies the JumpFragment that is applied for use of a jump host in a file transfer.

The reference to a fragment is based on the value of the ref attribute of this element to the corresponding name attribute of the JumpFragment element.

ProxyForSFTP - will use the HTTP, SOCKS4 or SOCKS5 proxy

• Schema: HTTPProxy, HTTPProxy
• Mapping:
  • proxy_protocol
• Release:
  • YADE-351 Availability starting with 1.11.

Proxies can make use of different protocols, a HTTPProxy - as the name suggests - will use the HTTP protocol

HTTP proxies optionally support authentication.

• Schema: SOCKS4Proxy, SOCKS4Proxy
• Mapping:
  • proxy_protocol

Proxies can make use of different protocols, a SOCKS4Proxy - as the name suggests - will use the SOCKS4 protocol

SOCKS4 proxies do not support authentication.

• Schema: SOCKS5Proxy, SOCKS5Proxy
• Mapping:
  • proxy_protocol

Proxies can make use of different protocols, a SOCKS5Proxy - as the name suggests - will use the SOCKS5 protocol

SOCKS5 proxies optionally support authentication.

• Schema: StrictHostkeyChecking, StrictHostkeyChecking
• Mapping:
  • strict_host_key_checking
  • StrictHostKeyChecking

This parameter specifies the behavior for hosts that have not previously been involved in a file transfer.

• By default it is not necessary that the user "known hosts" files contain the host key which corresponds to the value "false".
• If this parameter is set to "true", the host key is expected in the user "known hosts" files and YADE will refuse to connect to hosts whose host key cannot be found. This setting forces the user to manually add new hosts to the "known hosts" files.

• Schema: ConfigurationFiles
• Mapping:
  • configuration_files
• Release:
  • YADE-403 Availability starting with 1.11.

An application configuration file contains settings that are specific to an app. YADE allows to specify configuration files individually per transfer fragment.

• Schema: ConfigurationFile, ConfigurationFile

An application configuration file contains settings that are specific to an app.

• Schema: ServerAliveInterval
• Mapping:
  • server_alive_interval
• Release:
  • YADE-527 Availability starting with 1.12.6.

Sets the interval in milliseconds to send a keep-alive message.

If zero is specified, any keep-alive message must not be sent.

Use ServerAliveCountMax parameter to specify the number of keep-alive messages which may be sent without receiving any messages back from the server.

Possible values:

• <n> - duration in milliseconds, e.g.: 60000
• <n>s - duration in seconds, e.g.: 30s
• <n>m - duration in minutes, e.g.: 30m
• <n>h - duration in hours, e.g.: 24h

Combined values (with blank as separator):

• e.g.: 1h 30m

• Schema: ServerAliveCountMax
• Mapping:
  • server_alive_count_max
• Release:
  • YADE-527 Availability starting with 1.12.6.

Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.

If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected.

• Schema: ConnectTimeout
• Mapping:
  • connect_timeout
• Release:
  • YADE-555 Availability starting with 1.12.13, 1.13.4.

This value is used as the socket timeout parameter, and also as the default connection timeout.

A value of 0 (the default value) indicates no timeout.

Possible values:

• <n>s - duration in seconds, e.g.: 30s
• <n>m - duration in minutes, e.g.: 1m

Combined values (with blank as separator):

• e.g.: 1m 30s

• Schema: ChannelConnectTimeout
• Mapping:
  • channel_connect_timeout
• Release:
  • YADE-555 Availability starting with 1.12.13, 1.13.4.

The maximum time to wait for the channel to be established.

If 0, we wait as long as needed (but at most 2000 times 10 milliseconds each).

Possible values:

• <n>s - duration in seconds, e.g.: 30s
• <n>m - duration in minutes, e.g.: 1m

Combined values (with blank as separator):

• e.g.: 1m 30s