Remove-ClusterAccess
Remove-ClusterAccess
Removes a user from the access list on the cluster.
Syntax
Parameter Set: InputObject
Remove-ClusterAccess [[-User] <StringCollection> ] [-Cluster <String> ] [-InputObject <PSObject> ] [ <CommonParameters>]
Detailed Description
The Remove-ClusterAccess cmdlet removes a user from the access list on the cluster. 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<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 from which to remove 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 which to remove 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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This example removes the user johnj99 in the contoso domain from the access list of the local cluster. After this cmdlet runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster.
PS C:\> Remove-ClusterAccess –User contoso\johnj99