Get-HpcNode

Get-HpcNode

Gets nodes in the HPC cluster.

Syntax

Parameter Set: node
Get-HpcNode [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-Group <HpcGroup> ] [-GroupName <String[]> ] [-Health <NodeHealth[]> ] [-HealthState <NodeHealthState[]> ] [-Location <String[]> ] [-Scheduler <String[]> ] [-State <ClusterNodeState[]> ] [-TemplateName <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-HpcNode cmdlet gets one or more nodes in the HPC cluster that meet the specified criteria for name, group, location, node template, node health, or node state.

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

-Group<HpcGroup>

Specifies the HpcGroup object for the node group that contains the nodes that you want to get.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-GroupName<String[]>

Specifies an array of names for the node groups that contain the nodes that you want to get. The cmdlet gets nodes only once if they belong to multiple groups.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Health<NodeHealth[]>

Specifies an array of the health values for the nodes that you want to get. The cmdlet gets the nodes that have a health value that matches any value on the list. Valid values are:

-- OK
-- Unreachable
-- OngoingOperation
-- DiagnosticFailed
-- ProvisioningFailed


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HealthState<NodeHealthState[]>

Specifies an array of node health values for the nodes that you want to get. The cmdlet gets the nodes that have a node health values that matches any value in the list. Valid values are:

-- Error
-- OK
-- Transitional
-- Unapproved
-- Warning

This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Location<String[]>

Specifies an array of locations for the nodes that you want to get. A location is a string with a format of \<DataCenter>[\<Rack>[\<Chassis>]]. The cmdlet gets the nodes that have a location that matches any location on the list.

The location must begin with a backslash (\). If you include the <Rack> or secondary location part of the string, you must also include the <DataCenter> or primary location. If you include the <Chassis> or tertiary location part of the string, you must also specify the <Rack> or secondary location plus the <DataCenter> or primary location. Each part of the string has a maximum length of 256 characters.

If you specify only the <DataCenter> or primary location part of the location, the cmdlet gets all of the nodes that have the specified <DataCenter> or primary location, regardless of their <Rack> or secondary location and <Chassis> or tertiary location values. If you specify only the <DataCenter> or primary location and the <Rack> or secondary location, the cmdlet gets all of the nodes that have the specified <DataCenter> or primary location and the specified <Rack> or secondary location, regardless of their <Chassis> or tertiary location values.

This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for the nodes that you want to get.


Aliases

none

Required?

false

Position?

1

Default Value

none

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-State<ClusterNodeState[]>

Specifies the states of the nodes that you want to get. The state of a node reflects the deployment state of the node and whether or not an administrator wants the node to be available as a resource for cluster jobs. The cmdlet gets the nodes that have a state that matches any value in the list. The acceptable values for this parameter are:

-- Unknown
-- Provisioning
-- Offline
-- Starting
-- Online
-- Draining
-- Rejected
-- Removing
-- NotDeployed
-- Stopping


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TemplateName<String[]>

Specifies an array of names for the node templates that are associated with the nodes that you want to get.


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.

  • HpcGroup

Outputs

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

  • HpcNode[]

Notes

  • The behavior of this parameter was changed in Windows HPC Pack 2008 R2 so that when you provision nodes from bare metal the nodes are not assigned to any node groups until provisioning is complete.

  • You must be a cluster administrator to run this cmdlet successfully.

Examples

Example 1: Get nodes by template

This command 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.


PS C:\> Get-HpcNode -TemplateName "ApplicationA"

Example 2: Get nodes by health state

This command gets all healthy nodes.


PS C:\> Get-HpcNode -HealthState OK

Example 3: Get nodes by state

This command gets all of the nodes that have a state of Offline or Rejected.


PS C:\> Get-HpcNode -State Offline,Rejected

Example 4: Get nodes by location

This command gets all of the nodes that are located in data center 01, regardless of their rack or chassis locations.


PS C:\> Get-HpcNode -Location "\datacenter01"

Related topics

Community Additions

ADD
Show: