Edit

Share via

Remove-ClusterAccess

Module:
FailoverClusters Module

Removes a user from the access list on the cluster.

Syntax

Default (Default) 

Remove-ClusterAccess
    [[-User] <StringCollection>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

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.

Examples

Example 1

Remove-ClusterAccess -User contoso\johnj99

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.

Parameters

-Cluster

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the cluster from which to remove access for the given user.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-User

Specifies the user for which to remove cluster access.

Parameter properties

Type:StringCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.