Get-HpcNodeTemplate

Get-HpcNodeTemplate

Gets a node template for an HPC cluster.

Syntax

Parameter Set: Default
Get-HpcNodeTemplate [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed 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.

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 the names of the node templates 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 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>


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.

  • None

Outputs

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

  • HpcNodeTemplate[]

Notes

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

Examples

Example 1: Get all node templates for a head node

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


PS C:\> Get-HpcNodeTemplate -Scheduler MyHeadNode

Example 2: Get a node template by name

This command gets the node template named MyNodeTemplate.


PS C:\> Get-HpcNodeTemplate -Name MyNodeTemplate

Example 3: Get multiple node templates

This command gets the node templates named NodeTemplate01 and NodeTemplate02.


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

Related topics

Community Additions

ADD
Show: