GetSmbFile

Description:

Reads file from a samba network location to FlowFiles. Use this processor instead of a cifs mounts if share access control is important. Configure the Hostname, Share and Directory accordingly: \\[Hostname]\[Share]\[path\to\Directory]

Tags:

samba, smb, cifs, files, get

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
HostnameHostnameThe network host to which files should be written.
ShareShareThe network share to which files should be written. This is the "first folder"after the hostname: \\hostname\[share]\dir1\dir2
DirectoryDirectoryThe network folder to which files should be written. This is the remaining relative path after the share: \\hostname\share\[dir1\dir2].
Supports Expression Language: true (will be evaluated using variable registry only)
DomainDomainThe domain used for authentication. Optional, in most cases username and password is sufficient.
UsernameUsernameThe username used for authentication. If no username is set then anonymous authentication is attempted.
PasswordPasswordThe password used for authentication. Required if Username is set.
Sensitive Property: true
Share Access StrategyShare Access Strategynone
  • none
  • read
  • read, delete
  • read, write, delete
Indicates which shared access are granted on the file during the read. None is the most restrictive, but the safest setting to prevent corruption.
File FilterFile FilterOnly files whose names match the given regular expression will be picked up
Path FilterPath FilterWhen Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned
Batch SizeBatch Size10The maximum number of files to pull in each iteration
Keep Source FileKeep Source Filefalse
  • true
  • false
If true, the file is not deleted after it has been copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.
Recurse SubdirectoriesRecurse Subdirectoriestrue
  • true
  • false
Indicates whether or not to pull files from subdirectories
Polling IntervalPolling Interval0 secIndicates how long to wait before performing a directory listing
Ignore Hidden FilesIgnore Hidden Filestrue
  • true
  • false
Indicates whether or not hidden files should be ignored

Relationships:

NameDescription
successAll files are routed to success

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
filenameThe filename is set to the name of the file on the network share
pathThe path is set to the relative path of the file's network share name. For example, if the input is set to \\hostname\share\tmp, files picked up from \tmp will have the path attribute set to tmp
file.creationTimeThe date and time that the file was created. May not work on all file systems
file.lastModifiedTimeThe date and time that the file was last modified. May not work on all file systems
file.lastAccessTimeThe date and time that the file was last accessed. May not work on all file systems
absolute.pathThe full path from where a file was picked up. This includes the hostname and the share name

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PutSmbFile, ListSmb, FetchSmb