Get-HpcNodeTemplate

Gets one or more specified node templates, or gets all of the node templates for an HPC cluster.

Syntax

Copy Code
Parameter Set: Default

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


Detailed Description

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 cmdlets gets all of the node templates for the specified HPC cluster.

Parameters

-Name<String[]>

Specifies a list of the names of the node templates that you want to get.


Aliases

none

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-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

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

  • None.

Outputs

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

  • One or more HpcNodeTemplate objects.

Notes

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

Examples

EXAMPLE 1

Gets all of the node templates for the HPC cluster with a head node named MyHeadNode.


  Copy Code
Get-HpcNodeTemplate -Scheduler MyHeadNode

EXAMPLE 2

Gets the node template named MyNodeTemplate.


  Copy Code
Get-HpcNodeTemplate -Name MyNodeTemplate

EXAMPLE 3

Gets the node templates named NodeTemplate1 and NodeTemplate2.


  Copy Code
Get-HpcNodeTemplate -Name NodeTemplate1,NodeTemplate2

Related topics