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 required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Hostname * | Hostname | The network host to which files should be written. | ||
| Share * | Share | The network share to which files should be written. This is the "first folder"after the hostname: \hostname[share]\dir1\dir2 | ||
| Directory | 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. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Domain | Domain | The domain used for authentication. Optional, in most cases username and password is sufficient. | ||
| Username | Username | The username used for authentication. If no username is set then anonymous authentication is attempted. | ||
| Password | Password | The password used for authentication. Required if Username is set. | ||
| Create Missing Directories * | Create Missing Directories | false |
| If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure. |
| Share Access Strategy * | Share Access Strategy | none |
| 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 Strategy * | Conflict Resolution Strategy | replace |
| Indicates what should happen when a file with the same name already exists in the output directory |
| Batch Size * | Batch Size | 100 | The maximum number of files to put in each iteration | |
| Temporary Suffix | 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. | ||
| SMB Dialect * | smb-dialect | AUTO |
| 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 Encryption * | use-encryption | 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 DFS * | enable-dfs | false |
| Enables accessing Distributed File System (DFS) and following DFS links during SMB operations. |
| Timeout * | timeout | 5 sec | Timeout for read and write operations. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | Files that could not be written to the output network path for some reason are transferred to this relationship |
| success | Files that have been successfully written to the output network path are transferred to this relationship |
Reads Attributes
| Name | Description |
|---|---|
| filename | The filename to use when writing the FlowFile to the network folder. |
Writes Attributes
This processor does not write attributes.
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
This component does not specify system resource considerations.