| Server IP : 134.29.175.74 / Your IP : 216.73.216.160 Web Server : nginx/1.10.2 System : Windows NT CST-WEBSERVER 10.0 build 19045 (Windows 10) i586 User : Administrator ( 0) PHP Version : 7.1.0 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /Windows/System32/WindowsPowerShell/v1.0/Modules/SmbShare/en-US/ |
Upload File : |
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
<!-- Updatable Help Version 5.0.1.0 -->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Block-SmbShareAccess</command:name>
<maml:description>
<maml:para>Adds a deny ACE for a trustee to the security descriptor of the SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Block</command:verb>
<command:noun>SmbShareAccess</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Block-SmbShareAccess cmdlet adds a deny access control entry (ACE) to the security descriptor of the Server Message Block (SMB) share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Block-SmbShareAccess</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share specified by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the account for the user who is being denied access to the share. Use a comma-separated list to deny share access to multiple accounts.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Block-SmbShareAccess</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the account for the user who is being denied access to the share. Use a comma-separated list to deny share access to multiple accounts.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the account for the user who is being denied access to the share. Use a comma-separated list to deny share access to multiple accounts.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share specified by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbShareAccessControlEntry object represents the new SMB share ACE. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Add a deny ACS</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Block-SmbShareAccess -Name VMFiles -AccountName Contoso\Guest
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Guest Deny Full
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV2$ Allow Full
VMFiles Contoso-SO Contoso\Domain Admins Allow Change
</dev:code>
<dev:remarks>
<maml:para>This command adds a deny ACE for a trustee to the security descriptor of an SMB share named VMFiles.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Add a deny ACS without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Block-SmbShareAccess -Name VMFiles -AccountName "Guest Users" -Force
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Guest Deny Full
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV2$ Allow Full
VMFiles Contoso-SO Contoso\Domain Admins Allow Change
</dev:code>
<dev:remarks>
<maml:para>This command adds a deny ACE for a trustee to the security descriptor of an SMB share named VMFiles without confirmation from the user.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Grant-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Revoke-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Unblock-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Close-SmbOpenFile</command:name>
<maml:description>
<maml:para>Closes a file that is open by one of the clients of the SMB server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Close</command:verb>
<command:noun>SmbOpenFile</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Close-SmbOpenFile cmdlet forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server. This cmdlet can cause data loss to the client for which the file is being closed if the client has not flushed all of the file modifications back to the server before the file is closed.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Close-SmbOpenFile</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>FileId</maml:name>
<maml:description>
<maml:para>Specifies the file identifier (ID) of the file to forcibly close.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name to filter the returned open files so that only the matching files are opened.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user for which the open files are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, if a share is hosted by a windows cluster, the name of the server which is hosting the open files to be retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the open files to be retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies a session ID. Only files that have been opened in the specified session will be returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Close-SmbOpenFile</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name to filter the returned open files so that only the matching files are opened.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user for which the open files are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, if a share is hosted by a windows cluster, the name of the server which is hosting the open files to be retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>FileId</maml:name>
<maml:description>
<maml:para>Specifies the file identifier (ID) of the file to forcibly close.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the open files to be retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies a session ID. Only files that have been opened in the specified session will be returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Close an open file</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Close-SmbOpenFile -FileId 4415226383589
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383589'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
</dev:code>
<dev:remarks>
<maml:para>This command closes a file identified as 4415226383589 that is open by one of the clients of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Close open files for a session</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Close-SmbOpenFile -SessionId 4415226380393
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383589'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383529'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383517'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383521'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-File' on Target '4415226383569'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
</dev:code>
<dev:remarks>
<maml:para>This command closes one or more files that are open by one of the client identified with the session ID 4415226380393 of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Close open files that match a file name extension</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbOpenFile | Where-Object -Property ShareRelativePath -Match ".DOCX" | Close-SmbOpenFile -Force
</dev:code>
<dev:remarks>
<maml:para>This command closes, without user confirmation, one or more files that are open by one of the clients of the SMB server and that match the file name extension .DOCX.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbOpenFile</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Close-SmbSession</command:name>
<maml:description>
<maml:para>Ends forcibly the SMB session.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Close</command:verb>
<command:noun>SmbSession</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Close-SmbSession cmdlet forcibly ends the Server Message Block (SMB) session. This cmdlet may cause loss of data if the client for which session is being stopped has not flushed all of the file modifications back to the server before the session is ended.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Close-SmbSession</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Close-SmbSession</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies the identifier (ID) that uniquely identifies the session that is being ended.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name from which the only sessions are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in case of a share hosted by a Windows cluster, the name of the server which is hosting the sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the sessions being retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name from which the only sessions are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in case of a share hosted by a Windows cluster, the name of the server which is hosting the sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the sessions being retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies the identifier (ID) that uniquely identifies the session that is being ended.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: End an SMB session</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Close-SmbSession -SessionId 8813272891621
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-Session' on Target '8813272891621'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
</dev:code>
<dev:remarks>
<maml:para>This command ends an SMB session.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: End an SMB session without confirmation </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Close-SmbSession -SessionId 8813272891621 -Force
</dev:code>
<dev:remarks>
<maml:para>This command ends an SMB session without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbSession</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Disable-SmbDelegation</command:name>
<maml:description>
<maml:para>Disables a constrained delegation authorization for an SMB client and server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Disable</command:verb>
<command:noun>SmbDelegation</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Disable-SmbDelegation cmdlet disables a constrained delegation authorization for a Server Message Block (SMB) client and server. Delegation allows a user who remotes into an SMB client to perform operations on a remote SMB server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Disable-SmbDelegation</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbClient</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB client. The cmdlet disables constrained delegation authorization for the SMB client that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB server. The cmdlet disables constrained delegation authorization for the SMB server you specify. If you do not specify the SmbClient parameter, the cmdlet disables constrained delegation authorization for all clients on the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbClient</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB client. The cmdlet disables constrained delegation authorization for the SMB client that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB server. The cmdlet disables constrained delegation authorization for the SMB server you specify. If you do not specify the SmbClient parameter, the cmdlet disables constrained delegation authorization for all clients on the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>This cmdlet relies on Active Directory Windows PowerShell cmdlets to perform its actions. Before you use this cmdlet, you must install the Active Directory cmdlets. To install the Active Directory cmdlets, run the following command:
Install-WindowsFeature RSAT-AD-PowerShell
For more information, type Get-Help Install-WindowsFeature.</maml:para>
<maml:para>This cmdlet only works with resource-based delegation, and the Active Directory forest must be at the Windows Server 2012 functional level. To check the functional level of the Active Directory forest, use the Get-ADForest cmdlet.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Disable constrained delegation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Disable-SmbDelegation -SmbServer "FileServer01" -SmbClient "HVSVR01"
</dev:code>
<dev:remarks>
<maml:para>This command removes the constrained delegation authorization so that a user remotely connected to the SMB client named HVSVR01 can no longer configure resources on the SMB server named FileServer01.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Enable-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Enable-SmbDelegation</command:name>
<maml:description>
<maml:para>Enables a constrained delegation authorization for an SMB client and server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Enable</command:verb>
<command:noun>SmbDelegation</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Enable-SmbDelegation cmdlet enables a constrained delegation authorization for a Server Message Block (SMB) client and server. Delegation allows a user who remotes into an SMB client to perform operations on a remote SMB server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Enable-SmbDelegation</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbClient</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB client. The cmdlet enables constrained delegation authorizations for the SMB client that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB server. The cmdlet enables constrained delegation authorizations for the SMB server that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbClient</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB client. The cmdlet enables constrained delegation authorizations for the SMB client that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB server. The cmdlet enables constrained delegation authorizations for the SMB server that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>This cmdlet relies on Active Directory Windows PowerShell cmdlets to perform its actions. Before you use this cmdlet, you must install the Active Directory cmdlets. To install the Active Directory cmdlets, run the following command:
Install-WindowsFeature RSAT-AD-PowerShell
For more information, type Get-Help Install-WindowsFeature.</maml:para>
<maml:para>This cmdlet works only with resource-based delegation, and the Active Directory forest must be at the Windows Server 2012 functional level. To check the functional level of the Active Directory forest, use the Get-ADForest cmdlet.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Enable a constrained delegation authorization for SMB clients and servers</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Enable-SmbDelegation -SmbServer "FileServer01" -SmbClient "HVSVR01"
</dev:code>
<dev:remarks>
<maml:para>This command adds a new constrained delegation authorization so that a user remotely connected to the SMB client named HVSVR01 can configure resources on the SMB server named FileServer01.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Disable-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbBandwidthLimit</command:name>
<maml:description>
<maml:para>Gets the list of SMB bandwidth caps for each traffic category.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbBandwidthLimit</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbBandwidthLimit cmdlet gets the list of Server Message Block (SMB) bandwidth caps for each traffic category. SMB bandwidth caps limit the amount of data that the server can send for each traffic category. </maml:para>
<maml:para>
</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbBandwidthLimit</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of SMB bandwidth limits to get. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">BandwidthLimitCategory[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of SMB bandwidth limits to get. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">BandwidthLimitCategory[]</command:parameterValue>
<dev:type>
<maml:name>BandwidthLimitCategory[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>Before you can use this cmdlet, you must enable the feature by using the following command:
Install-WindowsFeature -Name FS-SMBBW
For more information, type Get-Help Install-WindowsFeature. When you enable the feature, the SMB server creates a new SMB performance counter set that has an instance per category. The performance counters in this set use the same counters as the SMB Client Shares performance counters.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Get SMB bandwidth caps for all categories</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Get-SmbBandwidthLimit
</dev:code>
<dev:remarks>
<maml:para>This command gets the SMB bandwidth caps for all traffic categories.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get SMB bandwidth caps for a category</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Get-SmbBandWidthLimit -Category LiveMigration
</dev:code>
<dev:remarks>
<maml:para>This command gets the SMB bandwidth cap for Live Migration traffic.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbClientConfiguration</command:name>
<maml:description>
<maml:para>Retrieves the SMB client configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbClientConfiguration</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbClientConfiguration cmdlet retrieves the Server Message Block (SMB) client configuration.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbClientConfiguration</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbClientConfiguration</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The MSFT_SmbClientConfiguration object represents the configuration of the SMB client.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get the client configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbClientConfiguration
ConnectionCountPerRssNetworkInterface : 4
DirectoryCacheEntriesMax : 16
DirectoryCacheEntrySizeMax : 65536
DirectoryCacheLifetime : 10
EnableBandwidthThrottling : True
EnableByteRangeLockingOnReadOnlyFiles : True
EnableLargeMtu : True
EnableMultiChannel : True
DormantFileLimit : 1023
EnableSecuritySignature : True
ExtendedSessionTimeout : 1000
FileInfoCacheEntriesMax : 64
FileInfoCacheLifetime : 10
FileNotFoundCacheEntriesMax : 128
FileNotFoundCacheLifetime : 5
KeepConn : 600
MaxCmds : 50
MaximumConnectionCountPerServer : 32
OplocksDisabled : False
RequireSecuritySignature : False
SessionTimeout : 60
UseOpportunisticLocking : True
WindowSizeThreshold : 1
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB client configuration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Set-SmbClientConfiguration</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbClientNetworkInterface</command:name>
<maml:description>
<maml:para>Retrieves the network interfaces used by the SMB client.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbClientNetworkInterface</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbClientNetworkInterface cmdlet retrieves the network interfaces used by the Server Message Block (SMB) client.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbClientNetworkInterface</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Microsoft.Management.Infrastructure.CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Microsoft.Management.Infrastructure.CimSession[]</command:parameterValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Int32</command:parameterValue>
<dev:type>
<maml:name>System.Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbClientNetworkInterface</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbClientNetworkInterface object that represents the network interfaces used by the SMB client. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get network interfaces used by an SMB client</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbClientNetworkInterface
Interface Index RSS Capable RDMA Capable Speed IpAddresses Friendly Name
--------------- ----------- ------------ ----- ----------- -------------
12 True True 32 Gbps {192.168.101.13} RDMA1
15 True True 32 Gbps {192.168.102.13} RDMA2
17 False False 0 bps {fe80::5efe:192.... isatap.{EF722F0D...
18 False False 0 bps {fe80::5efe:192.... isatap.{BD3C4A04...
19 False False 0 bps {fe80::5efe:192.... isatap.{597B0A73...
20 False False 0 bps {fe80::6065:ddbf... Local Area Conne...
32 False False 10 Gbps {172.30.182.10} ExternalVirtual
16 False False 3 Gbps {2001:4898:0:fff... isatap.corp.cont...
14 False False 1 Gbps {192.168.100.13} Internal
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the network interfaces used by the SMB client.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get network interfaces used by an SMB client for a specified link speed</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbClientNetworkInterface | Where-Object -Property LinkSpeed -Gt 10GB
Interface Index RSS Capable RDMA Capable Speed IpAddresses Friendly Name
--------------- ----------- ------------ ----- ----------- -------------
12 True True 32 Gbps {192.168.101.13} RDMA1
15 True True 32 Gbps {192.168.102.13} RDMA2
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the network interfaces used by the SMB client that match the link speed of 10 gigabits or more.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Display details for network interfaces </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbClientNetworkInterface | Where-Object -Property LinkSpeed -Gt 10GB | Select-Object -Property *
FriendlyName : RDMA1
InterfaceIndex : 12
IpAddresses : {192.168.101.13}
LinkSpeed : 32000000000
RdmaCapable : True
RssCapable : True
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbClientNetworkInterface
CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddresses, LinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
FriendlyName : RDMA2
InterfaceIndex : 15
IpAddresses : {192.168.102.13}
LinkSpeed : 32000000000
RdmaCapable : True
RssCapable : True
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbClientNetworkInterface
CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddresses, LinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command displays all of the information retrieved from the network interfaces used by the SMB client that match the link speed of 10 gigabits or more.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbServerNetworkInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbConnection</command:name>
<maml:description>
<maml:para>Retrieves the connections established from the SMB client to the SMB servers.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbConnection</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbConnection cmdlet retrieves the connections established from the Server Message Block (SMB) client to the SMB servers. Users can connect to an SMB share using credentials different than the associated logon credentials so that there will be a connection listed per share per user logon per credential used.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbConnection</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies that the connections made to the server are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>UserName</maml:name>
<maml:description>
<maml:para>Specifies that the connections made by the user are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies that the connections made to the server are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>UserName</maml:name>
<maml:description>
<maml:para>Specifies that the connections made by the user are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbConnection</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This cmdlet returns a MSFT_SmbConnection object that represents the per share per user logon per credentials used to connect.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get connections from an SMB client to SMB servers</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbConnection
ServerName ShareName UserName Credential Dialect NumOpens
---------- --------- -------- ---------- ------- --------
Contoso-FS1 VMS5 Contoso\Contoso-HV1$ Contoso\Contoso-HV1$ 3.00 1
Contoso-FS1 VMS5 NT VIRTUAL MACHI... Contoso\Contoso-HV1$ 3.00 3
Contoso-FS VMS1 Contoso\Contoso-HV1$ Contoso\Contoso-HV1$ 3.00 1
Contoso-FS VMS1 NT VIRTUAL MACHI... Contoso\Contoso-HV1$ 3.00 5
Contoso-SO VMS3 Contoso\Contoso-HV1$ Contoso\Contoso-HV1$ 3.00 1
Contoso-SO VMS3 NT VIRTUAL MACHI... Contoso\Contoso-HV1$ 3.00 1
Contoso-SO VMS3 NT VIRTUAL MACHI... Contoso\Contoso-HV1$ 3.00 2
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the connections established from the SMB client to the SMB servers.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get connections from an SMB server </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbConnection -ServerName Contoso-FS | Select-Object -Property *
ContinuouslyAvailable : True
Credential : Contoso\Contoso-HV1$
Dialect : 3.00
Encrypted : False
NumOpens : 1
ServerName : Contoso-FS
ShareName : VMS1
UserName : Contoso\Contoso-HV1$
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbConnection
CimInstanceProperties : {ContinuouslyAvailable, Credential, Dialect, Encrypted...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
ContinuouslyAvailable : True
Credential : Contoso\Contoso-HV1$
Dialect : 3.00
Encrypted : False
NumOpens : 5
ServerName : Contoso-FS
ShareName : VMS1
UserName : NT VIRTUAL MACHINE\F357A523-592B-4CA5-B61E-C06D5627E1C9
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbConnection
CimInstanceProperties : {ContinuouslyAvailable, Credential, Dialect, Encrypted...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the connections established from the SMB client to the SMB server named Contoso-FS.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbMultichannelConnection</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Update-SmbMultichannelConnection</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbDelegation</command:name>
<maml:description>
<maml:para>Gets the constrained delegation authorizations for an SMB client.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbDelegation</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbDelegation cmdlet gets the constrained delegation authorizations that are currently defined for a server message block (SMB) client that you specify. Delegation allows a user who remotes into an SMB client to perform operations on a remote SMB server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbDelegation</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of an SMB server. The cmdlet gets the constrained delegation authorizations for the SMB server you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SmbServer</maml:name>
<maml:description>
<maml:para>Specifies the name of an SMB server. The cmdlet gets the constrained delegation authorizations for the SMB server you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>This cmdlet relies on Active Directory Windows PowerShell cmdlets to perform its actions. Before you use this cmdlet, you must install the Active Directory cmdlets. To install the Active Directory cmdlets, run the following command:
Install-WindowsFeature RSAT-AD-PowerShell
For more information, type Get-Help Install-WindowsFeature.</maml:para>
<maml:para>This cmdlet works only with resource-based delegation, and the Active Directory forest must be at the Windows Server 2012 functional level. To check the functional level of the Active Directory forest, use the Get-ADForest cmdlet.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Get the constrained delegation authorizations for an SMB client</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Get-SmbDelegation -SmbServer "HVSVR01"
</dev:code>
<dev:remarks>
<maml:para>This command gets the currently defined constrained delegation authorizations for the HVSRV01 server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Disable-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Enable-SmbDelegation</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbMapping</command:name>
<maml:description>
<maml:para>Retrieves the SMB client directory mappings created for a server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbMapping</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbMapping cmdlet retrieves the Server Message Block (SMB) client directory mappings created for a server. This can be a mapping from a local drive letter to a remote shared folder, or it can be a mapping without a local path.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbMapping</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies the local path used to map the remote path on this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies the remote path that is accessed from this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies the local path used to map the remote path on this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies the remote path that is accessed from this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMapping</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbMapping object that represents the mappings created from the SMB client to SMB shares. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get SMB client directory mappings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMapping
Status Local Path Remote Path
------ ---------- -----------
OK X: \\Contoso-SO\VMFiles
OK Y: \\Contoso-FS\VMS1
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB client directory mappings created for the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get SMB client directory mapping for a directory </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMapping -LocalPath X: | Select-Object - Property *
Status : OK
LocalPath : X:
RemotePath : \\Contoso-SO\VMFiles
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbMapping
CimInstanceProperties : {LocalPath, RemotePath, Status}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB client directory mapping for the X: directory created for the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>New-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbMultichannelConnection</command:name>
<maml:description>
<maml:para>Retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbMultichannelConnection</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbMultichannelConnection cmdlet retrieves the Server Message Block (SMB) connections made between the SMB client network interfaces and the SMB server network interfaces. This cmdlet provides information about how the SMB multi-channel pairs the client and the server network interfaces and which pairs are selected to use for the SMB connections.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbMultichannelConnection</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies that the multi-channel connections made to the given server are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeNotSelected</maml:name>
<maml:description>
<maml:para>Indicates the client and server network interface combinations which are not selected are used by SMB are also enumerated.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeNotSelected</maml:name>
<maml:description>
<maml:para>Indicates the client and server network interface combinations which are not selected are used by SMB are also enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies that the multi-channel connections made to the given server are enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMultiChannelConnection</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbMultiChannelConnection object represents a pair of a client and a server network interface.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get connections</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMulitchannelConnection
Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA
Interface Interface Capable Capable
Index Index
----------- -------- --------- --------- -------------- -------------- -------------- --------------
Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True
Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True
Contoso-FS True 192.168.101.13 192.168.101.22 12 12 False True
Contoso-FS True 192.168.102.13 192.168.102.22 15 15 False True
Contoso-FS1 True 192.168.102.13 192.168.102.22 15 15 False True
Contoso-FS1 True 192.168.101.13 192.168.101.22 12 12 False True
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get connections for a specific server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName "Contoso-SO"
Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA
Interface Interface Capable Capable
Index Index
----------- -------- --------- --------- -------------- -------------- -------------- --------------
Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True
Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get properties for connections for a specific server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName "Contoso-SO" | Select -Property *
ClientInterfaceFriendlyName : RDMA2
ClientInterfaceIndex : 15
ClientIpAddress : 192.168.102.13
ClientLinkSpeed : 32000000000
ClientRdmaCapable : True
ClientRSSCapable : False
CurrentChannels : 2
Failed : False
FailureCount : 0
MaxChannels : 2
Selected : True
ServerInterfaceIndex : 15
ServerIpAddress : 192.168.102.11
ServerLinkSpeed : 32000000000
ServerName : Contoso-SO
ServerRdmaCapable : True
ServerRSSCapable : False
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbMultichannelConnection
CimInstanceProperties : {ClientInterfaceFriendlyName, ClientInterfaceIndex, ClientIpAddress, ClientLinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
ClientInterfaceFriendlyName : RDMA1
ClientInterfaceIndex : 12
ClientIpAddress : 192.168.101.13
ClientLinkSpeed : 32000000000
ClientRdmaCapable : True
ClientRSSCapable : False
CurrentChannels : 2
Failed : False
FailureCount : 0
MaxChannels : 2
Selected : True
ServerInterfaceIndex : 12
ServerIpAddress : 192.168.101.11
ServerLinkSpeed : 32000000000
ServerName : Contoso-SO
ServerRdmaCapable : True
ServerRSSCapable : False
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbMultichannelConnection
CimInstanceProperties : {ClientInterfaceFriendlyName, ClientInterfaceIndex, ClientIpAddress, ClientLinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves all of the information about the SMB connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get all connections for a specific server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName "Contoso-SO" -IncludeNotSelected
Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA
Interface Interface Capable Capable
Index Index
----------- -------- --------- --------- -------------- -------------- -------------- --------------
Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True
Contoso-SO False 192.168.102.13 192.168.102.11 15 15 True False
Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True
Contoso-SO False 192.168.101.13 192.168.101.11 12 12 True False
Contoso-SO False 192.168.100.13 192.168.100.11 14 14 False False
Contoso-SO False 172.30.182.10 192.168.102.11 32 15 False False
Contoso-SO False 172.30.182.10 192.168.102.11 32 15 False False
Contoso-SO False 172.30.182.10 192.168.100.11 32 14 False False
Contoso-SO False 172.30.182.10 192.168.101.11 32 12 False False
Contoso-SO False 172.30.182.10 192.168.101.11 32 12 False False
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the all of the connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Update-SmbMultichannelConnection</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbMultichannelConstraint</command:name>
<maml:description>
<maml:para>Retrieves the constraints that define how the SMB client uses network interfaces to connect to the servers.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbMultichannelConstraint</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbMultichannelConstraint cmdlet retrieves the constraints that define how the Server Message Block (SMB) client uses network interfaces to connect to the servers.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbMultichannelConstraint</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies the constraints for the specified server being returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies the constraints for the specified server being returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbMultichannelConstraint</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbMultichannelConstraint object represents the constraints that define how the SMB client uses the network interfaces to connect to servers. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get multichannel constraints</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbMultichannelConstraint
InterfaceAlias : RDMA1
InterfaceGuid : {597b0a73-2b66-4be0-9e6d-f42eae8a35d6}
InterfaceIndex : 12
ServerName : Contoso-SO
PSComputerName :
InterfaceAlias : RDMA2
InterfaceGuid : {bd3c4a04-64cf-4205-88f5-38c4c35dfc38}
InterfaceIndex : 15
ServerName : Contoso-SO
PSComputerName :
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the constraints that define how the SMB client uses network interfaces to connect to the servers.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>New-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbOpenFile</command:name>
<maml:description>
<maml:para>Retrieves basic information about the files that are open on behalf of the clients of the SMB server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbOpenFile</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbOpenFile cmdlet retrieves basic information about the files that are open on behalf of the clients of the Server Message Block (SMB) server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbOpenFile</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>FileId</maml:name>
<maml:description>
<maml:para>Specifies the file identifier (ID) of the file for which the information is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies a session ID. This cmdlet returns only files that have been opened in the specified session.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the filters for the returned open files so that only files opened from the specified client computer are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose open files are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the open files that are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in the case of a share hosted by a windows cluster, the name of the server which hosts the open files that are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that handles that are created and used internally are enumerated also.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the filters for the returned open files so that only files opened from the specified client computer are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose open files are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in the case of a share hosted by a windows cluster, the name of the server which hosts the open files that are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>FileId</maml:name>
<maml:description>
<maml:para>Specifies the file identifier (ID) of the file for which the information is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that handles that are created and used internally are enumerated also.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the open files that are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies a session ID. This cmdlet returns only files that have been opened in the specified session.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbOpenFile</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet return a MSFT_SmbOpenFile object that represents the files opened on the SMB server.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get information about opened files</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SMBOpenFile
FileId SessionId Path ShareRelativePath ClientComputerName ClientUserName
------ --------- ---- ----------------- ------------------ --------------
4415226382229 4415226380377 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226382237 4415226380385 C:\ClusterStorag... VM4\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
4415226383517 4415226380393 C:\ClusterStorag... VM4\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
4415226383521 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383529 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383569 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
4415226383589 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813541326973 8813272891469 I:\VMS\VM1\VIRTU... VM1\VIRTUAL MACH... 192.168.101.13 Contoso\Contoso-HV1$
8813541326977 8813272891469 I:\VMS\VM1\Virtu... VM1\Virtual Mach... 192.168.101.13 Contoso\Contoso-HV1$
8813541326993 8813272891469 I:\VMS\VM1.VHDX VM1.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541326997 8813272891469 I:\VMS\VM1\Virtu... VM1\Virtual Mach... 192.168.101.13 Contoso\Contoso-HV1$
8813541327109 8813272891469 I:\VMS\VM1.VHDX VM1.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813272891805 8813272891441 I:\VMS\VM1\Virtu... VM1\Virtual Mach... 192.168.101.13 Contoso\Contoso-HV1$
8813272891813 8813272891449 I:\VMS\VM1\VIRTU... VM1\VIRTUAL MACH... 192.168.101.13 Contoso\Contoso-HV1$
8813541327273 8813272891581 D:\VMS\VM5\VIRTU... VM5\VIRTUAL MACH... 192.168.102.13 Contoso\Contoso-HV1$
8813541327281 8813272891585 D:\VMS\VM5\VIRTU... VM5\VIRTUAL MACH... 192.168.102.13 Contoso\Contoso-HV1$
8813272892105 8813272891457 C:\ClusterStorag... VM3\Virtual Mach... 192.168.101.13 Contoso\Contoso-HV1$
8813272892113 8813272891461 C:\ClusterStorag... VM3\VIRTUAL MACH... 192.168.101.13 Contoso\Contoso-HV1$
8813541328145 8813272891517 J:\VMS\VM2\VIRTU... VM2\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
8813541328149 8813272891517 J:\VMS\VM2\Virtu... VM2\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
8813541328157 8813272891517 J:\VMS\VM2\Virtu... VM2\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
8813541328213 8813272891517 J:\VMS\VM2.VHDX VM2.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813272892765 8813272891489 J:\VMS\VM2\Virtu... VM2\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
8813541328225 8813272891517 J:\VMS\VM2.VHDX VM2.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813272892773 8813272891493 J:\VMS\VM2\VIRTU... VM2\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
8813541328421 8813272891609 D:\VMS\VM5\Virtu... VM5\Virtual Mach... 192.168.102.13 Contoso\Contoso-HV1$
8813541328425 8813272891609 D:\VMS\VM5\VIRTU... VM5\VIRTUAL MACH... 192.168.102.13 Contoso\Contoso-HV1$
8813541328457 8813272891609 D:\VMS\VM5\Virtu... VM5\Virtual Mach... 192.168.102.13 Contoso\Contoso-HV1$
8813541328501 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541328529 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
</dev:code>
<dev:remarks>
<maml:para>This command retrieves basic information about the files that are open on behalf of the clients of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get information about an opened file</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbOpenFile -FileId 4415226383569 | Select-Object -Property *
ClientComputerName : 192.168.102.14
ClientUserName : Contoso\Contoso-HV2$
ClusterNodeName : Contoso-FS2
ContinuouslyAvailable : True
Encrypted : False
FileId : 4415226383569
Locks : 1
Path : C:\ClusterStorage\Volume2\VMS\VM4.VHDX
Permissions : 1179785
ScopeName : Contoso-SO
SessionId : 4415226380393
ShareRelativePath : VM4.VHDX
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbOpenFile
CimInstanceProperties : {ClientComputerName, ClientUserName, ClusterNodeName, ContinuouslyAvailable...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves all information about the file identified as 4415226383569 that is open on behalf of the clients of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get information about a file opened for an SMB client</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbOpenFile -SessionId 4415226380393
FileId SessionId Path ShareRelativePath ClientComputerName ClientUserName
------ --------- ---- ----------------- ------------------ --------------
4415226383517 4415226380393 C:\ClusterStorag... VM4\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
4415226383521 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383529 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383569 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
4415226383589 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
</dev:code>
<dev:remarks>
<maml:para>This command retrieves basic information about the files that are open on behalf of the SMB client identified as 4415226380393 of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get information about a file opened for an SMB client on an SMB server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbOpenFile -ScopeName "Contoso-SO"
FileId SessionId Path ShareRelativePath ClientComputerName ClientUserName
------ --------- ---- ----------------- ------------------ --------------
4415226382229 4415226380377 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226382237 4415226380385 C:\ClusterStorag... VM4\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
4415226383517 4415226380393 C:\ClusterStorag... VM4\VIRTUAL MACH... 192.168.102.14 Contoso\Contoso-HV2$
4415226383521 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383529 4415226380393 C:\ClusterStorag... VM4\Virtual Mach... 192.168.102.14 Contoso\Contoso-HV2$
4415226383569 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
4415226383589 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813272892105 8813272891457 C:\ClusterStorag... VM3\Virtual Mach... 192.168.101.13 Contoso\Contoso-HV1$
8813272892113 8813272891461 C:\ClusterStorag... VM3\VIRTUAL MACH... 192.168.101.13 Contoso\Contoso-HV1$
8813541328501 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541328529 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
</dev:code>
<dev:remarks>
<maml:para>This command retrieves basic information about the files that are open on behalf of the SMB client of the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get information about files that have a specified file name extension</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbOpenFile | Where-Object -Property ShareRelativePath -Match ".VHDX"
FileId SessionId Path ShareRelativePath ClientComputerName ClientUserName
------ --------- ---- ----------------- ------------------ --------------
4415226383569 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
4415226383589 4415226380393 C:\ClusterStorag... VM4.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813541326993 8813272891469 I:\VMS\VM1.VHDX VM1.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541327109 8813272891469 I:\VMS\VM1.VHDX VM1.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541328213 8813272891517 J:\VMS\VM2.VHDX VM2.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813541328225 8813272891517 J:\VMS\VM2.VHDX VM2.VHDX 192.168.102.14 Contoso\Contoso-HV2$
8813541328501 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
8813541328529 8813272891613 C:\ClusterStorag... VM3.VHDX 192.168.101.13 Contoso\Contoso-HV1$
</dev:code>
<dev:remarks>
<maml:para>This command retrieves basic information about the files that have the file name extension of .VHDX that are open on behalf of the SMB client of the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Close-SmbOpenFile</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbServerConfiguration</command:name>
<maml:description>
<maml:para>Retrieves the SMB server configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbServerConfiguration</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbServerConfiguration cmdlet retrieves the Server Message Block (SMB) server configuration.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbServerConfiguration</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbServerConfiguration</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The MSFT_SmbServerConfiguration object represents the configuration of the SMB server.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get SMB server configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbServerConfiguration
AnnounceServer : False
AsynchronousCredits : 64
AutoShareServer : True
AutoShareWorkstation : True
CachedOpenLimit : 5
AnnounceComment :
EnableDownlevelTimewarp : False
EnableLeasing : True
EnableMultiChannel : True
EnableStrictNameChecking : True
AutoDisconnectTimeout : 0
DurableHandleV2TimeoutInSeconds : 30
EnableAuthenticateUserSharing : False
EnableForcedLogoff : True
EnableOplocks : True
EnableSecuritySignature : False
ServerHidden : True
IrpStackSize : 15
KeepAliveTime : 2
MaxChannelPerSession : 32
MaxMpxCount : 50
MaxSessionPerConnection : 16384
MaxThreadsPerQueue : 20
MaxWorkItems : 1
NullSessionPipes :
NullSessionShares :
OplockBreakWait : 35
PendingClientTimeoutInSeconds : 120
RequireSecuritySignature : False
EnableSMB1Protocol : True
EnableSMB2Protocol : True
Smb2CreditsMax : 2048
Smb2CreditsMin : 128
SmbServerNameHardeningLevel : 0
TreatHostAsStableStorage : False
ValidateAliasNotCircular : True
ValidateShareScope : True
ValidateShareScopeNotAliased : True
ValidateTargetName : True
EncryptData : False
RejectUnencryptedAccess : True
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB server configuration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Set-SmbServerConfiguration</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbServerNetworkInterface</command:name>
<maml:description>
<maml:para>Retrieves the network interfaces used by the SMB server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbServerNetworkInterface</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbServerNetworkInterface cmdlet retrieves the network interfaces that are used by the Server Message Block (SMB) server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbServerNetworkInterface</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Microsoft.Management.Infrastructure.CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Microsoft.Management.Infrastructure.CimSession[]</command:parameterValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Int32</command:parameterValue>
<dev:type>
<maml:name>System.Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbServerNetworkInterface</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The MSFT_SmbServerNetworkInterface object represents the network interfaces of the SMB server.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get network interfaces </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbServerNetworkInterface
Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress
---------- --------------- ----------- ------------ ----- ---------
Contoso-FS 14 False False 1 Gbps 192.168.100.22
Contoso-FS 12 True True 32 Gbps 192.168.101.22
Contoso-FS 15 True True 32 Gbps 192.168.102.22
* 15 True True 32 Gbps 192.168.102.22
* 15 True True 32 Gbps 192.168.102.11
* 14 False False 1 Gbps 192.168.100.22
* 14 False False 1 Gbps 192.168.100.11
* 13 False False 1 Gbps 172.30.182.8
* 12 True True 32 Gbps 192.168.101.22
* 12 True True 32 Gbps 192.168.101.11
Contoso-SO 15 True True 32 Gbps 192.168.102.11
Contoso-SO 14 False False 1 Gbps 192.168.100.11
Contoso-SO 12 True True 32 Gbps 192.168.101.11
FE80::C8C0:F65D:... 13 False False 1 Gbps 172.30.182.8
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the network interfaces that are used by the SMB server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get network interfaces that match a property</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbServerNetworkInterface | Where-Object -Property LinkSpeed -Gt 10GB
Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress
---------- --------------- ----------- ------------ ----- ---------
Contoso-FS 12 True True 32 Gbps 192.168.101.22
Contoso-FS 15 True True 32 Gbps 192.168.102.22
* 15 True True 32 Gbps 192.168.102.22
* 15 True True 32 Gbps 192.168.102.11
* 12 True True 32 Gbps 192.168.101.22
* 12 True True 32 Gbps 192.168.101.11
Contoso-SO 15 True True 32 Gbps 192.168.102.11
Contoso-SO 12 True True 32 Gbps 192.168.101.11
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the network interfaces that are used by the SMB server that have the link speed of 10 gigabits or faster.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get network interfaces for a specific server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbServerNetworkInterface | Where-Object -Property ScopeName -Eq Contoso-FS
Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress
---------- --------------- ----------- ------------ ----- ---------
Contoso-FS 14 False False 1 Gbps 192.168.100.22
Contoso-FS 12 True True 32 Gbps 192.168.101.22
Contoso-FS 15 True True 32 Gbps 192.168.102.22
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the network interfaces that are used by the SMB server named Contoso-FS.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get properties of network interfaces of an SMB server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbServerNetworkInterface | Where-Object -Property ScopeName -Eq Contoso-FS | Select-Object -Property *
FriendlyName : Internal
InterfaceIndex : 14
IpAddress : 192.168.100.22
LinkSpeed : 1000000000
RdmaCapable : False
RssCapable : False
ScopeName : Contoso-FS
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface
CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
FriendlyName : RDMA1
InterfaceIndex : 12
IpAddress : 192.168.101.22
LinkSpeed : 32000000000
RdmaCapable : True
RssCapable : True
ScopeName : Contoso-FS
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface
CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
FriendlyName : RDMA2
InterfaceIndex : 15
IpAddress : 192.168.102.22
LinkSpeed : 32000000000
RdmaCapable : True
RssCapable : True
ScopeName : Contoso-FS
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface
CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves all properties of the network interfaces that are used by the SMB server named Contoso-FS.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbClientNetworkInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbSession</command:name>
<maml:description>
<maml:para>Retrieves information about the SMB sessions that are currently established between the SMB server and the associated clients.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbSession</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbSession cmdlet retrieves basic information about the Server Message Block (SMB) sessions that are currently established between the SMB server and the associated clients.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbSession</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies the identifiers (IDs) that uniquely identify the sessions for which the information is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name from which the only sessions are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the sessions being retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in the case of a share hosted by a Windows cluster, the name of the server which is hosting the sessions is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that sessions that are created and used internally are enumerated also.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ClientComputerName</maml:name>
<maml:description>
<maml:para>Specifies the client computer name from which the only sessions are returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ClientUserName</maml:name>
<maml:description>
<maml:para>Specifies the name of the user whose sessions are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none">
<maml:name>ClusterNodeName</maml:name>
<maml:description>
<maml:para>Specifies, in the case of a share hosted by a Windows cluster, the name of the server which is hosting the sessions is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that sessions that are created and used internally are enumerated also.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the sessions being retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>SessionId</maml:name>
<maml:description>
<maml:para>Specifies the identifiers (IDs) that uniquely identify the sessions for which the information is retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt64[]</command:parameterValue>
<dev:type>
<maml:name>UInt64[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbSession</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbSession object represents the sessions established between the SMB server and the associated clients. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get session information</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbSession
SessionId ClientComputerName ClientUserName NumOpens
--------- ------------------ -------------- --------
85899345929 [fe80::c8c0:f65d:3bc6:7313] Contoso\Contoso-FS1$ 0
4415226380377 192.168.102.14 Contoso\Contoso-HV2$ 1
4415226380385 192.168.102.14 Contoso\Contoso-HV2$ 1
4415226380393 192.168.102.14 Contoso\Contoso-HV2$ 5
8813272891397 [fe80::6484:f325:adff:39eb] Contoso\Contoso-FS2$ 0
8813272891441 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891449 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891457 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891461 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891469 192.168.101.13 Contoso\Contoso-HV1$ 5
8813272891489 192.168.102.14 Contoso\Contoso-HV2$ 1
8813272891493 192.168.102.14 Contoso\Contoso-HV2$ 1
8813272891517 192.168.102.14 Contoso\Contoso-HV2$ 5
8813272891581 192.168.102.13 Contoso\Contoso-HV1$ 1
8813272891585 192.168.102.13 Contoso\Contoso-HV1$ 1
8813272891609 192.168.102.13 Contoso\Contoso-HV1$ 3
8813272891613 192.168.101.13 Contoso\Contoso-HV1$ 2
8813272891621 192.168.101.13 Contoso\Administrator 0
</dev:code>
<dev:remarks>
<maml:para>This command retrieves information about the SMB sessions that are currently established between the SMB server and the associated clients.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get information for a specific session </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbSession -SessionId 8813272891621
SessionId ClientComputerName ClientUserName NumOpens
--------- ------------------ -------------- --------
8813272891621 192.168.101.13 Contoso\Administrator 0
</dev:code>
<dev:remarks>
<maml:para>This command retrieves information about the SMB session identified as 8813272891621 that is currently established between the SMB server and the associated clients.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get session information for a specific client</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbSession -ClientComputerName "192.168.102.14"
SessionId ClientComputerName ClientUserName NumOpens
--------- ------------------ -------------- --------
4415226380377 192.168.102.14 Contoso\Contoso-HV2$ 1
4415226380385 192.168.102.14 Contoso\Contoso-HV2$ 1
4415226380393 192.168.102.14 Contoso\Contoso-HV2$ 5
8813272891489 192.168.102.14 Contoso\Contoso-HV2$ 1
8813272891493 192.168.102.14 Contoso\Contoso-HV2$ 1
8813272891517 192.168.102.14 Contoso\Contoso-HV2$ 5
</dev:code>
<dev:remarks>
<maml:para>This command retrieves information about the SMB sessions that are currently established between the SMB server and the SMB client at the IP address 192.168.102.14.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get session information for a client</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbSession -ClientUserName "Contoso\Contoso-HV1$"
SessionId ClientComputerName ClientUserName NumOpens
--------- ------------------ -------------- --------
8813272891441 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891449 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891457 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891461 192.168.101.13 Contoso\Contoso-HV1$ 1
8813272891469 192.168.101.13 Contoso\Contoso-HV1$ 5
8813272891581 192.168.102.13 Contoso\Contoso-HV1$ 1
8813272891585 192.168.102.13 Contoso\Contoso-HV1$ 1
8813272891609 192.168.102.13 Contoso\Contoso-HV1$ 3
8813272891613 192.168.101.13 Contoso\Contoso-HV1$ 2
</dev:code>
<dev:remarks>
<maml:para>This command retrieves information about the SMB sessions that are currently established between the SMB server and the SMB client that has the user name Contoso\Contoso-HV1$.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get all information for a session </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbSession -SessionId 8813272891441 | Select-Object -Property *
ClientComputerName : 192.168.101.13
ClientUserName : Contoso\Contoso-HV1$
ClusterNodeName : Contoso-FS1
Dialect : 3.00
NumOpens : 1
ScopeName : Contoso-FS
SecondsExists : 45346
SecondsIdle : 33
SessionId : 8813272891441
TransportName :
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbSession
CimInstanceProperties : {ClientComputerName, ClientUserName, ClusterNodeName, Dialect...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command retrieves all of the information about the SMB session identified as 8813272891441 that are currently established between the SMB server and the SMB client.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Close-SmbSession</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbShareAccess</command:name>
<maml:description>
<maml:para>Retrieves the ACL of the SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbShareAccess</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbShareAccess cmdlet gets objects that represent the rights that have been granted to security principles to access the Server Message Block (SMB) share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbShareAccess</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share for which the access rights are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-SmbShareAccess</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share for which the access rights are retrieved.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbShareAccessControlEntry object is returned for the specified share. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get the ACL of a share</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShareAccess -Name "VMFiles"
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the ACL of an SMB share named VMFiles.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get the ACL of a share for a server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShareAccess -Name "VMFiles" -ScopeName "Contoso-SO" | Format-List
Name : VMFiles
ScopeName : Contoso-SO
AccountName : Contoso\Administrator
AccessControlType : Allow
AccessRight : Full
Name : VMFiles
ScopeName : Contoso-SO
AccountName : Contoso\Contoso-HV1$
AccessControlType : Allow
AccessRight : Full
</dev:code>
<dev:remarks>
<maml:para>This command displays the information about the ACL of an SMB share named VMFiles connected to the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Block-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Grant-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Revoke-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Unblock-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-SmbShare</command:name>
<maml:description>
<maml:para>Retrieves the SMB shares on the computer.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>SmbShare</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-SmbShare cmdlet retrieves objects that represent the Server Message Block (SMB) shares being displayed by the computer.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SmbShare</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies one or more SMB shares by share name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>AvailabilityType</maml:name>
<maml:description>
<maml:para>Specifies the cluster type of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AvailabilityType[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CachingMode[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CaTimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the concurrent user limit of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates that the shares being enumerated should be continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates that the shares being enumerated should be encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies the folder enumeration mode of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">FolderEnumerationMode[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that shares that are created and used internally are also enumerated.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Scoped</maml:name>
<maml:description>
<maml:para>Indicates that the shares to be numerated should be scoped.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ShareState</maml:name>
<maml:description>
<maml:para>Specifies the state of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ShareState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Special</maml:name>
<maml:description>
<maml:para>Indicates that the shares to be numerated should be special. Admin share, default shares, IPC$ share are examples of special shares.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>AvailabilityType</maml:name>
<maml:description>
<maml:para>Specifies the cluster type of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AvailabilityType[]</command:parameterValue>
<dev:type>
<maml:name>AvailabilityType[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CachingMode[]</command:parameterValue>
<dev:type>
<maml:name>CachingMode[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CaTimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the concurrent user limit of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates that the shares being enumerated should be continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates that the shares being enumerated should be encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies the folder enumeration mode of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">FolderEnumerationMode[]</command:parameterValue>
<dev:type>
<maml:name>FolderEnumerationMode[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeHidden</maml:name>
<maml:description>
<maml:para>Indicates that shares that are created and used internally are also enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies one or more SMB shares by share name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Scoped</maml:name>
<maml:description>
<maml:para>Indicates that the shares to be numerated should be scoped.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ShareState</maml:name>
<maml:description>
<maml:para>Specifies the state of the shares being enumerated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ShareState[]</command:parameterValue>
<dev:type>
<maml:name>ShareState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Special</maml:name>
<maml:description>
<maml:para>Indicates that the shares to be numerated should be special. Admin share, default shares, IPC$ share are examples of special shares.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The MSFT_SmbShare object represents the SMB shares on the computer. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get SMB shares</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SMBShare
Name ScopeName Path Description
---- --------- ---- -----------
ADMIN$ * C:\Windows Remote Admin
C$ * C:\ Default share
ClusterStorage$ Contoso-SO C:\ClusterStorage Cluster Shared Volumes Def...
D$ * D:\ Default share
F$ * F:\ Default share
G$ * G:\ Default share
H$ * H:\ Default share
I$ Contoso-FS I:\ Cluster Default Share
I$ * I:\ Default share
IPC$ * Remote IPC
J$ Contoso-FS J:\ Cluster Default Share
J$ * J:\ Default share
K$ * K:\ Default share
L$ * L:\ Default share
M$ * M:\ Default share
N$ * N:\ Default share
VMS1 Contoso-FS I:\VMS
VMS2 Contoso-FS J:\VMS
VMS3 Contoso-SO C:\ClusterStorage\Volume1\VMS
VMS4 Contoso-SO C:\ClusterStorage\Volume2\VMS
VMS5 * D:\VMS
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB shares on the computer.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get SMB shares on a specific computer</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShare -Name "VMS1"
Name ScopeName Path Description
---- --------- ---- -----------
VMS1 Contoso-FS I:\VMS
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB shares on the computer named VMS1.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Display information about SMB shares on a specific computer</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShare -Name "VMS1" | Format-List
Name : VMS1
ScopeName : Contoso-FS
Path : I:\VMS
Description :
</dev:code>
<dev:remarks>
<maml:para>This command displays the information about the SMB shares on the computer named VMS1 as a formatted list.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Display all properties about SMB shares on a specific computer</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShare -Name "VMS1" | Format-List -Property *
PresetPathAcl : System.Security.AccessControl.DirectorySecurity
ShareState : Online
AvailabilityType : Clustered
ShareType : FileSystemDirectory
FolderEnumerationMode : Unrestricted
CachingMode : Manual
CATimeout : 0
ConcurrentUserLimit : 0
ContinuouslyAvailable : True
CurrentUsers : 3
Description :
EncryptData : False
Name : VMS1
Path : I:\VMS
Scoped : True
ScopeName : Contoso-FS
SecurityDescriptor : O:BAG:DUD:(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-500)(A;;FA;;;S-1-5-21-219828122-419
8910963-4161819395-1106)(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-1109)
ShadowCopy : False
Special : False
Temporary : False
Volume : \\?\Volume{b02c4ba7-e6f1-11e1-93eb-0008a1c0ef0d}\
PSComputerName :
CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbShare
CimInstanceProperties : {AvailabilityType, CachingMode, CATimeout, ConcurrentUserLimit...}
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
</dev:code>
<dev:remarks>
<maml:para>This command displays all of the information about the SMB shares on the computer named VMS1 as a formatted list.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get shares on a computer that has scaled out availability </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShare | Where-Object -Property AvailabilityType -Eq ScaleOut
Name ScopeName Path Description
---- --------- ---- -----------
ClusterStorage$ Contoso-SO C:\ClusterStorage Cluster Shared Volumes Def...
VMS3 Contoso-SO C:\ClusterStorage\Volume1\VMS
VMS4 Contoso-SO C:\ClusterStorage\Volume2\VMS
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB shares on the computer that has scaled out availability.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 6: Get shares that are connected to a specific server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-SmbShare -ScopeName "Contoso-FS"
Name ScopeName Path Description
---- --------- ---- -----------
I$ Contoso-FS I:\ Cluster Default Share
J$ Contoso-FS J:\ Cluster Default Share
VMS1 Contoso-FS I:\VMS
VMS2 Contoso-FS J:\VMS
</dev:code>
<dev:remarks>
<maml:para>This command retrieves the SMB shares on the computer that are connected to the SMB server named Contoso-FS.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>New-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Grant-SmbShareAccess</command:name>
<maml:description>
<maml:para>Adds an allow ACE for a trustee to the security descriptor of the SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Grant</command:verb>
<command:noun>SmbShareAccess</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Grant-SmbShareAccess cmdlet adds an allow access control entry (ACE) for a trustee to a security descriptor of the Server Message Block (SMB) share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Grant-SmbShareAccess</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccessRight</maml:name>
<maml:description>
<maml:para>Specifies the access right to grant to the trustee. The acceptable values for this parameter are: Full, Modify, or Read.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Full</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Change</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Read</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Custom</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the trustee. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Grant-SmbShareAccess</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccessRight</maml:name>
<maml:description>
<maml:para>Specifies the access right to grant to the trustee. The acceptable values for this parameter are: Full, Modify, or Read.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Full</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Change</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Read</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Custom</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the trustee. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccessRight</maml:name>
<maml:description>
<maml:para>Specifies the access right to grant to the trustee. The acceptable values for this parameter are: Full, Modify, or Read.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ShareAccessRight</command:parameterValue>
<dev:type>
<maml:name>ShareAccessRight</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies the name of the trustee. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope of the share by name.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbShareAccessControlEntry object. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Adds an allow ACE for a trustee </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Grant-SmbShareAccess -Name "VMFiles" -AccountName "Contoso\Contoso-HV2$" -AccessRight Full
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV2$ Allow Full
</dev:code>
<dev:remarks>
<maml:para>This command adds an allow ACE for a trustee to the security descriptor of the SMB share named VMFiles for the account named Contoso\Contoso-HV2$.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Adds an allow ACE for a trustee without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Grant-SmbShareAccess -Name VMFiles -AccountName "Contoso\Domain Admins" -AccessRight Change -Force
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV2$ Allow Full
VMFiles Contoso-SO Contoso\Domain Admins Allow Change
</dev:code>
<dev:remarks>
<maml:para>This command adds an allow ACE for a trustee to the security descriptor of the SMB share named VMFiles for the account named Contoso\Contoso-HV2$ without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Block-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Revoke-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Unblock-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-SmbMapping</command:name>
<maml:description>
<maml:para>Creates an SMB mapping.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>SmbMapping</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-SmbMapping cmdlet creates a Server Message Block (SMB) mapping on the SMB client to an SMB share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-SmbMapping</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies the local path to which the remote path is mapped.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies the remote path that is accessed from this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>HomeFolder</maml:name>
<maml:description>
<maml:para>Indicates that the connection is made to the home folder of the user.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Password</maml:name>
<maml:description>
<maml:para>Specifies the password to be used to connect to the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Persistent</maml:name>
<maml:description>
<maml:para>Indicates that this connection is persistent.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SaveCredentials</maml:name>
<maml:description>
<maml:para>Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UserName</maml:name>
<maml:description>
<maml:para>Specifies the user name to use to connect to the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>HomeFolder</maml:name>
<maml:description>
<maml:para>Indicates that the connection is made to the home folder of the user.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies the local path to which the remote path is mapped.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Password</maml:name>
<maml:description>
<maml:para>Specifies the password to be used to connect to the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Persistent</maml:name>
<maml:description>
<maml:para>Indicates that this connection is persistent.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies the remote path that is accessed from this computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SaveCredentials</maml:name>
<maml:description>
<maml:para>Indicates that the credentials provided should be saved for when a mapping to the same SMB server also is created.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UserName</maml:name>
<maml:description>
<maml:para>Specifies the user name to use to connect to the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMapping</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This cmdlet returns a MSFT_SmbMapping object that represents the newly created SMB mapping.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Create an SMB mapping</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-SmbMapping -LocalPath 'X:' -RemotePath '\\Contoso-SO\VMFiles'
Status Local Path Remote Path
------ ---------- -----------
OK X: \\Contoso-SO\VMFiles
</dev:code>
<dev:remarks>
<maml:para>This command creates an SMB mapping.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-SmbMultichannelConstraint</command:name>
<maml:description>
<maml:para>Creates an SMB multi-channel constraint for the specified server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>SmbMultichannelConstraint</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-SmbMultichannelConstraint cmdlet creates a Server Message Block (SMB) multi-channel constraint for the specified server.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-SmbMultichannelConstraint</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies, when the SMB client is connecting to this server, that the constraints determine which network interfaces are used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the interface indexes of the network interfaces that are used to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>New-SmbMultichannelConstraint</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies, when the SMB client is connecting to this server, that the constraints determine which network interfaces are used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the interface aliases of the network interfaces that is used to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the interface aliases of the network interfaces that is used to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the interface indexes of the network interfaces that are used to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies, when the SMB client is connecting to this server, that the constraints determine which network interfaces are used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMultiChannelConnection</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This cmdlet returns a MSFT_SmbMultiChannelConnection object that represents the SMB multi-channel constraints for the server against which one or more constraints are created. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Create an SMB multi-channel constraint for an SMB server</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-SmbMultichannelConstraint -ServerName "Contoso-SO" -InterfaceAlias "RDMA1", "RDMA2"
Confirm
Are you sure you want to perform this action?
Performing operation 'New-SmbMultichannelConstraint' on Target 'Contoso-SO'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
InterfaceAlias : RDMA1
InterfaceGuid : {597b0a73-2b66-4be0-9e6d-f42eae8a35d6}
InterfaceIndex : 12
ServerName : Contoso-SO
PSComputerName :
InterfaceAlias : RDMA2
InterfaceGuid : {bd3c4a04-64cf-4205-88f5-38c4c35dfc38}
InterfaceIndex : 15
ServerName : Contoso-SO
PSComputerName :
</dev:code>
<dev:remarks>
<maml:para>This command creates an SMB multi-channel constraint for the SMB server named Contoso-SO.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Create an SMB multi-channel constraint for an SMB server without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-SmbMultichannelConstraint -ServerName "Contoso-SO" -InterfaceIndex 12, 15 -Force
InterfaceAlias : RDMA1
InterfaceGuid : {597b0a73-2b66-4be0-9e6d-f42eae8a35d6}
InterfaceIndex : 12
ServerName : Contoso-SO
PSComputerName :
InterfaceAlias : RDMA2
InterfaceGuid : {bd3c4a04-64cf-4205-88f5-38c4c35dfc38}
InterfaceIndex : 15
ServerName : Contoso-SO
PSComputerName :
</dev:code>
<dev:remarks>
<maml:para>This command creates an SMB multi-channel constraint for the SMB server named Contoso-SO without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-SmbShare</command:name>
<maml:description>
<maml:para>Creates an SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>SmbShare</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-SmbShare cmdlet exposes a file system folder to remote clients as a Server Message Block (SMB) share.</maml:para>
<maml:para>To delete a share that was created by this cmdlet, use the Remove-SmbShare cmdlet.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-SmbShare</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies a name for the SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters long. The names pipe and mailslot are reserved for use by the computer.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>Path</maml:name>
<maml:description>
<maml:para>Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the offline files for the SMB share. There are five caching modes:
-- None. Prevents users from storing documents and programs offline.
-- Manual. Allows users to identify the documents and programs they want to store offline.
-- Programs. Automatically stores documents and programs offline.
-- Documents. Automatically stores documents offline.
-- BranchCache. Enables BranchCache and manual caching of documents on the shared folder. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">None</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Manual</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Documents</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Programs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">BranchCache</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CATimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out for the share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ChangeAccess</maml:name>
<maml:description>
<maml:para>Specifies which users are granted modify permission to access the share. Multiple users can be specified by using a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. The default value is zero (0).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates that the share is continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters. The default value no description, or an empty description. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates that the share is encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies which files and folders in the SMB share are visible to users. The acceptable values for this parameter are:
-- AccessBased. SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted. SMB displays files and folders to a user even when the user does not have permission to access the items.
The default value is Unrestricted. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">AccessBased</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unrestricted</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FullAccess</maml:name>
<maml:description>
<maml:para>Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NoAccess</maml:name>
<maml:description>
<maml:para>Specifies which accounts are denied access to the SMB share. Multiple accounts can be specified by supplying a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReadAccess</maml:name>
<maml:description>
<maml:para>Specifies which users are granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SecurityDescriptor</maml:name>
<maml:description>
<maml:para>Specifies the security descriptor for the SMB share in string format.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Temporary</maml:name>
<maml:description>
<maml:para>Specifies the lifetime of the new SMB share. A temporary share does not persist beyond the next restart of the computer. By default, new SMB shares are persistent, and non-temporary.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the offline files for the SMB share. There are five caching modes:
-- None. Prevents users from storing documents and programs offline.
-- Manual. Allows users to identify the documents and programs they want to store offline.
-- Programs. Automatically stores documents and programs offline.
-- Documents. Automatically stores documents offline.
-- BranchCache. Enables BranchCache and manual caching of documents on the shared folder. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CachingMode</command:parameterValue>
<dev:type>
<maml:name>CachingMode</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CATimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out for the share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ChangeAccess</maml:name>
<maml:description>
<maml:para>Specifies which users are granted modify permission to access the share. Multiple users can be specified by using a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. The default value is zero (0).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates that the share is continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters. The default value no description, or an empty description. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates that the share is encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies which files and folders in the SMB share are visible to users. The acceptable values for this parameter are:
-- AccessBased. SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted. SMB displays files and folders to a user even when the user does not have permission to access the items.
The default value is Unrestricted. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">FolderEnumerationMode</command:parameterValue>
<dev:type>
<maml:name>FolderEnumerationMode</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FullAccess</maml:name>
<maml:description>
<maml:para>Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies a name for the SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters long. The names pipe and mailslot are reserved for use by the computer.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NoAccess</maml:name>
<maml:description>
<maml:para>Specifies which accounts are denied access to the SMB share. Multiple accounts can be specified by supplying a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>Path</maml:name>
<maml:description>
<maml:para>Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReadAccess</maml:name>
<maml:description>
<maml:para>Specifies which users are granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SecurityDescriptor</maml:name>
<maml:description>
<maml:para>Specifies the security descriptor for the SMB share in string format.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.String</command:parameterValue>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Temporary</maml:name>
<maml:description>
<maml:para>Specifies the lifetime of the new SMB share. A temporary share does not persist beyond the next restart of the computer. By default, new SMB shares are persistent, and non-temporary.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbShare object that represents the SMB share. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Create an SMB share</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-SmbShare -Name "VMSFiles" -Path "C:\ClusterStorage\Volume1\VMFiles" -FullAccess "Contoso\Administrator", "Contoso\Contoso-HV1$"
Name ScopeName Path Description
---- --------- ---- -----------
VMSFiles Contoso-SO C:\ClusterStorage\Volume1\...
</dev:code>
<dev:remarks>
<maml:para>This command creates an SMB share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Create an encrypted SMB share</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-SmbShare -Name "Data" -Path "J:\Data" -EncryptData $True
Name ScopeName Path Description
---- --------- ---- -----------
Data Contoso-FS J:\Data
</dev:code>
<dev:remarks>
<maml:para>This command creates an encrypted SMB share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-SmbBandwidthLimit</command:name>
<maml:description>
<maml:para>Removes SMB bandwidth caps.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>SmbBandwidthLimit</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-SmbBandwidthLimit cmdlet removes Server Message Block (SMB) bandwidth caps for the traffic categories that you specify. SMB bandwidth caps limit the amount of data that the server can send for each traffic category.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-SmbBandwidthLimit</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of the SMB bandwidth limits to remove. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">BandwidthLimitCategory[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-SmbBandwidthLimit</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of the SMB bandwidth limits to remove. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">BandwidthLimitCategory[]</command:parameterValue>
<dev:type>
<maml:name>BandwidthLimitCategory[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>Before you can use this cmdlet, you must enable the feature by using the following command:
Add-WindowsFeature -Name FS-SMBBW
For more information, type Get-Help Install-WindowsFeature. When you enable the feature, the SMB server creates a new SMB performance counter set that has an instance per category. The performance counters in this set use the same counters as the SMB Client Shares performance counters.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Remove SMB bandwidth caps for all categories</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Remove-SmbBandwidthLimit
</dev:code>
<dev:remarks>
<maml:para>This command removes defined limits for SMB traffic for all categories.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove SMB bandwidth caps for a category</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Remove-SmbBandwidthLimit -Category LiveMigration
Install-WindowsFeature
</dev:code>
<dev:remarks>
<maml:para>This command removes the limit for SMB traffic for Live Migration category.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-SmbMapping</command:name>
<maml:description>
<maml:para>Removes the SMB mapping to an SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>SmbMapping</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-SmbMapping cmdlet removes the Server Message Block (SMB) mapping to an SMB share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-SmbMapping</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies an array of the local paths associated with the SMB mappings that this cmdlet removes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies an array of the remote paths of the SMB shares associated with the mappings that this cmdlet removes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UpdateProfile</maml:name>
<maml:description>
<maml:para>Indicates that the mapping is removed persistently. The mapping is not re-established when the computer restarts. If you specify this parameter and the mapping is persistent, the mapping is removed persistently. The mapping is not re-established when the computer restarts.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-SmbMapping</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UpdateProfile</maml:name>
<maml:description>
<maml:para>Indicates that the mapping is removed persistently. The mapping is not re-established when the computer restarts. If you specify this parameter and the mapping is persistent, the mapping is removed persistently. The mapping is not re-established when the computer restarts.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>LocalPath</maml:name>
<maml:description>
<maml:para>Specifies an array of the local paths associated with the SMB mappings that this cmdlet removes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>RemotePath</maml:name>
<maml:description>
<maml:para>Specifies an array of the remote paths of the SMB shares associated with the mappings that this cmdlet removes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UpdateProfile</maml:name>
<maml:description>
<maml:para>Indicates that the mapping is removed persistently. The mapping is not re-established when the computer restarts. If you specify this parameter and the mapping is persistent, the mapping is removed persistently. The mapping is not re-established when the computer restarts.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove an SMB mapping to an SMB share</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbMapping -LocalPath "Y:"
Confirm
Are you sure you want to perform this action?
Performing operation 'Close-Connection' on Target 'Y:,\\Contoso-FS\VMS1'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
</dev:code>
<dev:remarks>
<maml:para>This command removes an SMB mapping to an SMB share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove an SMB mapping to an SMB share without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbMapping -RemotePath "\\Contoso-SO\VMFiles" -Force
</dev:code>
<dev:remarks>
<maml:para>This command removes an SMB mapping to an SMB share without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-SmbMapping</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-SmbMultichannelConstraint</command:name>
<maml:description>
<maml:para>Removes SMB multi-channel constraints.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>SmbMultichannelConstraint</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-SmbMultichannelConstraint cmdlet removes one or more specified Server Message Block (SMB) multi-channel constraints, which determine the network interfaces to use for connections to specific servers.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-SmbMultichannelConstraint</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies an array of servers from which to remove one or more constraints </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of interface indexes of the network interfaces that are no longer used by SMB to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-SmbMultichannelConstraint</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies an array of servers from which to remove one or more constraints </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of interface aliases of the network interfaces that are no longer used by SMB to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-SmbMultichannelConstraint</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of interface aliases of the network interfaces that are no longer used by SMB to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of interface indexes of the network interfaces that are no longer used by SMB to connect to the server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>ServerName</maml:name>
<maml:description>
<maml:para>Specifies an array of servers from which to remove one or more constraints </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove SMB multi-channel constraints</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbMultichannelConstraint -ServerName "Contoso-SO"
Confirm
Are you sure you want to perform this action?
Performing operation 'Remove-SmbMultiChannelConstraint' on Target 'Contoso-SO,{597b0a73-2b66-4be0-9e6d-f42eae8a35d6}'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
Confirm
Are you sure you want to perform this action?
Performing operation 'Remove-SmbMultiChannelConstraint' on Target 'Contoso-SO,{bd3c4a04-64cf-4205-88f5-38c4c35dfc38}'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): N
</dev:code>
<dev:remarks>
<maml:para>This command removes one or more SMB multi-channel constraints. These constraints determine the network interfaces to be used when connecting to specific servers.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove SMB multi-channel constraints without confirmation </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbMultichannelConstraint -ServerName "Contoso-SO" -InterfaceIndex 12 -Force
</dev:code>
<dev:remarks>
<maml:para>This command removes one or more SMB multi-channel constraints without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-SmbMultichannelConstraint</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-SmbShare</command:name>
<maml:description>
<maml:para>Deletes the specified SMB shares.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>SmbShare</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-SmbShare cmdlet deletes one or more Server Message Block (SMB) shares.</maml:para>
<maml:para>Removing an SMB share forcibly disconnects all of the existing connections to the share. Use this cmdlet with caution. Clients that are forcibly disconnected from a share are not able to flush locally cached data before they are disconnected. This may cause data loss. Use the Get-SmbSession cmdlet to determine whether users are connected to a share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-SmbShare</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-SmbShare</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies an array of names of SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies an array of the scopes of the SMB share to delete.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies an array of names of SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies an array of the scopes of the SMB share to delete.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Delete an SMB share </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbShare -Name "Data"
Confirm
Are you sure you want to perform this action?
Performing operation 'Remove-Share' on Target 'Contoso-FS,Data'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
</dev:code>
<dev:remarks>
<maml:para>This command deletes the SMB share named Data.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Delete an SMB share without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-SmbShare -Name "VMFiles" -ScopeName "Contoso-SO" -Force
</dev:code>
<dev:remarks>
<maml:para>This command deletes the SMB share named VMFiles without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Revoke-SmbShareAccess</command:name>
<maml:description>
<maml:para>Removes all of the allow ACEs for a trustee from the security descriptor of the SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Revoke</command:verb>
<command:noun>SmbShareAccess</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Revoke-SmbShareAccess cmdlet removes all of the allow access control entries (ACEs) for a trustee from the security descriptor of the Server Message Block (SMB) share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Revoke-SmbShareAccess</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the scopes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the trustees. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Revoke-SmbShareAccess</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the trustees. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AccountName</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the trustees. Use a comma-separated list to specify multiple trustees.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies an array of names of the scopes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbShareAccessControlEntry object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove the allow ACEs for a trustee </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Revoke-SmbShareAccess -Name "VMFiles" -AccountName "Domain Admins"
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV2$ Allow Full
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the allow ACEs for a trustee from the security descriptor of the SMB share named VMFiles.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove the allow ACEs for a trustee without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Revoke-SmbShareAccess -Name "VMFiles" -AccountName "Contoso\Contoso-HV2$" -Force
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the allow ACEs for a trustee from the security descriptor of the SMB share named VMFiles without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Block-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Grant-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Unblock-SmbShareAccess</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-SmbBandwidthLimit</command:name>
<maml:description>
<maml:para>Adds an SMB bandwidth cap.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>SmbBandwidthLimit</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-SmbBandwidthLimit cmdlet adds a Server Message Block (SMB) bandwidth cap for the traffic categories that you specify. SMB bandwidth caps limit the amount of data that the server can send for each traffic category.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-SmbBandwidthLimit</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>BytesPerSecond</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of bytes per second that the server can send for the traffic categories that you specify. You can specify units after the number of bytes, such as KB, MB, and GB. You cannot specify a value smaller than 1MB (1048576 bytes) for this parameter.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of the SMB bandwidth limits to add. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue>
<command:parameterValue required="true" variableLength="false">LiveMigration</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>BytesPerSecond</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of bytes per second that the server can send for the traffic categories that you specify. You can specify units after the number of bytes, such as KB, MB, and GB. You cannot specify a value smaller than 1MB (1048576 bytes) for this parameter.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue>
<dev:type>
<maml:name>UInt64</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Category</maml:name>
<maml:description>
<maml:para>Specifies an array of categories of the SMB bandwidth limits to add. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">BandwidthLimitCategory</command:parameterValue>
<dev:type>
<maml:name>BandwidthLimitCategory</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>Before you can use this cmdlet, you must enable the feature by using the following command:
Add-WindowsFeature -Name FS-SMBBW
For more information, type Get-Help Install-WindowsFeature. When you enable the feature, the SMB server creates a new SMB performance counter set that has an instance per category. The performance counters in this set use the same counters as the SMB Client Shares performance counters.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Add an SMB limit</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Set-SmbBandwidthLimit -Category Default -BytesPerSecond 100MB
</dev:code>
<dev:remarks>
<maml:para>This command limits SMB traffic to 100 megabytes per second for traffic that is unrelated to Hyper-V over SMB or Live Migration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Add an SMB limit for live migration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Set-SmbBandwidthLimit -Category LiveMigration -BytesPerSecond 1GB
</dev:code>
<dev:remarks>
<maml:para>This command limits SMB traffic to 1 gigabyte per second for Live Migration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Install-WindowsFeature</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbBandwidthLimit</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-SmbClientConfiguration</command:name>
<maml:description>
<maml:para>Sets the SMB client configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>SmbClientConfiguration</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-SmbClientConfiguration cmdlet sets the Server Message Block (SMB) client configuration.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-SmbClientConfiguration</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConnectionCountPerRssNetworkInterface</maml:name>
<maml:description>
<maml:para>Specifies the SMB connection count per each RSS network interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum cache entries that can be in the directory cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheEntrySizeMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum size of directory cache entry.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the directory cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DormantFileLimit</maml:name>
<maml:description>
<maml:para>Specifies the dormant file limit.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableBandwidthThrottling</maml:name>
<maml:description>
<maml:para>Indicates that bandwidth throttling is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableByteRangeLockingOnReadOnlyFiles</maml:name>
<maml:description>
<maml:para>Indicates that byte range locking on read-only files is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLargeMtu</maml:name>
<maml:description>
<maml:para>Indicates that large MTU is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLoadBalanceScaleOut</maml:name>
<maml:description>
<maml:para>Indicates whether load balance scale out is enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableMultiChannel</maml:name>
<maml:description>
<maml:para>Indicates that multi-channel is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates that the security signature is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ExtendedSessionTimeout</maml:name>
<maml:description>
<maml:para>Specifies the extended session time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileInfoCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum number entries that can be in the file information cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileInfoCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the file information cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileNotFoundCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum number entries that can be in the file not found cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileNotFoundCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the file not found cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>KeepConn</maml:name>
<maml:description>
<maml:para>Specifies the time, in seconds, before the SMB client session is automatically disconnected.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxCmds</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent outstanding network requests that the SMB client supports.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaximumConnectionCountPerServer</maml:name>
<maml:description>
<maml:para>Specifies the maximum connection count per server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OplocksDisabled</maml:name>
<maml:description>
<maml:para>Indicates that opportunistic locks are disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RequireSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates that the security signature is required.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SessionTimeout</maml:name>
<maml:description>
<maml:para>Specifies the session time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseOpportunisticLocking</maml:name>
<maml:description>
<maml:para>Indicates that opportunistic locks are used.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WindowSizeThreshold</maml:name>
<maml:description>
<maml:para>Specifies the window size threshold.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConnectionCountPerRssNetworkInterface</maml:name>
<maml:description>
<maml:para>Specifies the SMB connection count per each RSS network interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum cache entries that can be in the directory cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheEntrySizeMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum size of directory cache entry.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectoryCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the directory cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DormantFileLimit</maml:name>
<maml:description>
<maml:para>Specifies the dormant file limit.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableBandwidthThrottling</maml:name>
<maml:description>
<maml:para>Indicates that bandwidth throttling is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableByteRangeLockingOnReadOnlyFiles</maml:name>
<maml:description>
<maml:para>Indicates that byte range locking on read-only files is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLargeMtu</maml:name>
<maml:description>
<maml:para>Indicates that large MTU is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLoadBalanceScaleOut</maml:name>
<maml:description>
<maml:para>Indicates whether load balance scale out is enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">System.Boolean</command:parameterValue>
<dev:type>
<maml:name>System.Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableMultiChannel</maml:name>
<maml:description>
<maml:para>Indicates that multi-channel is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates that the security signature is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ExtendedSessionTimeout</maml:name>
<maml:description>
<maml:para>Specifies the extended session time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileInfoCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum number entries that can be in the file information cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileInfoCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the file information cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileNotFoundCacheEntriesMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum number entries that can be in the file not found cache.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>FileNotFoundCacheLifetime</maml:name>
<maml:description>
<maml:para>Specifies the file not found cache lifetime.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>KeepConn</maml:name>
<maml:description>
<maml:para>Specifies the time, in seconds, before the SMB client session is automatically disconnected.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxCmds</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent outstanding network requests that the SMB client supports.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaximumConnectionCountPerServer</maml:name>
<maml:description>
<maml:para>Specifies the maximum connection count per server.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OplocksDisabled</maml:name>
<maml:description>
<maml:para>Indicates that opportunistic locks are disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RequireSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates that the security signature is required.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SessionTimeout</maml:name>
<maml:description>
<maml:para>Specifies the session time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseOpportunisticLocking</maml:name>
<maml:description>
<maml:para>Indicates that opportunistic locks are used.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WindowSizeThreshold</maml:name>
<maml:description>
<maml:para>Specifies the window size threshold.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Set the SMB client configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 8
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'SMB Client Configuration'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
</dev:code>
<dev:remarks>
<maml:para>This command sets the SMB client configuration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Set the SMB client configuration without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbClientConfiguration -ConnectionCountPerRssNetworkInterface 4 -Force
</dev:code>
<dev:remarks>
<maml:para>This command sets the SMB client configuration without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbClientConfiguration</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-SmbPathAcl</command:name>
<maml:description>
<maml:para>Sets the ACL for the file system folder to match the ACL used by an SMB share. </maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>SmbPathAcl</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-SmbPathAcl cmdlet sets the access control list (ACL) for the file system folder to match the ACL for the server message block (SMB) share. The cmdlet sets the ACL to match the SMB share itself. This action simplifies the configuration of NTFS or ReFS file system permissions by copying the SMB share permissions.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-SmbPathAcl</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>ShareName</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share. The cmdlet sets the ACL on the file system folder to the ACL used by the SMB share that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the SMB share. The cmdlet sets the ACL for the scope that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the SMB share. The cmdlet sets the ACL for the scope that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>ShareName</maml:name>
<maml:description>
<maml:para>Specifies the name of the SMB share. The cmdlet sets the ACL on the file system folder to the ACL used by the SMB share that you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<maml:alertSet>
<maml:title />
<maml:alert>
<maml:para>The previous syntax for the same task, ((Get-SmbShare –Name <ShareName> ).PresetPathACL | Set-Acl), continues to work with newer versions of the Windows Server operating system, but the new syntax is much simpler and therefore recommended.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>Example 1: Set the SMB path ACL by share name</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Set-SmbPathAcl -ShareName "Share01"
</dev:code>
<dev:remarks>
<maml:para>This command sets the ACL on the file system folder used by the Share01 share to match the ACL of the share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Set the SMB path ACL by share name and scope name</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Set-SmbPathAcl -ShareName "Share01" -ScopeName "SOFS01"
</dev:code>
<dev:remarks>
<maml:para>This command sets the ACL on the file system folder used by the Share01 share on the SOFS01 scope to match the ACL of the share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>SMB Share Cmdlets in Windows PowerShell</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-SmbServerConfiguration</command:name>
<maml:description>
<maml:para>Sets the SMB Service configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>SmbServerConfiguration</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-SmbServerConfiguration cmdlet sets the Server Message Block (SMB) Service configuration.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-SmbServerConfiguration</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AnnounceComment</maml:name>
<maml:description>
<maml:para>Specifies the announce comment string.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AnnounceServer</maml:name>
<maml:description>
<maml:para>Indicates that this server announces itself by using browser announcements.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AsynchronousCredits</maml:name>
<maml:description>
<maml:para>Specifies the asynchronous credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoDisconnectTimeout</maml:name>
<maml:description>
<maml:para>Specifies the auto disconnect time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoShareServer</maml:name>
<maml:description>
<maml:para>Indicates that the default server shares are shared out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoShareWorkstation</maml:name>
<maml:description>
<maml:para>Indicates whether the default workstation shares are shared out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CachedOpenLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of cached open files.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DurableHandleV2TimeoutInSeconds</maml:name>
<maml:description>
<maml:para>Specifies the durable handle v2 time-out period, in seconds.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableAuthenticateUserSharing</maml:name>
<maml:description>
<maml:para>Indicates whether authenticate user sharing is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableDownlevelTimewarp</maml:name>
<maml:description>
<maml:para>Indicates whether down-level timewarp support is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableForcedLogoff</maml:name>
<maml:description>
<maml:para>Indicates whether forced logoff is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLeasing</maml:name>
<maml:description>
<maml:para>Indicates whether leasing is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableMultiChannel</maml:name>
<maml:description>
<maml:para>Indicates whether multi-channel is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableOplocks</maml:name>
<maml:description>
<maml:para>Indicates whether the opportunistic locks are enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates whether the security signature is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSMB1Protocol</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB1 protocol is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSMB2Protocol</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB2 protocol is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableStrictNameChecking</maml:name>
<maml:description>
<maml:para>Indicates whether the server should perform strict name checking on incoming connects.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates whether the sessions established on this server are encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IrpStackSize</maml:name>
<maml:description>
<maml:para>Specifies the default IRP stack size.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>KeepAliveTime</maml:name>
<maml:description>
<maml:para>Specifies the keep alive time.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxChannelPerSession</maml:name>
<maml:description>
<maml:para>Specifies the maximum channels per session.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxMpxCount</maml:name>
<maml:description>
<maml:para>Specifies the maximum MPX count for SMB1.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSessionPerConnection</maml:name>
<maml:description>
<maml:para>Specifies the maximum sessions per connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxThreadsPerQueue</maml:name>
<maml:description>
<maml:para>Specifies the maximum threads per queue.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxWorkItems</maml:name>
<maml:description>
<maml:para>Specifies the maximum SMB1 work items.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NullSessionPipes</maml:name>
<maml:description>
<maml:para>Specifies the null session pipes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NullSessionShares</maml:name>
<maml:description>
<maml:para>Specifies the null session shares.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OplockBreakWait</maml:name>
<maml:description>
<maml:para>Specifies how long the create caller waits for an opportunistic lock break.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PendingClientTimeoutInSeconds</maml:name>
<maml:description>
<maml:para>Specifies the pending client time-out period, in seconds.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RejectUnencryptedAccess</maml:name>
<maml:description>
<maml:para>Indicates whether the client that does not support encryption is denied access if it attempts to connect to an encrypted share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RequireSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates whether the security signature is required.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ServerHidden</maml:name>
<maml:description>
<maml:para>Indicates whether the server announces itself.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Smb2CreditsMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum SMB2 credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Smb2CreditsMin</maml:name>
<maml:description>
<maml:para>Specifies the minimum SMB2 credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SmbServerNameHardeningLevel</maml:name>
<maml:description>
<maml:para>Specifies the SMB Service name hardening level.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TreatHostAsStableStorage</maml:name>
<maml:description>
<maml:para>Indicates whether the host is treated as the stable storage.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateAliasNotCircular</maml:name>
<maml:description>
<maml:para>Indicates whether the aliases that are not circular are validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateShareScope</maml:name>
<maml:description>
<maml:para>Indicates that the existence of share scopes is checked during share creation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateShareScopeNotAliased</maml:name>
<maml:description>
<maml:para>Indicates whether the share scope being aliased is validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateTargetName</maml:name>
<maml:description>
<maml:para>Indicates whether the target name is validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AnnounceComment</maml:name>
<maml:description>
<maml:para>Specifies the announce comment string.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AnnounceServer</maml:name>
<maml:description>
<maml:para>Indicates that this server announces itself by using browser announcements.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AsynchronousCredits</maml:name>
<maml:description>
<maml:para>Specifies the asynchronous credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoDisconnectTimeout</maml:name>
<maml:description>
<maml:para>Specifies the auto disconnect time-out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoShareServer</maml:name>
<maml:description>
<maml:para>Indicates that the default server shares are shared out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoShareWorkstation</maml:name>
<maml:description>
<maml:para>Indicates whether the default workstation shares are shared out.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CachedOpenLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of cached open files.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DurableHandleV2TimeoutInSeconds</maml:name>
<maml:description>
<maml:para>Specifies the durable handle v2 time-out period, in seconds.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableAuthenticateUserSharing</maml:name>
<maml:description>
<maml:para>Indicates whether authenticate user sharing is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableDownlevelTimewarp</maml:name>
<maml:description>
<maml:para>Indicates whether down-level timewarp support is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableForcedLogoff</maml:name>
<maml:description>
<maml:para>Indicates whether forced logoff is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableLeasing</maml:name>
<maml:description>
<maml:para>Indicates whether leasing is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableMultiChannel</maml:name>
<maml:description>
<maml:para>Indicates whether multi-channel is disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableOplocks</maml:name>
<maml:description>
<maml:para>Indicates whether the opportunistic locks are enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates whether the security signature is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSMB1Protocol</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB1 protocol is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableSMB2Protocol</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB2 protocol is enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EnableStrictNameChecking</maml:name>
<maml:description>
<maml:para>Indicates whether the server should perform strict name checking on incoming connects.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates whether the sessions established on this server are encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IrpStackSize</maml:name>
<maml:description>
<maml:para>Specifies the default IRP stack size.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>KeepAliveTime</maml:name>
<maml:description>
<maml:para>Specifies the keep alive time.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxChannelPerSession</maml:name>
<maml:description>
<maml:para>Specifies the maximum channels per session.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxMpxCount</maml:name>
<maml:description>
<maml:para>Specifies the maximum MPX count for SMB1.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSessionPerConnection</maml:name>
<maml:description>
<maml:para>Specifies the maximum sessions per connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxThreadsPerQueue</maml:name>
<maml:description>
<maml:para>Specifies the maximum threads per queue.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxWorkItems</maml:name>
<maml:description>
<maml:para>Specifies the maximum SMB1 work items.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NullSessionPipes</maml:name>
<maml:description>
<maml:para>Specifies the null session pipes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NullSessionShares</maml:name>
<maml:description>
<maml:para>Specifies the null session shares.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OplockBreakWait</maml:name>
<maml:description>
<maml:para>Specifies how long the create caller waits for an opportunistic lock break.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PendingClientTimeoutInSeconds</maml:name>
<maml:description>
<maml:para>Specifies the pending client time-out period, in seconds.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RejectUnencryptedAccess</maml:name>
<maml:description>
<maml:para>Indicates whether the client that does not support encryption is denied access if it attempts to connect to an encrypted share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RequireSecuritySignature</maml:name>
<maml:description>
<maml:para>Indicates whether the security signature is required.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ServerHidden</maml:name>
<maml:description>
<maml:para>Indicates whether the server announces itself.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Smb2CreditsMax</maml:name>
<maml:description>
<maml:para>Specifies the maximum SMB2 credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Smb2CreditsMin</maml:name>
<maml:description>
<maml:para>Specifies the minimum SMB2 credits.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SmbServerNameHardeningLevel</maml:name>
<maml:description>
<maml:para>Specifies the SMB Service name hardening level.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TreatHostAsStableStorage</maml:name>
<maml:description>
<maml:para>Indicates whether the host is treated as the stable storage.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateAliasNotCircular</maml:name>
<maml:description>
<maml:para>Indicates whether the aliases that are not circular are validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateShareScope</maml:name>
<maml:description>
<maml:para>Indicates that the existence of share scopes is checked during share creation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateShareScopeNotAliased</maml:name>
<maml:description>
<maml:para>Indicates whether the share scope being aliased is validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidateTargetName</maml:name>
<maml:description>
<maml:para>Indicates whether the target name is validated.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Set the SMB Service configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbServerConfiguration -MaxChannelPerSession 16
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'SMB Service Configuration'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
</dev:code>
<dev:remarks>
<maml:para>This command sets the SMB Service configuration.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Set the SMB Service configuration without confirmation</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbServerConfiguration -MaxChannelPerSession 32 -Force
</dev:code>
<dev:remarks>
<maml:para>This command sets the SMB Service configuration without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbServerConfiguration</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-SmbShare</command:name>
<maml:description>
<maml:para>Modifies the properties of the SMB share.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>SmbShare</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-SmbShare cmdlet modifies the properties of the Server Message Block (SMB) share.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-SmbShare</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the offline files for the SMB share. There are five caching modes:
-- None. Prevents users from storing documents and programs offline.
-- Manual. Allows users to identify the documents and programs that they want to store offline.
-- Programs. Automatically stores documents and programs offline.
-- Documents. Automatically stores documents offline.
-- BranchCache. Enables BranchCache and manual caching of documents on the shared folder. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">None</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Manual</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Documents</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Programs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">BranchCache</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CATimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrently connected users that the SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. By default, new SMB shares have no limit on the number of concurrent connections.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates whether the share is continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>Specifies an optional description of the SMB share. A description of the share can be displayed by running the Get-SmbShare cmdlet. Specify an empty string to clear the current description. The description may not contain more than 256 characters.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB share is encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies which files and folders in the new SMB share will be visible to the users. The acceptable values for this parameter are:
-- AccessBased. SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted. SMB displays files and folders to a user even when the user does not have permission to access those items.
The default value is Unrestricted. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">AccessBased</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unrestricted</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>SecurityDescriptor</maml:name>
<maml:description>
<maml:para>Specifies the security descriptor for the SMB share in string format.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-SmbShare</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of one or more SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the offline files for the SMB share. There are five caching modes:
-- None. Prevents users from storing documents and programs offline.
-- Manual. Allows users to identify the documents and programs that they want to store offline.
-- Programs. Automatically stores documents and programs offline.
-- Documents. Automatically stores documents offline.
-- BranchCache. Enables BranchCache and manual caching of documents on the shared folder. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">None</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Manual</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Documents</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Programs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">BranchCache</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CATimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrently connected users that the SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. By default, new SMB shares have no limit on the number of concurrent connections.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates whether the share is continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>Specifies an optional description of the SMB share. A description of the share can be displayed by running the Get-SmbShare cmdlet. Specify an empty string to clear the current description. The description may not contain more than 256 characters.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB share is encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies which files and folders in the new SMB share will be visible to the users. The acceptable values for this parameter are:
-- AccessBased. SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted. SMB displays files and folders to a user even when the user does not have permission to access those items.
The default value is Unrestricted. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">AccessBased</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Unrestricted</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>SecurityDescriptor</maml:name>
<maml:description>
<maml:para>Specifies the security descriptor for the SMB share in string format.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CSV</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CachingMode</maml:name>
<maml:description>
<maml:para>Specifies the caching mode of the offline files for the SMB share. There are five caching modes:
-- None. Prevents users from storing documents and programs offline.
-- Manual. Allows users to identify the documents and programs that they want to store offline.
-- Programs. Automatically stores documents and programs offline.
-- Documents. Automatically stores documents offline.
-- BranchCache. Enables BranchCache and manual caching of documents on the shared folder. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CachingMode</command:parameterValue>
<dev:type>
<maml:name>CachingMode</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>CATimeout</maml:name>
<maml:description>
<maml:para>Specifies the continuous availability time-out of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ConcurrentUserLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrently connected users that the SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. By default, new SMB shares have no limit on the number of concurrent connections.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>ContinuouslyAvailable</maml:name>
<maml:description>
<maml:para>Indicates whether the share is continuously available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>Specifies an optional description of the SMB share. A description of the share can be displayed by running the Get-SmbShare cmdlet. Specify an empty string to clear the current description. The description may not contain more than 256 characters.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>EncryptData</maml:name>
<maml:description>
<maml:para>Indicates whether the SMB share is encrypted.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>FolderEnumerationMode</maml:name>
<maml:description>
<maml:para>Specifies which files and folders in the new SMB share will be visible to the users. The acceptable values for this parameter are:
-- AccessBased. SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted. SMB displays files and folders to a user even when the user does not have permission to access those items.
The default value is Unrestricted. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">FolderEnumerationMode</command:parameterValue>
<dev:type>
<maml:name>FolderEnumerationMode</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Force</maml:name>
<maml:description>
<maml:para>Forces the command to run without asking for user confirmation.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of one or more SMB shares.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none">
<maml:name>ScopeName</maml:name>
<maml:description>
<maml:para>Specifies the scope name of the SMB share.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
<maml:name>SecurityDescriptor</maml:name>
<maml:description>
<maml:para>Specifies the security descriptor for the SMB share in string format.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>SmbInstance</maml:name>
<maml:description>
<maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This cmdlet returns a MSFT_SmbShare object that represents the modified share.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Modify properties of an SMB share</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbShare -Name "VMFiles" -EncryptData $True
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
</dev:code>
<dev:remarks>
<maml:para>This command modifies the properties of an SMB share.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Modify properties of an SMB share without confirmation </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-SmbShare -Name "VMFiles" -EncryptData $True -Force
</dev:code>
<dev:remarks>
<maml:para>This command modifies the properties of an SMB share without user confirmation.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Get-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-SmbShare</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.</maml:para>Server Message Block Share<maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">This reference provides cmdlet descriptions and syntax for all Server Message Block (SMB) Share-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">cmdlet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Description</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Block-SmbShareAccess</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Adds a deny ACE for a trustee to the security descriptor of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Close-SmbOpenFile</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Closes a file that is open by one of the clients of the SMB server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Close-SmbSession</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Ends forcibly the SMB session.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Disable-SmbDelegation</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Disables a constrained delegation authorization for an SMB client and server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Enable-SmbDelegation</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Enables a constrained delegation authorization for an SMB client and server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbBandwidthLimit</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets the list of SMB bandwidth caps for each traffic category.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbClientConfiguration</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the SMB client configuration.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbClientNetworkInterface</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the network interfaces used by the SMB client.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbConnection</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the connections established from the SMB client to the SMB servers.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbDelegation</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets the constrained delegation authorizations for an SMB client.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbMapping</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the SMB client directory mappings created for a server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbMultichannelConnection</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbMultichannelConstraint</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the constraints that define how the SMB client uses network interfaces to connect to the servers.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbOpenFile</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves basic information about the files that are open on behalf of the clients of the SMB server. </maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbServerConfiguration</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the SMB server configuration.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbServerNetworkInterface</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the network interfaces used by the SMB server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbSession</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves information about the SMB sessions that are currently established between the SMB server and the associated clients.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbShare</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the SMB shares on the computer.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-SmbShareAccess</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Retrieves the ACL of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Grant-SmbShareAccess</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Adds an allow ACE for a trustee to the security descriptor of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-SmbMapping</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates an SMB mapping.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-SmbMultichannelConstraint</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates an SMB multi-channel constraint for the specified server.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-SmbShare</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates an SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-SmbBandwidthLimit</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes SMB bandwidth caps.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-SmbMapping</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes the SMB mapping to an SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-SmbMultichannelConstraint</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes SMB multi-channel constraints.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-SmbShare</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes the specified SMB shares.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Revoke-SmbShareAccess</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes all of the allow ACEs for a trustee from the security descriptor of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-SmbBandwidthLimit</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Adds an SMB bandwidth cap.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-SmbClientConfiguration</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Sets the SMB client configuration.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-SmbPathAcl</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Sets the ACL for the file system folder to match the ACL used by an SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-SmbServerConfiguration</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Sets the SMB Service configuration.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-SmbShare</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Modifies the properties of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Unblock-SmbShareAccess</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes all of the deny ACEs for the trustee from the security descriptor of the SMB share.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Update-SmbMultichannelConnection</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Forces the SMB client to update the multi-channel-related information.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">To list all the cmdlets that are available, use the Get-Command –Module SmbShare cmdlet.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets: ● Get-Help <cmdlet name> -Detailed ● Get-Help <cmdlet name> -Examples ● Get-Help <cmdlet name> -Full </maml:para><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Unblock-SmbShareAccess</command:name><maml:description><maml:para>Removes all of the deny ACEs for the trustee from the security descriptor of the SMB share.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Unblock</command:verb><command:noun>SmbShareAccess</command:noun><dev:version /></command:details><maml:description><maml:para>The Unblock-SmbShareAccess cmdlet removes all of the deny access control entries (ACEs) for the trustee from the security descriptor of the Server Message Block (SMB) share.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Unblock-SmbShareAccess</maml:name><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the SMB share.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ScopeName</maml:name><maml:description><maml:para>Specifies an array of names of the scopes of the shares.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>AccountName</maml:name><maml:description><maml:para>Specifies an array of the names of the trustees whose deny ACEs are removed from the security descriptor of the SMB share. Specify a comma-separated list to unblock multiple trustees.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Force</maml:name><maml:description><maml:para>Forces the command to run without asking for user confirmation.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"><maml:name>SmbInstance</maml:name><maml:description><maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para></maml:description><command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Default</command:parameterValue><command:parameterValue required="false" variableLength="false">CSV</command:parameterValue></command:parameterValueGroup></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Unblock-SmbShareAccess</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>AccountName</maml:name><maml:description><maml:para>Specifies an array of the names of the trustees whose deny ACEs are removed from the security descriptor of the SMB share. Specify a comma-separated list to unblock multiple trustees.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Force</maml:name><maml:description><maml:para>Forces the command to run without asking for user confirmation.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>AccountName</maml:name><maml:description><maml:para>Specifies an array of the names of the trustees whose deny ACEs are removed from the security descriptor of the SMB share. Specify a comma-separated list to unblock multiple trustees.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Force</maml:name><maml:description><maml:para>Forces the command to run without asking for user confirmation.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the SMB share.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ScopeName</maml:name><maml:description><maml:para>Specifies an array of names of the scopes of the shares.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"><maml:name>SmbInstance</maml:name><maml:description><maml:para>Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</command:parameterValue><dev:type><maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
This cmdlet returns a MSFT_SmbShareAccessControlEntry object. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Remove the deny ACEs for a trustee</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Unblock-SmbShareAccess -Name "VMFiles" -AccountName "Guest Users"
Confirm
Are you sure you want to perform this action?
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'.
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Guest Deny Full
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
</dev:code><dev:remarks><maml:para>This command removes all of the deny ACEs for the trustee from the security descriptor of the SMB share.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Remove the deny ACEs for a trustee without confirmation</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Unblock-SmbShareAccess -Name "VMFiles" -AccountName "Contoso\Guest" -Force
Name ScopeName AccountName AccessControlType AccessRight
---- --------- ----------- ----------------- -----------
VMFiles Contoso-SO Contoso\Administrator Allow Full
VMFiles Contoso-SO Contoso\Contoso-HV1$ Allow Full
</dev:code><dev:remarks><maml:para>This command removes all of the deny ACEs for the trustee from the security descriptor of the SMB share without user confirmation.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Block-SmbShareAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SmbShareAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Grant-SmbShareAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Revoke-SmbShareAccess</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Update-SmbMultichannelConnection</command:name><maml:description><maml:para>Forces the SMB client to update the multi-channel-related information.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Update</command:verb><command:noun>SmbMultichannelConnection</command:noun><dev:version /></command:details><maml:description><maml:para>The Update-SmbMultichannelConnection cmdlet forces the Server Message Block (SMB) client to update the multi-channel-related information. To do this, the SMB client communicates with one or more servers to which it is connected to get the latest information about the network interfaces that is shared. If you specify a server name, the SMB client communicates with only that server to get the information. If no parameter is specified, the SMB client communicates with all of the servers to which it is connected.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Update-SmbMultichannelConnection</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies the name of the server to which to connect from the SMB client to get the latest information about the network interfaces it has.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Int32</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies the name of the server to which to connect from the SMB client to get the latest information about the network interfaces it has.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Update multi-channel-related information</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Update-SmbMulitchannelConnection
</dev:code><dev:remarks><maml:para>This command forces the SMB client to update the multi-channel-related information.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Update multi-channel-related information for an SMB server</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Update-SmbMultichannelConnection -ServerName "Contoso-SO"
</dev:code><dev:remarks><maml:para>This command forces the SMB client to update the multi-channel-related information for the SMB server named Contoso-SO.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Get-SmbMultichannelConnection</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command>
</helpItems>