PutSmbFile

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

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]. You may use expression language.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
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
Create Missing DirectoriesCreate Missing Directoriesfalse
  • true
  • false
If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.
Share Access StrategyShare Access Strategynone
  • none
  • read
  • read, delete
  • read, write, delete
Indicates which shared access are granted on the file during the write. None is the most restrictive, but the safest setting to prevent corruption.
Conflict Resolution StrategyConflict Resolution Strategyreplace
  • replace
  • ignore
  • fail
Indicates what should happen when a file with the same name already exists in the output directory
Batch SizeBatch Size100The maximum number of files to put in each iteration
Temporary SuffixTemporary SuffixA temporary suffix which will be apended to the filename while it's transfering. After the transfer is complete, the suffix will be removed.
SMB Dialectsmb-dialectAUTO
  • AUTO
  • SMB 2.0.2
  • SMB 2.1
  • SMB 3.0
  • SMB 3.0.2
  • SMB 3.1.1
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.
Use Encryptionuse-encryptionfalse
  • true
  • false
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.
Enable DFSenable-dfsfalse
  • true
  • false
Enables accessing Distributed File System (DFS) and following DFS links during SMB operations.
Timeouttimeout5 secTimeout for read and write operations.

Relationships:

NameDescription
successFiles that have been successfully written to the output network path are transferred to this relationship
failureFiles that could not be written to the output network path for some reason are transferred to this relationship

Reads Attributes:

NameDescription
filenameThe filename to use when writing the FlowFile to the network folder.

Writes Attributes:

None specified.

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:

GetSmbFile, ListSmb, FetchSmb