Get-FileShareAccessControlEntry

Retrieves an access control entry for the share corresponding to a single account.

Syntax

Get-FileShareAccessControlEntry
   -Name <String[]>
   [-FileServer <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-FileShareAccessControlEntry
   -UniqueId <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-FileShareAccessControlEntry
   -InputObject <CimInstance[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-FileShareAccessControlEntry cmdlet retrieves an access control entry for the share corresponding to a single account. You must have local administrator permissions on the specified server to run this cmdlet.

Examples

Example 1: Get the access control entry for a share on a file server

PS C:\>Get-FileShareAccessControlEntry -Name "VirtualMachines" -FileServer (Get-StorageFileServer -FriendlyName "FileServer01")

This command gets the access control entry for the VirtualMachines share on the FileServer01 file server. You must have local administrator permissions on the specified server to run this command. The command uses the Get-StorageFileServer to get the file server.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FileServer

Specifies the file server which hosts the file share that this cmdlet gets. To obtain a FileServer object, use the Get-StorageFileServer cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of an object or setting.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UniqueId

Specifies the UniqueId of the file share.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).