Diagram
This element includes the parameters for an SFTP file transfer connection including BasicConnection and SSHAuthentication configuration items. Any number of fragments can be configured and are distinguished by YADE according to their name attribute. A fragment is referenced by a transfer profile using the value of the SFTPFragmentRef ref attribute. 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. 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. 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 SSHAuthentication element specifies the credentials for authentication with a server, e.g. an FTP Server or a Proxy. Child elements include: 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 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). Specifies the authentication methods that must be successfully completed for a user to be granted access. See SSH configuration: The use of this element specifies that for SSHAuthentication an authentication method using a Password will be applied. As an alternative to using passwords the authentication methods: 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 The use of this element specifies that for SSHAuthentication an authentication method for public/private keys using an AuthenticationFile will be applied. This is called public/private key authentication and helps to avoid the use of passwords for authentication. As an alternative to public/private key authentication the authentication methods: The value of this parameter specifies the path and name of an account's private key file used for SSHAuthentication. This parameter must be specified if the authentication method AuthenticationMethodPublickey is used. Should the private key file be secured by a passphrase then this must be specified using the Passphrase parameter. Authentication files are most often stored in the user home directory in a .ssh folder and have to be secured with the proper file permissions. However, any path can be specified for an authentication file with this parameter. The location of the authentication file has to be accessbible for the account that runs the YADE Client. For Unix systems file permissions 600 are required for authentication files. 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 A passphrase secures an AuthenticationFile that is used for SSHAuthentication. The passphrase is added when creating the private key authentication file. Passphrases are not displayed in the YADE log files. As a drawback passphrases are visible in YADE configuration files if not protected as secure strings, e.g. from a CredentialStore. 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 use of this element specifies that for SSHAuthentication an authentication method for public/private keys using an AuthenticationFile will be applied. This is called public/private key authentication and helps to avoid the use of passwords for authentication. As an alternative to public/private key authentication the authentication methods: The value of this parameter specifies the path and name of an account's private key file used for SSHAuthentication. This parameter must be specified if the authentication method AuthenticationMethodPublickey is used. Should the private key file be secured by a passphrase then this must be specified using the Passphrase parameter. Authentication files are most often stored in the user home directory in a .ssh folder and have to be secured with the proper file permissions. However, any path can be specified for an authentication file with this parameter. The location of the authentication file has to be accessbible for the account that runs the YADE Client. For Unix systems file permissions 600 are required for authentication files. 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 A passphrase secures an AuthenticationFile that is used for SSHAuthentication. The passphrase is added when creating the private key authentication file. Passphrases are not displayed in the YADE log files. As a drawback passphrases are visible in YADE configuration files if not protected as secure strings, e.g. from a CredentialStore. 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 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: 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. ProxyForSFTP - will use the HTTP, SOCKS4 or SOCKS5 proxy A connection specifies parameters for a Hostname and a Port to which a connection is established. 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. Proxies can make use of different protocols, a SOCKS4Proxy - as the name suggests - will use the SOCKS4 protocol SOCKS4 proxies do not support authentication. A connection specifies parameters for a Hostname and a Port to which a connection is established. Proxies can make use of different protocols, a SOCKS5Proxy - as the name suggests - will use the SOCKS5 protocol SOCKS5 proxies optionally support authentication. A connection specifies parameters for a Hostname and a Port to which a connection is established. 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. This parameter specifies the behavior for hosts that have not previously been involved in a file transfer. An application configuration file contains settings that are specific to an app. YADE allows to specify configuration files individually per transfer fragment. An application configuration file contains settings that are specific to an app. 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: Combined values (with blank as separator): 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. 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): 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: Combined values (with blank as separator):
SFTPFragment
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
SSHAuthentication
[SSHAuthenticationType]
Required
Notes
SSHAuthenticationType / Account
string
Required
or the custom fields.
SSHAuthenticationType / PreferredAuthentications
string
Optional
Notes
SSHAuthenticationType / RequiredAuthentications
string
Optional
Notes
SSHAuthenticationType / AuthenticationMethodPassword
Required
Notes
can be used.
Password
string
Required
or the custom fields.
SSHAuthenticationType / AuthenticationMethodPublickey
Optional
Notes
can be used.
AuthenticationFile
string
Required
Notes
or the custom fields.
Passphrase
string
Optional
Notes
or the custom fields.
SSHAuthenticationType / AuthenticationMethodPublickey
Required
Notes
can be used.
AuthenticationFile
string
Required
Notes
or the custom fields.
Passphrase
string
Optional
Notes
or the custom fields.
SSHAuthenticationType / AuthenticationMethodKeyboardInteractive
Optional
Notes
can be used.
CredentialStoreFragmentRef
Optional
JumpFragmentRef
Optional
Notes
ProxyForSFTP
Optional
HTTPProxy
[AuthenticatedProxyType]
Required
AuthenticatedProxyType / BasicConnection
[BasicConnectionType]
Required
Notes
AuthenticatedProxyType / BasicAuthentication
[BasicAuthenticationType]
Optional
Notes
SOCKS4Proxy
[UnauthenticatedProxyType]
Required
Notes
UnauthenticatedProxyType / BasicConnection
[BasicConnectionType]
Required
Notes
SOCKS5Proxy
[AuthenticatedProxyType]
Required
Notes
AuthenticatedProxyType / BasicConnection
[BasicConnectionType]
Required
Notes
AuthenticatedProxyType / BasicAuthentication
[BasicAuthenticationType]
Optional
Notes
StrictHostkeyChecking
boolean
Optional
Notes
ConfigurationFiles
[ConfigurationFilesType]
Optional
Notes
ConfigurationFilesType / ConfigurationFile
string
Required
Notes
ServerAliveInterval
string
Optional
Notes
ServerAliveCountMax
int
Optional
Notes
ConnectTimeout
string
Optional
Notes
ChannelConnectTimeout
string
Optional
Notes
References
References
References Notes
References
References Notes
References
References
References
References Notes
References
References
References
References
References
References
References
References Notes
References
References
References
References
References
References
References
References
References
References
References
References
References
References
References
Overview
Content Tools