Block-ClusterAccess
Block-ClusterAccess
Prevent the specified user or users from accessing a failover cluster.
Syntax
Block-ClusterAccess [-InputObject <psobject>] [-User] <StringCollection> [-Cluster <string>] [<CommonParameters>]
InputObject
User
Cluster
Detailed Description
If you do not want to completely block access and instead want to limit a user to using PowerShell to view cluster settings (not change settings), use Grant-ClusterAccess with the -readonly option.
Parameters
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 block access for the given user 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 block cluster access for.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
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 |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster
Return Type
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Block-ClusterAccess CONTOSO\user2
Description
-----------
This command prevents the user CONTOSO\user2 from gaining access to the local cluster.
See Also
Reference
Get-ClusterAccess
Grant-ClusterAccess
Remove-ClusterAccess