YADE Parameter Reference - ProtocolFragments

Diagram

Elements

ProtocolFragments
References Schema: ProtocolFragments, ProtocolFragments Notes Fragments are a means to organize file transfer settings in a reusable way: Fragments are created to define settings that are specific for a file transfer protocol, e.g. FTP, SFTP, WebDAV. File transfer protocols include settings for e.g. FTP BasicAuthentication, BasicConnection. Such fragments do not include settings for an individual file transfer, e.g. the file Selection, as such settings are used in a Profile that specifies parameters for a file transfer Operation. Each Profile references a fragment for the source and optionally for the target of a file transfer operation. Therefore multiple profiles can use the same connection that is specified in a fragment. Any number of fragments can be configured. They are distinguished by their name attribute. References to a fragment use the value of the name attribute to identify the respective fragment.
Element	Type	Required	Description
FTPFragment	Occurrence: 0..unbounded	Optional	References Schema: FTPFragment, FTPFragment Mapping: protocol Notes 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. name 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.
FTPSFragment	Occurrence: 0..unbounded	Optional	References Schema: FTPSFragment, FTPSFragment Mapping: protocol Notes This element includes the parameters for an FTPS 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. A fragment is referenced by a transfer profile using the value of the FTPSFragmentRef ref attribute. name 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.
HTTPFragment	Occurrence: 0..unbounded	Optional	References Schema: HTTPFragment, HTTPFragment Mapping: protocol Notes This element includes the parameters for an HTTP file transfer connection including BasicAuthentication and URLConnection 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 HTTPFragmentRef ref attribute. name 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.
HTTPSFragment	Occurrence: 0..unbounded	Optional	References Schema: HTTPSFragment, HTTPSFragment Mapping: protocol Notes This element includes the parameters for an HTTPS file transfer connection including BasicAuthentication and URLConnection 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 HTTPSFragmentRef ref attribute. name 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.
JumpFragment	Occurrence: 0..unbounded	Optional	References Schema: JumpFragment, JumpFragment Notes A jump host is an intermediate server that is used for file transfers when the YADE Client cannot connect directly to a target server, e.g. if such connections are exclusively available in a DMZ. In such cases the YADE Client can be installed on a server in the DMZ that is used as a jump host. The YADE Client would in a first step transfer files between the source server and the jump host and in a second step execute the YADE Client on the jump host to perform the transfer to the target host. This element includes the parameters for an jump host file transfer connection including SSHAuthentication and BasicConnection 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 JumpFragmentRef ref attribute. name 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.
SFTPFragment	Occurrence: 0..unbounded	Optional	References Schema: SFTPFragment, SFTPFragment Mapping: protocol Notes 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. name 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.
SMBFragment	Occurrence: 0..unbounded	Optional	References Schema: SMBFragment, SMBFragment Mapping: protocol Notes This element includes the parameters for an SMB file transfer connection including SMBAuthentication and Hostname 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 SMBFragmentRef ref attribute. name 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.
WebDAVFragment	Occurrence: 0..unbounded	Optional	References Schema: WebDAVFragment, WebDAVFragment Mapping: protocol Notes This element includes the parameters for a WebDAV file transfer connection including BasicAuthentication and URLConnection 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 WebDAVFragmentRef ref attribute. name 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.

Explanations

The ProtocolFragments include the parameter specifying the protocol to be used for the transfer and protocol-specific parameters such as authentication and URL.

ProtocolFragments are specified for the transfer source, for the transfer target and optionally for use with a jump host or with AlternativeFragments.

Space shortcuts

Page tree

Explanations