Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-HpcMember

Gets one or more specified users and administrators for the HPC cluster, or gets all members of one or more specified roles. If you do not specify any users, administrators, or roles, the Get-HpcMember cmdlet gets all of the users and administrators for the HPC cluster.

Syntax

Get-HpcMember [-Role <string[]>] [-Scheduler <string>] [[-Name] <string[]>] [<CommonParameters>]

Detailed Description

Gets one or more specified users and administrators for the HPC cluster, or gets all members of one or more specified roles. If you do not specify any users, administrators, or roles, the Get-HpcMember cmdlet gets all of the users and administrators for the HPC cluster.

Parameters

-Name <string[]>

Specifies a list of one or more names for the users or administrators for which you want to get information or HpcMember objects. Use the domain\user_name format to specify a user or administrator. If someone belongs to both the user and administrator roles, the Get-HpcMember cmdlet gets two entries for that person, one for each role, unless you also specify the Role parameter.

 

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-Role <string[]>

Specifies a list of one or more roles for the members for which you want to get information or HpcMember objects. The valid roles are user and administrator.

 

Required?

false

Position?

named

Default Value

user,administrator

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 that includes the members. 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>

 

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.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

 

Input Type

One or more HpcMember objects, through their Name and Role properties.

Return Type

One or more HpcMember objects.

Example 1

C:\PS>Get-HpcMember

Gets all of the users and administrators for the HPC cluster.

Example 2

C:\PS>Get-HpcMember -Role administrator -Scheduler HeadNode

Gets all of the administrators for the HPC cluster with a head node named HeadNode.

Example 3

C:\PS>Get-HpcMember -Name CONTOSO\someone

Gets the user or administrator with a user name of someone in the CONTOSO domain. If CONTOSO\someone is both a user and an administrator, the cmdlet gets two entries or HpcMember objects for CONTOSO\someone.

Example 4

C:\PS>Get-HpcMember -Name CONTOSO\* -Role user

Gets all of the users for the HPC cluster that belong to the domain named CONTOSO.

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.