Add-HpcMember

Adds one or more specified users or administrators to the HPC cluster.

Syntax

	Copy Code
Parameter Set: Default Add-HpcMember [-Name] <String[]> [-Role <String> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Add-HpcMember [-Name] <String[]> [-Role <String> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Adds one or more specified users or administrators to the HPC cluster. 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 names for the users or administrators that you want to add to the HPC cluster. Use the domain\user_name format to specify a user or administrator.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Accept Wildcard Characters?	true

-Role<String>

Specifies the role to which you want to add the member. The valid roles are user and administrator. If you do not specify a role, the default role is user.

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.

Examples

EXAMPLE 1

Adds the account with a user name of someone and a domain of CONTOSO to the HPC cluster as a user.

	Copy Code
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.

	Copy Code
Add-HpcMember -Name CONTOSO\user1,CONTOSO\user2 -Role Administrator