Product Knowledge Base

Space shortcuts

Page tree

Diagram

Elements

SMBAuthentication
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.

Element Type Required Description
Account string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

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

  • 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
Domain string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Domain for authentication at one of the systems involved in file transfer, e.g. an SMB server.

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
Password string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

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

  • 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