Get-HpcMember

Get-HpcMember

Gets a member for the HPC cluster.

Syntax

Parameter Set: Default
Get-HpcMember [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-Role {user | administrator | jobadministrator | joboperator}[] ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of members for which you want to get information or HpcMember objects. Use the domain\user_name format to specify a member. If someone belongs to more than one role, the Get-HpcMember cmdlet gets entries for each role, unless you also specify the Role parameter.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Role<String[]>

Specifies an array of roles for the members for which you want to get information or HpcMember objects. Valid values are: User, Administrator.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

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

  • HpcMember[]

Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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 Roles.

Examples

Example 1: Get all users and administrators

This command gets all of the users and administrators for the HPC cluster.


PS C:\> Get-HpcMember

Example 2: Get administrators by head node

This command gets all of the administrators for the HPC cluster with a head node named HeadNode.


PS C:\> Get-HpcMember -Role "Administrator" -Scheduler "HeadNode"

Example 3: Get a member by name

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


PS C:\> Get-HpcMember -Name "CONTOSO\PattiFuller"

Example 4: Get all users for a domain

This command gets all of the users for the HPC cluster that belong to the domain named CONTOSO.


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

Related topics

Community Additions

ADD
Show: