PutSmbFile

PutSmbFile 2.0.0

Bundle: org.apache.nifi | nifi-smb-nar
Description: Writes the contents of a FlowFile to a samba network location. 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, put
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

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

Display Name

Batch Size

Description

The maximum number of files to put in each iteration

API Name

Batch Size

Default Value

100

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Conflict Resolution Strategy
Indicates what should happen when a file with the same name already exists in the output directory
Display Name

Conflict Resolution Strategy

Description

Indicates what should happen when a file with the same name already exists in the output directory

API Name

Conflict Resolution Strategy

Default Value

replace

Allowable Values
- replace
- ignore
- fail
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Create Missing Directories
If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.
Display Name

Create Missing Directories

Description

If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.

API Name

Create Missing Directories

Default Value

false

Allowable Values
- true
- false
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]. You may use expression language.

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]. You may use expression language.

API Name

Directory

Expression Language Scope

Environment variables and FlowFile Attributes

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
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
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
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 write. 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 write. 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
Temporary Suffix
A temporary suffix which will be apended to the filename while it's transfering. After the transfer is complete, the suffix will be removed.

Display Name

Temporary Suffix

Description

A temporary suffix which will be apended to the filename while it's transfering. After the transfer is complete, the suffix will be removed.

API Name

Temporary Suffix

Expression Language Scope

Not Supported

Sensitive

false

Required

false
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	Files that have been successfully written to the output network path are transferred to this relationship
failure	Files that could not be written to the output network path for some reason are transferred to this relationship

Reads Attributes

Name	Description
filename	The filename to use when writing the FlowFile to the network folder.