Skip to end of metadata
Go to start of metadata

Diagram

Elements

SMBFragment
References 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.

Element Type Required Description
Attribute: name NMTOKEN
Required

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.

Hostname string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

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

  • cs://         is a constant prefix that is used by YADE to identify this setting to be a reference to a CredentialStore.
  • entry_path      specifies the path to an entry within the CredentialStore database. Folders (groups) within a path are separated by a slash "/". This setting is optional. If ommitted then the value of the CSEntryPath configuration item is used.
  • entry_field          is one of the standard fields available in a CredentialStore:
    • title
    • user
    • password
    • url
    • notes
    • attachment
    or the custom fields.

<Hostname> element:

  • Usage like the examples below.
  • If the entry field value is defined with host:port, YADE sets the <Hostname> and <Port> automatically.

Examples

  • Examples for fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://sos/mft_server/srv001@title
      • cs://sos/mft_server/srv001@user
      • cs://sos/mft_server/srv001@password
      • cs://sos/mft_server/srv001@url
      • cs://sos/mft_server/srv001@notes
      • cs://sos/mft_server/srv001@my_custom_field
    • <AuthenticationFile> element:
      • cs://sos/mft_server/srv001@attachment - the first attachment
      • cs://sos/mft_server/srv001@my_custom_field - a specified attachment
  • Examples without fully specified entry path:
    • <Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
      • cs://@title
      • cs://@user
      • cs://@password
      • cs://@url
      • cs://@notes
      • cs://@my_custom_field
    • <AuthenticationFile> element:
      • cs://@attachment - the first attachment
      • cs://@my_custom_field - a specified attachment

SMBAuthentication
  • Occurrence: 1
Required
References Notes

The SMBAuthentication element specifies the credentials for authentication with a file system by SMB also known as CIFS. Windows operating systems include SMB support, for Unix operating systems SMB is optionally available.

CredentialStoreFragmentRef
  • Occurrence: 0..1
Optional
References Notes

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.

ref

This attribute identifies the fragment that is used for inserting secure configuration items.

ConfigurationFiles [ConfigurationFilesType]
  • Occurrence: 0..1
Optional
References Notes

An application configuration file contains settings that are specific to an app. YADE allows to specify configuration files individually per transfer fragment.

  • No labels