Skip to content

Latest commit

 

History

History
127 lines (94 loc) · 2.61 KB

File metadata and controls

127 lines (94 loc) · 2.61 KB
external help file Module Name online version schema
Failoverv2_Cmdlets.xml
FailoverClusters
2.0.0

Block-ClusterAccess

SYNOPSIS

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

SYNTAX

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

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
Parameter Sets: (All)
Aliases: 

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

-InputObject

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

Type: PSObject
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-User

Specifies the user for whom to block cluster access.

Type: StringCollection
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

INPUTS

Microsoft.FailoverClusters.PowerShell.Cluster

OUTPUTS

NOTES

RELATED LINKS

Get-ClusterAccess

Grant-ClusterAccess

Remove-ClusterAccess