YADE Parameter Reference - SSHAuthentication

Diagram

Elements

SSHAuthentication - SSHAuthenticationType
References Schema: SSHAuthentication, SSHAuthentication Notes 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. For Windows Systems an account could include the domain. PreferredAuthentications. Specifies the order in which the client should try protocol 2 authentication methods. RequiredAuthentications. Specifies the authentication methods that must be successfully completed for a user to be granted access. AuthenticationMethodPassword for authentication. Password Passwords are not displayed in the YADE log files. AuthenticationMethodPublicKey for authentication. Public/private key authentiction with an AuthenticationFile Passphrase AuthenticationMethodKeyboardInteractive for authentication.
Element	Type	Required	Description
Account	string Min: 1 Whitespace: preserve Occurrence: 1	Required	References Schema: Account Mapping: user 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
PreferredAuthentications	string Whitespace: preserve Enumeration: password,publickey publickey,password Occurrence: 0..1	Optional	References Schema: PreferredAuthentications Mapping: preferred_authentications Release: YADE-462 Availability starting with 1.12.1. Notes 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).
RequiredAuthentications	string Whitespace: preserve Enumeration: password,publickey publickey,password Occurrence: 0..1	Optional	References Schema: RequiredAuthentications Mapping: required_authentications Release: YADE-462 Availability starting with 1.12.1. Notes Specifies the authentication methods that must be successfully completed for a user to be granted access. See SSH configuration: AuthenticationMethods RequiredAuthentications2
AuthenticationMethodPassword	Occurrence: 1	Required	References Schema: AuthenticationMethodPassword Mapping: ssh_auth_method Notes 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: AuthenticationMethodPublickey AuthenticationMethodKeyboardInteractive can be used.
Password	string Min: 1 Whitespace: preserve Occurrence: 1	Required	References Schema: Password Mapping: password 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
AuthenticationMethodPublickey	Occurrence: 0..1	Optional	References Schema: AuthenticationMethodPublickey Mapping: ssh_auth_method Notes 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: AuthenticationMethodPassword AuthenticationMethodKeyboardInteractive can be used.
AuthenticationFile	string Min: 1 Whitespace: preserve Occurrence: 1	Required	References Schema: AuthenticationFile, AuthenticationFile Mapping: ssh_auth_file Notes 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 *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
Passphrase	string Min: 1 Whitespace: preserve Occurrence: 0..1	Optional	References Schema: Passphrase Mapping: passphrase Release: YADE-485 Availability starting with 1.12.1. Notes 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 *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
AuthenticationMethodPublickey	Occurrence: 1	Required	References Schema: AuthenticationMethodPublickey Mapping: ssh_auth_method Notes 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: AuthenticationMethodPassword AuthenticationMethodKeyboardInteractive can be used.
AuthenticationFile	string Min: 1 Whitespace: preserve Occurrence: 1	Required	References Schema: AuthenticationFile, AuthenticationFile Mapping: ssh_auth_file Notes 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 *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
Passphrase	string Min: 1 Whitespace: preserve Occurrence: 0..1	Optional	References Schema: Passphrase Mapping: passphrase Release: YADE-485 Availability starting with 1.12.1. Notes 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 *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
AuthenticationMethodKeyboardInteractive	Occurrence: 0..1	Optional	References Schema: AuthenticationMethodKeyboardInteractive Mapping: ssh_auth_method Release: YADE-495 Availability starting with 1.12.2. Notes 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: AuthenticationMethodPassword AuthenticationMethodPublickey can be used.

Space shortcuts

Page tree