Get-HpcMember
Syntax
 Copy Code |
|
|---|---|
Parameter Set: Default Get-HpcMember [[-Name] <String[]> ] [-Role <String[]> ] [-Scheduler <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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
no default |
|
Accept Pipeline Input? |
true (ByValue, 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.
|
Aliases |
none |
|
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>
|
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.
- One or more HpcMember objects, through their Name and Role properties.
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
Gets all of the users and administrators for the HPC cluster.
| Copy Code |
|
|---|---|
Get-HpcMember |
|
EXAMPLE 2
Gets all of the administrators for the HPC cluster with a head node named HeadNode.
| Copy Code |
|
|---|---|
Get-HpcMember -Role administrator -Scheduler HeadNode |
|
EXAMPLE 3
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.
| Copy Code |
|
|---|---|
Get-HpcMember -Name CONTOSO\someone |
|
EXAMPLE 4
Gets all of the users for the HPC cluster that belong to the domain named CONTOSO.
| Copy Code |
|
|---|---|
Get-HpcMember -Name CONTOSO\* -Role user |
|