FetchSFTP

Description:

Fetches the content of a file from a remote SFTP server and overwrites the contents of an incoming FlowFile with the content of the remote file.

Tags:

sftp, get, retrieve, files, fetch, remote, ingest, source, input

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
HostnameThe fully-qualified hostname or IP address of the host to fetch the data from
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Port22The port to connect to on the remote host to fetch the data from
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
UsernameUsername
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
PasswordPassword for the user account
Sensitive Property: true
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Private Key PathThe fully qualified path to the Private Key file
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Private Key PassphrasePassword for the private key
Sensitive Property: true
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Remote FileThe fully qualified filename on the remote system
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Completion StrategyNone
  • None Leave the file as-is
  • Move File Move the file to the directory specified by the <Move Destination Directory> property
  • Delete File Deletes the original file from the remote system
Specifies what to do with the original file on the server once it has been pulled into NiFi. If the Completion Strategy fails, a warning will be logged but the data will still be transferred.
Move Destination DirectoryThe directory on the remote server to move the original file to once it has been ingested into NiFi. This property is ignored unless the Completion Strategy is set to 'Move File'. The specified directory must already exist on the remote system if 'Create Directory' is disabled, or the rename will fail.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Create Directoryfalse
  • true
  • false
Used when 'Completion Strategy' is 'Move File'. Specifies whether or not the remote directory should be created if it does not exist.
Disable Directory Listingfalse
  • true
  • false
Control how 'Move Destination Directory' is created when 'Completion Strategy' is 'Move File' and 'Create Directory' is enabled. If set to 'true', directory listing is not performed prior to create missing directories. By default, this processor executes a directory listing command to see target directory existence before creating missing directories. However, there are situations that you might need to disable the directory listing such as the following. Directory listing might fail with some permission setups (e.g. chmod 100) on a directory. Also, if any other SFTP client created the directory after this processor performed a listing and before a directory creation request by this processor is finished, then an error is returned because the directory already exists.
Connection Timeout30 secAmount of time to wait before timing out while creating a connection
Data Timeout30 secWhen transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems
Send Keep Alive On Timeouttrue
  • true
  • false
Indicates whether or not to send a single Keep Alive message when SSH socket times out
Host Key FileIf supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used
Strict Host Key Checkingfalse
  • true
  • false
Indicates whether or not strict enforcement of hosts keys should be applied
Use Compressionfalse
  • true
  • false
Indicates whether or not ZLIB compression should be used when transferring files
Proxy Configuration ServiceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: SOCKS + AuthN, HTTP + AuthN
Proxy TypeDIRECT
  • DIRECT
  • HTTP
  • SOCKS
Proxy type used for file transfers
Proxy HostThe fully qualified hostname or IP address of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy PortThe port of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy UsernameHttp Proxy Username
Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy PasswordHttp Proxy Password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

NameDescription
successAll FlowFiles that are received are routed to success
comms.failureAny FlowFile that could not be fetched from the remote server due to a communications failure will be transferred to this Relationship.
not.foundAny FlowFile for which we receive a 'Not Found' message from the remote server will be transferred to this Relationship.
permission.deniedAny FlowFile that could not be fetched from the remote server due to insufficient permissions will be transferred to this Relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
sftp.remote.hostThe hostname or IP address from which the file was pulled
sftp.remote.portThe port that was used to communicate with the remote SFTP server
sftp.remote.filenameThe name of the remote file that was pulled
filenameThe filename is updated to point to the filename fo the remote file
pathIf the Remote File contains a directory name, that directory name will be added to the FlowFile using the 'path' attribute

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

GetSFTP, PutSFTP, GetFTP, PutFTP