blob: f6a956a825bc8f1cc48642dae0ce05df4cf8c69d [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SmbjClientProviderService</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;">SmbjClientProviderService</h1><h2>Description: </h2><p>Provides access to SMB Sessions with shared authentication credentials.</p><h3>Tags: </h3><p>samba, smb, cifs, files</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.</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 of the SMB file server.</td></tr><tr><td id="name"><strong>Port</strong></td><td>port</td><td id="default-value">445</td><td id="allowable-values"></td><td id="description">Port to use for connection.</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 listed from. This is the "first folder"after the hostname: smb://hostname:port/[share]/dir1/dir2</td></tr><tr><td id="name">Username</td><td>username</td><td id="default-value">Guest</td><td id="allowable-values"></td><td id="description">The username used for authentication.</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.<br/><strong>Sensitive Property: true</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"><strong>Timeout</strong></td><td>timeout</td><td id="default-value">5 sec</td><td id="allowable-values"></td><td id="description">Timeout for read and write operations.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>