Introduction
The main features of SSH authenticated file transfer in JADE are:
- SSH authentication can be carried out with an account name and either a password or a public key.
- SSH authentication requires that SFTP protocol is used.
- SSH authentication is required when a jump host transfer is carried out.
As with all file transfer protocols, any number of SFTP file transfer configurations in the form of ProtocolFragments can be pre-configured and selected as required.
Features of SSH Authenticated File Transfer
Authentication
SSH authentication can be carried out with an account name and either a password or a public/private key verification.
If public/private key verification is used, the SSH password parameter can be used to provide additional protection for the authentication file.
File Transfer Protocol
SSH Authentication requires that the SFTP protocol is used for the transfer operation.
Configuration of SSH Authenticated File Transfer DUPLICATE OF BASIC AUTHENTICATION
The configuration described in this example is held as simple as possible. More complex file transfer scenarios will be described later.
Procedure Overview
The configuration procedure involves 3 steps:
- Configuration of the Fragments - i.e. the protocol, connection and authentication methods to be used for the source and target parts of the operation.
- Configuration of the Profile - i.e. the operation to be carried out (e.g. copy or move), the fragments to be used for the source and target parts of the transfer and any specific directories that are to be used.
- Note that the Profile can also be used to specify other elements such as any notifications to be made or preprocessing that is to be carried out. These will be described later on.
- Calling the Configuration and Profile from the command line, a batch file or via the JADE API.
Operations around SFTP file transfer
JADE can carry out the following operations in conjunction with SFTP file transfer:
- pre- and post-processing operations, both for the source part of the transfer (i.e. pickup) and the target part (i.e. put down)
- file renaming
- zlib file compression
As children of the SFTPFragmentRef element, the parameters used for the configuration of these operations are described in detail on the page. However, the use of these operations is described in the Pre- & Post-Processing article.
Additional transfer features
JADE can also carry out:
Specification of SFTP File Transfer Elements
The key element in the JADE XML schema for the specification of a file transfer by FTP is the SFTPFragmentRef element. This element is part of the Profiles branch of the schema and a direct descendant of operation source or target elements such as CopySource or MoveTarget. The SFTPFragmentRef element can be specified for the source and/or target parts of the operation.
The SFTPFragmentRef element itself contains a reference to the SFTPFragment to be used for this part of the transfer. SFTPFragment elements are specified in the Fragments branch of the schema and may not be specific to the current transfer operation.
Note that the SFTPFragment reference, which is specified as a name attribute of the SFTPFragmentRef element, is not shown in the XSD schema hierarchy diagram below.
In addition, as shown in the first diagram below, the SFTPFragmentRef element has four child elements that are optional but define aspects of the operation that are SFTP-specific: SFTPPreProcessing, SFTPPostProcessing Rename and ZlibCompression. These elements are described in detail as part of the SFTPFragmentRef below.
The SFTPFragmentRef Element
Further Information
Pages
Navigation