YADE Parameter Reference - FTPSFragment

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: BasicAuthentication, BasicAuthentication

The BasicAuthentication element specifies the credentials for authentication with a server, e.g. using an FTP protocol or a Proxy Protocol. Child elements include:

• Account for authentication. For Windows Systems an account could include the domain.
• Password for authentication. Passwords are not displayed in the YADE log files.

BasicAuthentication is available for a number of File Transfer Protocols and Proxy Protocols. The drawback with BasicAuthentication is that passwords are stored directly in configuration files. In order to avoid this you could switch to using File Transfer Protocols that allow SSHAuthentication, e.g. SFTP.

• Schema: FTPSClientSecurity, FTPSClientSecurity

The type of FTPS client security (explicit, implicit).

• Schema: SecurityMode
• Mapping:
  • ftps_client_security

This parameter specifies the security mode. Possible values: explicit, implicit

• Schema: KeyStoreType
• Mapping:
  • keystore_type

This parameter specifies the keystore type. Possible values: JKS,JCEKS,PKCS12,PKCS11,DKS

• Schema: KeyStoreFile
• Mapping:
  • keystore_file

This parameter specifies the keystore file.

• Schema: KeyStorePassword
• Mapping:
  • keystore_password

This parameter specifies the password of a keystore.

• Schema: FTPSProtocol, FTPSProtocol
• Mapping:
  • ftps_protocol

The FTPS protocol type, e.g. SSL, TLS. It should be considered that depending on the protocol type usually a different Port parameter has to be specified. For SSL/TLS use of port 990 is quite common.

• 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.

ProxyForFTPS - 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: 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