Get-ClusterAccess

Get information about permissions that control access to a failover cluster.

Get-ClusterAccess [-InputObject <psobject>] [[-User] <StringCollection>] [-Cluster <string>] [<CommonParameters>]

InputObject
User
Cluster

A cluster can allow full access or read-only access. Read-only access limits the user to PowerShell cmdlets that provide information about the cluster.

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value:

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

InputObject

Specifies the cluster to enumerate cluster access details on.

Default Value:

Data Type: psobject

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	true (ByValue)	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

User

Specifies the user to get cluster access for.

Default Value:

Data Type: StringCollection

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	1	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterAccessRule

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Get-ClusterAccess 
 
IdentityReference              AccessControlType        ClusterRights 
-----------------              -----------------        ------------- 
CONTOSO\user1                               Deny                 Full 
NT AUTHORITY\SYSTEM                        Allow                 Full 
NT AUTHORITY\NETWORK SE...                 Allow                 Full 
BUILTIN\Administrators                     Allow                 Full 
CONTOSO\user2                              Allow                 Read 
NT SERVICE\MSDTC                           Allow                 Full

Description

-----------

This command lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access.

Reference

Block-ClusterAccess
Grant-ClusterAccess
Remove-ClusterAccess

Other Resources

Online version:

Get-ClusterAccess