.png)
Get-HpcNode
Gets a list of one or more nodes in the HPC cluster that meet the specified criteria.
Syntax
Get-HpcNode [-Group <HpcGroup>] [-GroupName <string[]>] [-Health <NodeHealth[]>] [-Scheduler <string>] [-State <ClusterNodeState[]>] [-TemplateName <string[]>] [[-Name] <string[]>] [<CommonParameters>]
Detailed Description
Gets a list of one or more nodes in the HPC cluster that meet the specified criteria for name, group, health, node template, or node state.
Parameters
-Group <HpcGroup>
Specifies the HpcGroup object for the node group that contains the nodes that you want to get. You cannot specify both the Group and the GroupName parameters.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-GroupName <string[]>
Specifies a list of names for the node groups that contain the nodes that you want to get. The cmdlet gets nodes that belong to multiple groups only once. You cannot specify both the GroupName and the Group parameters.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Health <NodeHealth[]>
Specifies the health of the nodes that you want to get. The possible values for the Health parameter are OK, Unreachable, OngoingOperation, DiagnosticFailed, and ProvisioningFailed.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
the combination of all health values |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Name <string[]>
Specifies a list of one or more names for the nodes that you want to get.
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
no default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Scheduler <string>
Specifies the host name or IP address of the head node for the cluster that includes the nodes. 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 |
-State <ClusterNodeState[]>
Specifies the state of the nodes that you want to get. The possible values for the State parameter are Unknown, Provisioning, Offline, Starting, Online, Draining, Rejected, and Removing.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
the combination of all state values |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-TemplateName <string[]>
Specifies a list of names for the node templates associated with the nodes that you want to get.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
no default |
|
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 |
An HpcGroup object. |
|
Return Type |
One or more HpcNode objects. |
Example 1
C:\PS>Get-HpcNode -TemplateName "ApplicationA"
Gets all compute nodes that use the node template named ApplicationA. You can set up nodes to have a particular node template when you provision the nodes for a particular application.
Example 2
C:\PS>Get-HpcNode -Health OK
Gets all healthy nodes.
Example 3
C:\PS>Get-HpcNode -State Offline
Gets all offline nodes.
