Export (0) Print
Expand All

New-HpcNodeTemplate

Creates a new node template and optionally associates an operating system image with the node template.

Syntax

New-HpcNodeTemplate [-AdminCredential <PSCredential>] [-Description <string>] [-Image <HpcImage>] [-Multicast] [-ProductKey <string>] [-Scheduler <string>] [-UpdateCategory <UpdateCategory>] [-UpdateName <string[]>] [-Name] <string> [<CommonParameters>]

New-HpcNodeTemplate [-AdminCredential <PSCredential>] [-Description <string>] [-ImageName <string>] [-Multicast] [-ProductKey <string>] [-Scheduler <string>] [-UpdateCategory <UpdateCategory>] [-UpdateName <string[]>] [-WimFileName <string>] [-Name] <string> [<CommonParameters>]

New-HpcNodeTemplate [-Description <string>] [-Scheduler <string>] [-UpdateCategory <UpdateCategory>] [-UpdateName <string[]>] [-Name] <string> [<CommonParameters>]

Detailed Description

Creates a new node template and optionally associates an operating system image with the node template.

Parameters

-AdminCredential <PSCredential>

Specifies a PSCredential object for the administrator credential you want to use when deploying the node. Use the Get-Credential cmdlet to get a PSCredential object.

The user name for this credential must be Administrator. You can only specify this parameter if you specified an image for the node template by specifying the Image or ImageName parameter. If you do not specify the AdminCredential paramerter when you specify an image for the node template, the New-HpcNodeTemplate cmdlet automatically generates the credentials and password for the Administrator.

 

Required?

false

Position?

named

Default Value

autogenerated Administrator credentials

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description <string>

Specifies a description to use for the node template.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Image <HpcImage>

Specifies an HpcImage object for the operating system image that you want to associate with the new node template. When you deploy a compute node with the node template, the deployment process installs the operating system from this image. Use the Get-HpcImage cmdlet to get an HpcImage object for an operating system image. You cannot specify the Image parameter if you specify either the ImageName parameter or both the ImageName and WimFileName parameters.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-ImageName <string>

Specifies the name of the operating system image that you want to associate with the new node template. When you deploy a compute node with the node template, the deployment process installs the operating system from this image. Use the Get-HpcImage cmdlet to view the names of the available operating system images.

You cannot specify both the ImageName and Image parameters. If you specify a name for the ImageName parameter that operating system images in multiple Windows Image (.wim) files share, you must also specify the name of the .wim file with the WimFileName parameter.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-Multicast

Multicasts the operating system image during the deployment of nodes associated with the new node template. You can only specify the Multicast parameter if you also specify either the Image or ImageName parameter.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name <string>

Specifies the name to use for the new node template. The maximum length of the name is 250 characters.

 

Required?

true

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProductKey <string>

Specifies a product key to use to activate the operating system on nodes associated with the node template. The format of the product key consists of five groups of five alphanumeric characters separated by hyphens (-). You can only specify the ProductKey parameter if you also specify either the Image or the ImageName parameter.

 

Required?

false

Position?

named

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 to which you want to add the node template. 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

-UpdateCategory <UpdateCategory>

Specifies the category of updates to apply when you update or deploy a node associated with the node template. The valid values are All, Critical, and None. Specify All to apply all updates, Critical to apply only critical updates, or None to not apply updates at all.

 

Required?

false

Position?

named

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UpdateName <string[]>

Specifies a list of the names of updates to apply when you update or deploy a node associated with the node template. Specify each of the updates by using the Microsoft Knowledge Base number for the update.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WimFileName <string>

Specifies the name of the Windows Image (.wim) file that contains the image. You cannot specify both the WimFileName and Image parameters. If you specify the WinFileName parameter, you must also specify the ImageName parameter.

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

<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 HpcImage object.

Return Type

An HpcNodeTemplate object.

Example 1

C:\PS>New-HpcNodeTemplate -Name MyNodeTemplate

Creates a new node template named MyNodeTemplate.

Example 2

C:\PS>New-HpcNodeTemplate -Name TestNodeTemplate -Description "Template for testing."

Creates a new node template that is named TestNodeTemplate and has a description of "Template for testing."

Example 3

C:\PS>New-HpcNodeTemplate -Name NodeTemplate1 -ImageName MyImage -Multicast -ProductKey 12345-67890-ABCDE-FGHIJ-KLMNO

Creates a new node template named NodeTemplate1 and associates the operating system image named MyImage with the node template. This example also specifies that the deployment process should multicast the operating system image, and specifies a product key for activating the operating system. This example requires that the HPC cluster has only one image named MyImage.

Example 4

C:\PS>New-HpcNodeTemplate -Name NodeTemplate2 -ImageName MyImage -WimFileName MyImages.wim -UpdateCategory Critical

Creates a new node template named NodeTemplate2 and associates the operating system image named MyImage from the Windows Image (.wim) file named MyImages.wim with the node template. This example also specifies that only critical updates should be applied when you deploy or update nodes associated with the node template.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft