< Back
Get-SmbShareAccess
Post
NAME Get-SmbShareAccess
SYNOPSIS
Retrieves the ACL of the SMB share.
SYNTAX
Get-SmbShareAccess [-Name] <String[]> [[-ScopeName] <String[]>] [-CimSession <CimSession[]>] [-SmbInstance {Default | CSV}] [-ThrottleLimit <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
Get-SmbShareAccess [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-CimSession [<CimSession[]>]
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 New-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the SMB share for which the access rights are retrieved.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScopeName [<String[]>]
Specifies the scope of the share by name.
Required? false
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SmbInstance [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance>]
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry
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.
Example 1: Get the ACL of a share
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
This command retrieves the ACL of an SMB share named VMFiles.
Example 2: Get the ACL of a share for a server
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
This command displays the information about the ACL of an SMB share named VMFiles connected to the SMB server named Contoso-SO.
RELATED LINKS
Block-SmbShareAccess
Grant-SmbShareAccess
Revoke-SmbShareAccess
Unblock-SmbShareAccess
SYNOPSIS
Retrieves the ACL of the SMB share.
SYNTAX
Get-SmbShareAccess [-Name] <String[]> [[-ScopeName] <String[]>] [-CimSession <CimSession[]>] [-SmbInstance {Default | CSV}] [-ThrottleLimit <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
Get-SmbShareAccess [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-CimSession [<CimSession[]>]
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 New-CimSession or
Get-CimSession cmdlet. The default is the current session on the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies the name of the SMB share for which the access rights are retrieved.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScopeName [<String[]>]
Specifies the scope of the share by name.
Required? false
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SmbInstance [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance>]
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbShareAccessControlEntry
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.
Example 1: Get the ACL of a share
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
This command retrieves the ACL of an SMB share named VMFiles.
Example 2: Get the ACL of a share for a server
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
This command displays the information about the ACL of an SMB share named VMFiles connected to the SMB server named Contoso-SO.
RELATED LINKS
Block-SmbShareAccess
Grant-SmbShareAccess
Revoke-SmbShareAccess
Unblock-SmbShareAccess