| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSmbFile</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetSmbFile</h1><h2>Description: </h2><p>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]</p><h3>Tags: </h3><p>samba, smb, cifs, files, get</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td>Hostname</td><td></td><td id="allowable-values"></td><td id="description">The network host to which files should be written.</td></tr><tr><td id="name"><strong>Share</strong></td><td>Share</td><td></td><td id="allowable-values"></td><td id="description">The network share to which files should be written. This is the "first folder"after the hostname: \\hostname\[share]\dir1\dir2</td></tr><tr><td id="name">Directory</td><td>Directory</td><td></td><td id="allowable-values"></td><td id="description">The network folder to which files should be written. This is the remaining relative path after the share: \\hostname\share\[dir1\dir2].<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Domain</td><td>Domain</td><td></td><td id="allowable-values"></td><td id="description">The domain used for authentication. Optional, in most cases username and password is sufficient.</td></tr><tr><td id="name">Username</td><td>Username</td><td></td><td id="allowable-values"></td><td id="description">The username used for authentication. If no username is set then anonymous authentication is attempted.</td></tr><tr><td id="name">Password</td><td>Password</td><td></td><td id="allowable-values"></td><td id="description">The password used for authentication. Required if Username is set.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Share Access Strategy</strong></td><td>Share Access Strategy</td><td id="default-value">none</td><td id="allowable-values"><ul><li>none</li><li>read</li><li>read, delete</li><li>read, write, delete</li></ul></td><td id="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.</td></tr><tr><td id="name">File Filter</td><td>File Filter</td><td></td><td id="allowable-values"></td><td id="description">Only files whose names match the given regular expression will be picked up</td></tr><tr><td id="name">Path Filter</td><td>Path Filter</td><td></td><td id="allowable-values"></td><td id="description">When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td>Batch Size</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in each iteration</td></tr><tr><td id="name"><strong>Keep Source File</strong></td><td>Keep Source File</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="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.</td></tr><tr><td id="name"><strong>Recurse Subdirectories</strong></td><td>Recurse Subdirectories</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to pull files from subdirectories</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td>Polling Interval</td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Indicates how long to wait before performing a directory listing</td></tr><tr><td id="name"><strong>Ignore Hidden Files</strong></td><td>Ignore Hidden Files</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not hidden files should be ignored</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename is set to the name of the file on the network share</td></tr><tr><td>path</td><td>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</td></tr><tr><td>file.creationTime</td><td>The date and time that the file was created. May not work on all file systems</td></tr><tr><td>file.lastModifiedTime</td><td>The date and time that the file was last modified. May not work on all file systems</td></tr><tr><td>file.lastAccessTime</td><td>The date and time that the file was last accessed. May not work on all file systems</td></tr><tr><td>absolute.path</td><td>The full path from where a file was picked up. This includes the hostname and the share name</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.smb.PutSmbFile/index.html">PutSmbFile</a>, <a href="../org.apache.nifi.processors.smb.ListSmb/index.html">ListSmb</a>, <a href="../org.apache.nifi.processors.smb.FetchSmb/index.html">FetchSmb</a></p></body></html> |