| Info |
|---|
The SFTP Copy action plugin is available in the Hub. |
Plugin version: 1.5.1
SFTP copy allows copying of the files from the specified directory on SFTP servers and write them to HDFS as the destination. The files that are copied can be optionally uncompressed before storing. The files are copied directly to HDFS without needing any additional staging area.
...
Property | Macro Enabled? | Description | |||
|---|---|---|---|---|---|
Host | Yes | Required. Host name of the SFTP server. | |||
Port | Yes | Optional. Port on which SFTP server is running. Default is 22. | |||
User Name | Yes | Required. Name of the user which will be used to connect to the SFTP server. | |||
Authentication | Yes | Required. Specifies the type of Authentication that will be used to connect to the SFTP Server. Default is PrivateKey. | |||
Private Key | Yes | Optional. Private RSA Key to be used to connect to the SFTP Server. This key is recommended to be stored in the Secure Key Store, and macro called into the Configuration. Must be a RSA key starting with —–BEGIN RSA PRIVATE KEY—– | |||
Private Key Passphrase | Yes | Optional. Passphrase to be used with RSA Private Key if a Passphrase was specified when key was generated. | |||
Password | Yes | Required. Password of the user. | |||
Source directory | Yes | Required. Absolute path of the directory on the SFTP server which is to be copied. If the directory is empty, the execution of the plugin will be no-op. | |||
Destination directory | Yes | Required. Destination directory on the file system, where files need to be copied. If directory does not exist, it will be created. | Uncompress | No | Optional. Boolean flag to determine whether to uncompress the Default is true. |
Variable name to hold list of copied file names | No | Optional. Name of the variable which holds comma separated list of file names on the SFTP server which were copied during this run of the plugin. Usually this variable is used as Macro in the SFTP Delete action to delete the files from SFTP server once their processing is successful. Default is sftp.copied.file.names. | |||
Regex to match files that needs to be copied | Yes | Optional. Regex to choose only the files that are of interest. All files will be copied by default. Default is * | |||
Properties for SSH | No | Optional. Specifies the properties that are used to configure SSH connection to the FTP server. For example to enable verbose logging add property 'LogLevel' with value 'VERBOSE'. To enable host key checking set 'StrictHostKeyChecking' to 'yes'. SSH can be configured with the properties described here 'https://linux.die.net/man/5/ssh_config'. | |||
Properties for File System | No | Optional. Specifies the properties that are used to configure Destination File system for example: HDFS, ADLS | |||
Extract Zip Files | No | Optional. Boolean flag to determine whether zip files on the FTP server need to be extracted on the destination while copying. Default is False. |
...