GetSmbFile

GetSmbFile 2.0.0

Bundle: org.apache.nifi | nifi-smb-nar
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
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Batch Size
The maximum number of files to pull in each iteration

Display Name

Batch Size

Description

The maximum number of files to pull in each iteration

API Name

Batch Size

Default Value

10

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Directory
The network folder to which files should be written. This is the remaining relative path after the share: \\hostname\share\[dir1\dir2].

Display Name

Directory

Description

The network folder to which files should be written. This is the remaining relative path after the share: \\hostname\share\[dir1\dir2].

API Name

Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Domain
The domain used for authentication. Optional, in most cases username and password is sufficient.

Display Name

Domain

Description

The domain used for authentication. Optional, in most cases username and password is sufficient.

API Name

Domain

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Enable DFS
Enables accessing Distributed File System (DFS) and following DFS links during SMB operations.
Display Name

Enable DFS

Description

Enables accessing Distributed File System (DFS) and following DFS links during SMB operations.

API Name

enable-dfs

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
File Filter
Only files whose names match the given regular expression will be picked up

Display Name

File Filter

Description

Only files whose names match the given regular expression will be picked up

API Name

File Filter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Hostname
The network host to which files should be written.

Display Name

Hostname

Description

The network host to which files should be written.

API Name

Hostname

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Ignore Hidden Files
Indicates whether or not hidden files should be ignored
Display Name

Ignore Hidden Files

Description

Indicates whether or not hidden files should be ignored

API Name

Ignore Hidden Files

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Keep Source File
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.
Display Name

Keep Source File

Description

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.

API Name

Keep Source File

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Password
The password used for authentication. Required if Username is set.

Display Name

Password

Description

The password used for authentication. Required if Username is set.

API Name

Password

Expression Language Scope

Not Supported

Sensitive

true

Required

false
Path Filter
When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned

Display Name

Path Filter

Description

When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned

API Name

Path Filter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Polling Interval
Indicates how long to wait before performing a directory listing

Display Name

Polling Interval

Description

Indicates how long to wait before performing a directory listing

API Name

Polling Interval

Default Value

0 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Recurse Subdirectories
Indicates whether or not to pull files from subdirectories
Display Name

Recurse Subdirectories

Description

Indicates whether or not to pull files from subdirectories

API Name

Recurse Subdirectories

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Share
The network share to which files should be written. This is the "first folder"after the hostname: \\hostname\[share]\dir1\dir2

Display Name

Share

Description

The network share to which files should be written. This is the "first folder"after the hostname: \\hostname\[share]\dir1\dir2

API Name

Share

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Share Access Strategy
Indicates which shared access are granted on the file during the read. None is the most restrictive, but the safest setting to prevent corruption.
Display Name

Share Access Strategy

Description

Indicates which shared access are granted on the file during the read. None is the most restrictive, but the safest setting to prevent corruption.

API Name

Share Access Strategy

Default Value

none

Allowable Values
- none
- read
- read, delete
- read, write, delete
Expression Language Scope

Not Supported

Sensitive

false

Required

true
SMB Dialect
The SMB dialect is negotiated between the client and the server by default to the highest common version supported by both end. In some rare cases, the client-server communication may fail with the automatically negotiated dialect. This property can be used to set the dialect explicitly (e.g. to downgrade to a lower version), when those situations would occur.
Display Name

SMB Dialect

Description

The SMB dialect is negotiated between the client and the server by default to the highest common version supported by both end. In some rare cases, the client-server communication may fail with the automatically negotiated dialect. This property can be used to set the dialect explicitly (e.g. to downgrade to a lower version), when those situations would occur.

API Name

smb-dialect

Default Value

AUTO

Allowable Values
- AUTO
- SMB 2.0.2
- SMB 2.1
- SMB 3.0
- SMB 3.0.2
- SMB 3.1.1
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Timeout
Timeout for read and write operations.

Display Name

Timeout

Description

Timeout for read and write operations.

API Name

timeout

Default Value

5 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Use Encryption
Turns on/off encrypted communication between the client and the server. The property's behavior is SMB dialect dependent: SMB 2.x does not support encryption and the property has no effect. In case of SMB 3.x, it is a hint/request to the server to turn encryption on if the server also supports it.
Display Name

Use Encryption

Description

Turns on/off encrypted communication between the client and the server. The property's behavior is SMB dialect dependent: SMB 2.x does not support encryption and the property has no effect. In case of SMB 3.x, it is a hint/request to the server to turn encryption on if the server also supports it.

API Name

use-encryption

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Username
The username used for authentication. If no username is set then anonymous authentication is attempted.

Display Name

Username

Description

The username used for authentication. If no username is set then anonymous authentication is attempted.

API Name

Username

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Relationships

Name	Description
success	All files are routed to success

Writes Attributes

Name	Description
filename	The filename is set to the name of the file on the network share
path	The 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.creationTime	The date and time that the file was created. May not work on all file systems
file.lastModifiedTime	The date and time that the file was last modified. May not work on all file systems
file.lastAccessTime	The date and time that the file was last accessed. May not work on all file systems
absolute.path	The full path from where a file was picked up. This includes the hostname and the share name