Grant-ClusterAccess
Grants access to a failover cluster, either full access or read-only access.
Syntax
Default (Default)
Grant-ClusterAccess
[-User] <StringCollection>
[-Full]
[-ReadOnly]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
Description
The Grant-ClusterAccess cmdlet grants access to a failover cluster, either full access or read-only access. To provide someone with read-only access to the cluster, use the ReadOnly parameter.
Examples
Example 1
PS C:\> Grant-ClusterAccess -User contoso\johnj99 -Full
This example grants full access to the local cluster to johnj99 in the contoso domain.
Example 2
PS C:\> Grant-ClusterAccess -User contoso\johnj99 -ReadOnly
This example grants read-only access to the local cluster to johnj99 in the contoso domain.
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 |
-Full
Specifies that the user gets full cluster access. If no access level is specified, then the user gets read-only cluster access.
Parameter properties
| Type: | SwitchParameter |
| 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 on which to grant 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 |
-ReadOnly
Specifies that the user gets read-only cluster access. If no access level is specified, then the user gets read-only cluster access.
Parameter properties
| Type: | SwitchParameter |
| 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 |
-User
Specifies the user for whom to grant cluster access.
Parameter properties
| Type: | StringCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| 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.