Block-ClusterAccess
Block-ClusterAccess
Prevents the specified user or users from accessing a failover cluster.
Syntax
Parameter Set: InputObject
Block-ClusterAccess [-User] <StringCollection> [-Cluster <String> ] [-InputObject <PSObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Block-ClusterAccess cmdlet prevents the specified user or users from accessing a failover cluster. If you do not want to completely block access and instead want to limit a user to using Windows PowerShell® to view cluster settings (not change settings), then use the Grant-ClusterAccess cmdlet with the Readonly parameter.
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 block access for the given user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-User<StringCollection>
Specifies the user for whom to block cluster access.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -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.
Examples
Example 1
This example prevents the user named johnj99 on the contoso domain from gaining access to the local cluster.
PS C:\> Block-ClusterAccess –User contoso\johnj99