FetchSmb

Description:

Fetches files from a SMB Share. Designed to be used in tandem with ListSmb.

Tags:

samba, smb, cifs, files, fetch

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SMB Client Provider Servicesmb-client-provider-serviceController Service API:
SmbClientProviderService
Implementation: SmbjClientProviderService		Specifies the SMB client provider to use for creating SMB connections.
Remote Fileremote-file${path}/${filename}The full path of the file to be retrieved from the remote server. Expression language is supported.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Completion StrategyCompletion StrategyNone
  • None Leaves the file as-is.
  • Move File Moves the file to the specified directory on the remote system. This option cannot be used when DFS is enabled on 'SMB Client Provider Service'.
  • Delete File Deletes the file from the remote system.
Specifies what to do with the original file on the server once it has been processed. If the Completion Strategy fails, a warning will be logged but the data will still be transferred.
Destination DirectoryDestination DirectoryThe directory on the remote server to move the original file to once it has been processed.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the [Completion Strategy] Property has a value of "Move File".
Create Destination DirectoryCreate Destination Directoryfalse
  • true
  • false
Specifies whether or not the remote directory should be created if it does not exist.

This Property is only considered if the [Completion Strategy] Property has a value of "Move File".

Relationships:

NameDescription
successA FlowFile will be routed here for each successfully fetched file.
failureA FlowFile will be routed here when failed to fetch its content.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
error.codeThe error code returned by SMB when the fetch of a file fails.
error.messageThe error message returned by SMB when the fetch of a file fails.

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:

ListSmb, PutSmbFile, GetSmbFile