SmbShare Module
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.
SmbShare Cmdlets
| Cmdlet | Description |
|---|---|
| Block-SmbClientAccessToServer |
Blocks SMB client access to a specified server. |
| Block-SmbShareAccess |
Adds a deny ACE for a trustee to the security descriptor of the SMB share. |
| Close-SmbOpenFile |
Closes a file that is open by one of the clients of the SMB server. |
| Close-SmbSession |
Ends forcibly the 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-SmbClientAccessToServer |
Gets information about SMB client access to a specified server. |
| Get-SmbClientCertificateMapping |
Retrieves the client certificate mappings for the Server Message Block (SMB) protocol. |
| Get-SmbClientConfiguration |
Retrieves the SMB client configuration. |
| Get-SmbClientNetworkInterface |
Retrieves the network interfaces used by the SMB client. |
| Get-SmbConnection |
Retrieves the connections established from the SMB client to the SMB servers. |
| Get-SmbDelegation |
Gets the constrained delegation authorizations for an SMB client. |
| Get-SmbGlobalMapping |
Retrieves the properties of a Server Message Block (SMB) global mapping. |
| Get-SmbMapping |
Retrieves the SMB client directory mappings created for a server. |
| Get-SmbMultichannelConnection |
Retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces. |
| Get-SmbMultichannelConstraint |
Retrieves the constraints that define how the 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 SMB server. |
| Get-SmbServerAlternativePort |
Gets the alternative ports configured for the Server Message Block (SMB) protocol on the local server. |
| Get-SmbServerCertificateMapping |
Retrieves a certificate associated with the SMB server for SMB over QUIC. |
| Get-SmbServerCertProps |
Retrieves an SMB over QUIC-mapped certificate's properties and tests certificate validity. |
| Get-SmbServerConfiguration |
Retrieves the SMB server configuration. |
| Get-SmbServerNetworkInterface |
Retrieves the network interfaces used by the SMB server. |
| Get-SmbSession |
Retrieves information about the SMB sessions that are currently established between the SMB server and the associated clients. |
| Get-SmbShare |
Retrieves the SMB shares on the computer. |
| Get-SmbShareAccess |
Retrieves the ACL of the SMB share. |
| Grant-SmbClientAccessToServer |
Allow access to a computer or set of computers for SMB over QUIC's client access control feature on an SMB Server. |
| Grant-SmbShareAccess |
Adds an allow access control entry (ACE) for a trustee to the security descriptor of the Server Message Block (SMB) share. |
| New-SmbClientCertificateMapping |
Creates a new client certificate mapping for the Server Message Block (SMB) protocol. |
| New-SmbGlobalMapping |
Creates an SMB global mapping. |
| New-SmbMapping |
Creates an SMB mapping. |
| New-SmbMultichannelConstraint |
Creates an SMB multi-channel constraint for the specified server. |
| New-SmbServerAlternativePort |
Creates a new alternative port for the Server Message Block (SMB) protocol on the local server. |
| New-SmbServerCertificateMapping |
Creates a certificate association with the SMB server for SMB over QUIC. |
| New-SmbShare |
Creates an SMB share. |
| Remove-SmbBandwidthLimit |
Removes SMB bandwidth caps. |
| Remove-SmbClientCertificateMapping |
Removes an existing client certificate mapping for the Server Message Block (SMB) protocol. |
| Remove-SmbComponent |
Removes SMB1 components. |
| Remove-SmbGlobalMapping |
Removes a Server Message Block (SMB) global mapping to an SMB share. |
| Remove-SmbMapping |
Removes the SMB mapping to an SMB share. |
| Remove-SmbMultichannelConstraint |
Removes SMB multi-channel constraints. |
| Remove-SmbServerAlternativePort |
Removes an alternative port for the Server Message Block (SMB) protocol on the local server. |
| Remove-SmbServerCertificateMapping |
Removes a certificate mapping from the SMB server for SMB over QUIC. |
| Remove-SmbShare |
Deletes the specified SMB shares. |
| Reset-SmbClientConfiguration |
Resets the Server Message Block (SMB) client configuration parameters to their default values. |
| Reset-SmbServerConfiguration |
Resets the Server Message Block (SMB) server configuration parameters to their default values. |
| Revoke-SmbClientAccessToServer |
Revokes SMB client access to a specified server. |
| Revoke-SmbShareAccess |
Removes all of the allow ACEs for a trustee from the security descriptor of the SMB share. |
| Set-SmbBandwidthLimit |
Adds an SMB bandwidth cap. |
| Set-SmbClientCertificateMapping |
Configures an existing client certificate mapping for the Server Message Block (SMB) protocol. |
| Set-SmbClientConfiguration |
Sets the SMB client configuration. |
| Set-SmbPathAcl |
Sets the ACL for the file system folder to match the ACL used by an SMB share. |
| Set-SmbServerAlternativePort |
Configures the alternative ports for the Server Message Block (SMB) protocol on the local server. |
| Set-SmbServerCertificateMapping |
Modifies a certificate association with the SMB server for SMB over QUIC. |
| Set-SmbServerConfiguration |
Sets the Server Message Block (SMB) server configuration. |
| Set-SmbShare |
Modifies the properties of the SMB share. |
| Unblock-SmbClientAccessToServer |
Unblocks SMB client access to a previously blocked server. |
| Unblock-SmbShareAccess |
Removes all of the deny ACEs for the trustee from the security descriptor of the SMB share. |
| Update-SmbMultichannelConnection |
Forces the SMB client to update the multi-channel-related information. |