Edit

Share via


Get-ClusterAccess

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

Syntax

Default (Default)

Get-ClusterAccess
    [[-User] <StringCollection>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

Description

The Get-ClusterAccess cmdlet gets information about permissions that control access to a failover cluster.

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

Examples

Example 1

PS C:\> 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

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

Parameters

-Cluster

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the cluster on which to enumerate cluster access details.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-User

Specifies the user for which to get cluster access.

Parameter properties

Type:StringCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterAccessRule