Diagram
This element includes the parameters for an FTP file transfer connection including BasicAuthentication and BasicConnection configuration items. Any number of fragments can be configured and are distinguished by YADE according to their name attribute. Therefore a unique identifier should be specified for the name attribute. A fragment is referenced by a transfer Profile using the value of the FTPFragmentRef and its ref attribute. This attribute identifies the current fragment. Any number of fragments can be used and are distinguished by YADE based on their name. A fragment is referenced via this attribute value by a transfer profile. This attribute identifies the current fragment. Any number of fragments can be used and are distinguished by YADE based on their name. A fragment is referenced via this attribute value by a transfer profile. A connection specifies parameters for a Hostname and a Port to which a connection is established. This parameter specifies the hostname (e.g. foo.org) or IP address (e.g. IPv4 192.168.0.1) of the (FTP, SFTP, SSH, etc.) server to which a connection has to be made. Support for KeePass versions 1 and 2. Note: Availability starting with YADE-464. Referencing CredentialStore fields. Note: Availability starting with YADE-481. Referencing a field in the CredentialStore is effected by the following syntax: cs://[entry_path]@entry_field where <Hostname> element: Examples The BasicAuthentication element specifies the credentials for authentication with a server, e.g. using an FTP protocol or a Proxy Protocol. Child elements include: 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. Account for authentication at one of the systems involved in file transfer, e.g. an FTP or SFTP server. Usually the account corresponds to a user name. Should the respective server system be part of a Windows domain then the syntax domain\account can be used. Support for KeePass versions 1 and 2. Note: Availability starting with YADE-464. Referencing CredentialStore fields. Note: Availability starting with YADE-481. Referencing a field in the CredentialStore is effected by the following syntax: cs://[entry_path]@entry_field where <Hostname> element: Examples Password for authentication at a server that is involved in file transfer, e.g. with an FTP or SFTP protocol or Proxy protocol that makes use of BasicAuthentication. Passwords are not displayed in the YADE log files. A drawback is that passwords are visible in YADE configuration files. In order to avoid this you could switch to using File Transfer Protocols that allow SSHAuthentication, e.g. SFTP. Support for KeePass versions 1 and 2. Note: Availability starting with YADE-464. Referencing CredentialStore fields. Note: Availability starting with YADE-481. Referencing a field in the CredentialStore is effected by the following syntax: cs://[entry_path]@entry_field where <Hostname> element: Examples 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. This attribute identifies the fragment that is used for inserting secure configuration items. 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. This attribute identifies the fragment that is used for a jump host. Passive mode is often required for FTP transfers with firewalls. Transfer mode is used only for FTP and can be either ascii or binary. ProxyForFTP - will use the HTTP, SOCKS4 or SOCKS5 proxy Proxies can make use of different protocols, a SOCKS4Proxy - as the name suggests - will use the SOCKS4 protocol SOCKS4 proxies do not support authentication. Proxies can make use of different protocols, a SOCKS5Proxy - as the name suggests - will use the SOCKS5 protocol SOCKS5 proxies optionally support authentication. 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: Combined values (with blank as separator):
FTPFragment
Notes
Element
Type
Required
Description
Attribute: name
NMTOKEN
Required
BasicConnection
[BasicConnectionType]
Required
Notes
BasicConnectionType / Hostname
string
Required
or the custom fields.
BasicConnectionType / Port
int
Optional
BasicAuthentication
[BasicAuthenticationType]
Required
Notes
BasicAuthenticationType / Account
string
Required
or the custom fields.
BasicAuthenticationType / Password
string
Optional
or the custom fields.
CredentialStoreFragmentRef
Optional
JumpFragmentRef
Optional
Notes
PassiveMode
boolean
Optional
Notes
TransferMode
string
Optional
Notes
ProxyForFTP
Optional
HTTPProxy
[AuthenticatedProxyType]
Required
SOCKS4Proxy
[UnauthenticatedProxyType]
Required
Notes
SOCKS5Proxy
[AuthenticatedProxyType]
Required
Notes
ConnectTimeout
string
Optional
Notes
- Host : TBD