Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

SMB Share Cmdlets in Windows PowerShell

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

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.

Server Message Block (SMB) Share

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.

 

cmdlet Description

Block-SmbShareAccess

Adds a deny access control entry (ACE) for a trustee to the security descriptor of the Server Message Block (SMB) share.

Close-SmbOpenFile

Forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server.

Close-SmbSession

Forcibly ends the Server Message Block (SMB) session.

Disable-SmbDelegation

Disables a constrained delegation authorization for an SMB client and server.

Enable-SmbDelegation

Enables a constrained delegation authorization for an SMB client and server.

Get-SmbBandwidthLimit

Gets the list of SMB bandwidth caps for each traffic category.

Get-SmbClientConfiguration

Retrieves the Server Message Block (SMB) client configuration.

Get-SmbClientNetworkInterface

Retrieves the network interfaces used by the Server Message Block (SMB) client.

Get-SmbConnection

Retrieves the connections established from the Server Message Block (SMB) client to the SMB servers.

Get-SmbDelegation

Gets the constrained delegation authorizations for an SMB client.

Get-SmbMapping

Retrieves the Server Message Block (SMB) client directory mappings created for a server.

Get-SmbMultichannelConnection

Retrieves the Server Message Block (SMB) connections made between the SMB client network interfaces and the SMB server network interfaces.

Get-SmbMultichannelConstraint

Retrieves the constraints that define how the Server Message Block (SMB) client uses network interfaces to connect to the servers.

Get-SmbOpenFile

Retrieves basic information about the files that are open on behalf of the clients of the Server Message Block (SMB) server.

Get-SmbServerConfiguration

Retrieves the Server Message Block (SMB) server configuration.

Get-SmbServerNetworkInterface

Retrieves the network interfaces used by the Server Message Block (SMB) server.

Get-SmbSession

Retrieves information about the Server Message Block (SMB) sessions that are currently established between the SMB server and the associated clients.

Get-SmbShare

Retrieves the Server Message Block (SMB) shares on the computer.

Get-SmbShareAccess

Retrieves the access control list (ACL) of the Server Message Block (SMB) share.

Grant-SmbShareAccess

Adds an allow access control entry (ACE) for a trustee to the security descriptor of the Server Message Block (SMB) share.

New-SmbMapping

Creates a new Server Message Block (SMB) mapping.

New-SmbMultichannelConstraint

Creates a new Server Message Block (SMB) multi-channel constraint for the specified server.

New-SmbShare

Creates a new Server Message Block (SMB) share.

Remove-SmbBandwidthLimit

Removes SMB bandwidth caps.

Remove-SmbMapping

Removes the Server Message Block (SMB) mapping to an SMB share.

Remove-SmbMultichannelConstraint

Removes one or more specified Server Message Block (SMB) multi-channel constraints, which determine the network interfaces to be used when connecting to specific servers.

Remove-SmbShare

Deletes the specified Server Message Block (SMB) shares.

Revoke-SmbShareAccess

Removes all of the allow access control entries (ACEs) for a trustee from the security descriptor of the Server Message Block (SMB) share.

Set-SmbBandwidthLimit

Adds an SMB bandwidth cap.

Set-SmbClientConfiguration

Sets the Server Message Block (SMB) client configuration.

Set-SmbPathAcl

Sets the ACL for the file system folder to match the ACL used by an SMB share.

Set-SmbServerConfiguration

Sets the Server Message Block (SMB) server configuration.

Set-SmbShare

Modifies the properties of the Server Message Block (SMB) share.

Unblock-SmbShareAccess

Removes all of the deny access control entries (ACEs) for the trustee from the security descriptor of the Server Message Block (SMB) share.

Update-SmbMultichannelConnection

Forces the Server Message Block (SMB) client to update the multi-channel-related information.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module SmbShare cmdlet.

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

More Information

For more information about the cmdlets, see the following:



Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.