Remove-ClusterAccess
Remove-ClusterAccess
Removes a user from the access list on the cluster.
Syntax
Remove-ClusterAccess [-InputObject <psobject>] [[-User] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
InputObject
User
Cluster
Detailed Description
After this cmdlet is run, the user might still have access to the cluster if the user account is part of another user group which is on the cluster access list.
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 remove access for the given user from.
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 remove 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 |
Input Type
Return Type
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Remove-ClusterAccess CONTOSO\user2
Description
-----------
This command removes the user CONTOSO\user2 from the access list of the local cluster. After this command runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster.
See Also
Reference
Get-ClusterAccess
Grant-ClusterAccess
Block-ClusterAccess