Get-HpcNodeTemplate

Gets a node template for an HPC cluster.

Syntax

Get-HpcNodeTemplate
   [[-Name] <String[]>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

The Get-HpcNodeTemplate cmdlet gets one or more specified node templates, or gets all of the node templates for an HPC cluster. You can specify the node templates by name. If you do not specify any node templates, the Get-HpcNodeTemplate cmdlet gets all of the node templates for the specified HPC cluster.

Examples

Example 1: Get all node templates for a head node

PS C:\>Get-HpcNodeTemplate -Scheduler MyHeadNode

This command gets all of the node templates for the HPC cluster with a head node named MyHeadNode.

Example 2: Get a node template by name

PS C:\>Get-HpcNodeTemplate -Name MyNodeTemplate

This command gets the node template named MyNodeTemplate.

Example 3: Get multiple node templates

PS C:\>Get-HpcNodeTemplate -Name "NodeTemplate01,NodeTemplate02"

This command gets the node templates named NodeTemplate01 and NodeTemplate02.

Optional Parameters

-ClusterConnectionString

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.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies an array of the names of the node templates that you want to get.

Type:String[]
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scheduler

Specifies the host name or IP address of the head node for the cluster that includes the node templates. 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\>

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

HpcNodeTemplate[]

Notes

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