Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Block-ClusterAccess

Block-ClusterAccess

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

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

Detailed 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.

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

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

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

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-User <StringCollection>

Specifies the user for whom to block cluster access.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type


Notes

None

Examples

Example 1

This example prevents the user named johnj99 on the contoso domain from gaining access to the local cluster.

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

Online Version
Get-ClusterAccess
Grant-ClusterAccess
Remove-ClusterAccess