Add-HpcMember
Add-HpcMember
Adds one or more domain accounts to the HPC cluster as members in a cluster role.
Syntax
Parameter Set: Default
Add-HpcMember [-Name] <String[]> [-Role <String> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
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.
Parameters
-Name<String[]>
Specifies a list of one or more accounts that you want to add as members to the HPC cluster. Use the domain\user_name format.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Role<String>
Specifies the role to which you want to add the member. The valid roles include user and administrator. If you do not specify a role, 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
user |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Scheduler<String>
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>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
%CCP_SCHEDULER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None.
Outputs
The output type is the type of the objects that the cmdlet emits.
- One or more HpcMember objects.
Notes
You must be a cluster administrator to run this cmdlet successfully.
For information about user roles on the HPC cluster, see Understanding User Roles.
Examples
EXAMPLE 1
Adds the account with a user name of someone and a domain of CONTOSO to the HPC cluster as a user.
PS C:\>Add-HpcMember -Name CONTOSO\someone
EXAMPLE 2
Adds the accounts with user names of user1 and user2 in the CONTOSO domain to the HPC cluster as administrators.
PS C:\>Add-HpcMember -Name CONTOSO\user1,CONTOSO\user2 -Role Administrator