Get-ClusterAccess
Get-ClusterAccess
Gets information about permissions that control access to a failover cluster.
Syntax
Parameter Set: InputObject
Get-ClusterAccess [[-User] <StringCollection> ] [-Cluster <String> ] [-InputObject <PSObject> ] [ <CommonParameters>]
Detailed 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.
Parameters
-Cluster<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the cluster on which to enumerate cluster access details.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-User<StringCollection>
Specifies the user for which to get cluster access.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterAccessRule
Examples
Example 1
This example lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access.
PS C:\> Get-ClusterAccess