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. The SSHAuthentication element specifies the credentials for authentication with a server, e.g. an FTP Server or a Proxy. Child elements include: 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 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. 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
SSHAuthentication
[SSHAuthenticationType]
Required
Notes
CredentialStoreFragmentRef
Optional
JumpFragmentRef
Optional
Notes
ProxyForSFTP
Optional
StrictHostkeyChecking
boolean
Optional
Notes
ConfigurationFiles
[ConfigurationFilesType]
Optional
Notes
ServerAliveInterval
string
Optional
Notes
ServerAliveCountMax
int
Optional
Notes
ConnectTimeout
string
Optional
Notes
ChannelConnectTimeout
string
Optional
Notes
References
References
References
References Notes
References
References
References
References
References
References
References
Overview
Content Tools