Skip to end of metadata
Go to start of metadata

Diagram

Elements

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

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 based on their name.

A fragment is referenced via this attribute value by a transfer profile.

BasicConnection [BasicConnectionType]
  • Occurrence: 1
Required
References Notes

A connection specifies parameters for a Hostname and a Port to which a connection is established.

SSHAuthentication [SSHAuthenticationType]
  • Occurrence: 1
Required
References 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
  • AuthenticationMethodKeyboardInteractive for authentication.
SSHAuthenticationType / PreferredAuthentications string
  • Whitespace: preserve
  • Enumeration:
    • password,publickey
    • publickey,password
  • Occurrence: 0..1
Optional
References 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).

SSHAuthenticationType / RequiredAuthentications string
  • Whitespace: preserve
  • Enumeration:
    • password,publickey
    • publickey,password
  • Occurrence: 0..1
Optional
References Notes

Specifies the authentication methods that must be successfully completed for a user to be granted access.

See SSH configuration:

  • AuthenticationMethods
  • RequiredAuthentications2
SSHAuthenticationType / AuthenticationMethodKeyboardInteractive
  • Occurrence: 0..1
Optional
References 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.
JumpCommand string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

This command is used to invoke the YADE Client on a jump host that is used to store files intermediately during file transfer between source and target host.

The command includes the full path to your YADE Client installation on the jump host and ends with the file name YADE.sh (Unix) or YADE.cmd (Windows).

JumpCommandBeforeFile string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Specifies the commands to be executed for each file on the jump server before transfer of files.

JumpCommandAfterFileOnSuccess string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Specifies the commands to be executed for each file on the jump server after the transfer.

JumpCommandBeforeOperation string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Commands to be executed before the transfer of files starts on the jump server.

JumpCommandAfterOperationOnSuccess string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Post transfer commands execution in case of the successful transfers.

JumpCommandAfterOperationOnError string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Post transfer commands execution on transfer error.

JumpCommandAfterOperationFinal string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

Post transfer commands execution at transfer end independent of the transfer status.

JumpCommandDelimiter
  • Occurrence: 0..1
Optional
References Notes

A command delimiter option for executing the jump pre- and postcommands:

  • JumpCommandBeforeFile
  • JumpCommandAfterFileOnSuccess
  • JumpCommandBeforeOperation
  • JumpCommandAfterOperationOnSuccess
  • JumpCommandAfterOperationOnError
  • JumpCommandAfterOperationFinal
JumpDirectory string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

This directory on the jump host is used to store files intermediately during file transfer between source and target host.

The files in this directory are removed at the end of the transfer operation.

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.

ProxyForSFTP
  • Occurrence: 0..1
Optional

ProxyForSFTP - will use the HTTP, SOCKS4 or SOCKS5 proxy

HTTPProxy [AuthenticatedProxyType]
  • Occurrence: 1
Required
References Notes

Proxies can make use of different protocols, a HTTPProxy - as the name suggests - will use the HTTP protocol

HTTP proxies optionally support authentication.

SOCKS4Proxy [UnauthenticatedProxyType]
  • Occurrence: 1
Required
References Notes

Proxies can make use of different protocols, a SOCKS4Proxy - as the name suggests - will use the SOCKS4 protocol

SOCKS4 proxies do not support authentication.

SOCKS5Proxy [AuthenticatedProxyType]
  • Occurrence: 1
Required
References Notes

Proxies can make use of different protocols, a SOCKS5Proxy - as the name suggests - will use the SOCKS5 protocol

SOCKS5 proxies optionally support authentication.

StrictHostkeyChecking boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies the behavior for hosts that have not previously been involved in a file transfer.

  • By default it is not necessary that the user "known hosts" files contain the host key which corresponds to the value "false".
  • If this parameter is set to "true", the host key is expected in the user "known hosts" files and YADE will refuse to connect to hosts whose host key cannot be found. This setting forces the user to manually add new hosts to the "known hosts" files.
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.

ConfigurationFilesType / ConfigurationFile string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

An application configuration file contains settings that are specific to an app.

ServerAliveInterval string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

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:

  • <n> - duration in milliseconds, e.g.: 60000
  • <n>s - duration in seconds, e.g.: 30s
  • <n>m - duration in minutes, e.g.: 30m
  • <n>h - duration in hours, e.g.: 24h

Combined values (with blank as separator):

  • e.g.: 1h 30m
ServerAliveCountMax int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

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.

  • No labels
Write a comment…