Grant-ClusterAccess

Grant access to a failover cluster, either full access or read-only access.

Grant-ClusterAccess [-InputObject <psobject>] [-User] <StringCollection> [-Cluster <string>] [-Full] [-ReadOnly] [<CommonParameters>]

InputObject
User
Cluster
Full
ReadOnly

To provide someone with read-only access to the cluster, used the -readonly option.

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value:

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Full

Causes full cluster access to be given to the specified user. If no access level is specified the user gets read-only cluster access.

Default Value:

Data Type: SwitchParameter

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength

InputObject

Specifies the cluster to grant access for the given user on.

Default Value:

Data Type: psobject

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	true (ByValue)	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

ReadOnly

Causes read-only cluster access to be given to the specified user. This is the default access level given if no access level is specified.

Default Value:

Data Type: SwitchParameter

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength

User

Specifies the user to grant cluster access for.

Default Value:

Data Type: StringCollection

Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	1	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Microsoft.FailoverClusters.PowerShell.Cluster

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Grant-ClusterAccess CONTOSO\user1

Description

-----------

This command grants full access to the local cluster to user1 in the CONTOSO domain.

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Grant-ClusterAccess CONTOSO\user1 -readonly

Description

-----------

This command grants read-only access to the local cluster to user1 in the CONTOSO domain.

Reference

Block-ClusterAccess
Get-ClusterAccess
Remove-ClusterAccess

Other Resources

Online version:

Grant-ClusterAccess