Edit

Share via

Block-ClusterAccess

  • Reference
Module:
FailoverClusters

Prevents the specified user or users from accessing a failover cluster.

Syntax

Block-ClusterAccess
     [-User] <StringCollection>
     [-InputObject <PSObject>]
     [-Cluster <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

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.

Examples

Example 1

PS C:\> Block-ClusterAccess -User contoso\johnj99

This example prevents the user named johnj99 on the contoso domain from gaining access to the local 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster on which to block access for the given user.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-User

Specifies the user for whom to block cluster access.

Type:StringCollection
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster