Add-HpcMember
Adds a domain account to the HPC cluster as a member in a cluster role.
Syntax
Default (Default)
Add-HpcMember
[-Name] <String[]>
[-Role <String>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Description
The Add-HpcMember cmdlet adds one or more domain accounts to the HPC cluster as members in a cluster role. If you do not specify a role, the Add-HpcMember cmdlet adds the specified accounts as users by default.
Examples
Example 1: Add a member by name
PS C:\>Add-HpcMember -Name "CONTOSO\PattiFuller"
This command adds the account with a user name of PattiFuller and a domain of CONTOSO to the HPC cluster as a user.
Example 2: Add multiple members
PS C:\>Add-HpcMember -Name "CONTOSO\user1,CONTOSO\user2" -Role "Administrator"
This command adds the accounts with user names of user1 and user2 in the CONTOSO domain to the HPC cluster as administrators.
Parameters
-ClusterConnectionString
Specifies an array of cluster connection strings for the cluster on which you perform the operation.
The value format is host1, host2, host3.
If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies.
To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>
This parameter was introduced in HPC Pack 2016.
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 |
-Name
Specifies an array of accounts that you want to add as members to the HPC cluster. Use the domain\user_name format.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Role
Specifies the role to which you want to add the member. Valid values are: User, Administrator. The default role is User.
The following additional roles were introduced in HPC Pack 2012 with Service Pack 1 (SP1): JobAdministrator and JobOperator. These roles are not supported in previous versions.
Starting with HPC Pack 2012 with SP1, a member can be added in more than one cluster role and is granted the union of the privileges of the roles.
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: | True |
| Value from remaining arguments: | False |
-Scheduler
Specifies the host name or IP address of the head node for the cluster to which you want to add the member. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:
Set-Content Env:CCP_SCHEDULER \<head_node_name\>
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 |
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.
Inputs
None
Outputs
HpcMember
Notes
- You must be a cluster administrator to run this cmdlet successfully.
- For information about user roles on the HPC cluster, see Understanding User Roleshttp://technet.microsoft.com/library/ff919445(v=ws.10).aspx on TechNet.