Export (0) Print
Expand All

Export-HpcNodeTemplate

Creates an XML-based representation of a node template and stores it in a file.

Syntax

Export-HpcNodeTemplate [-Force] [-Scheduler <string>] -Path <string> [-Name] <string> [<CommonParameters>]

Export-HpcNodeTemplate [-Force] [-Scheduler <string>] -Path <string> -Template <HpcNodeTemplate> [<CommonParameters>]

Detailed Description

Creates an XML-based representation of a node template and stores it in a file.

Parameters

-Force

Replaces the node template file if it already exists, without prompting the user.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name <string>

Specifies the name of the node template that you want to export. You cannot specify both the Name and Template parameters.

 

Required?

true

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-Path <string>

Specifies a name for the XML file to which you want to export the node template, including the full or relative path to the file if the Export-HpcNodeTemplate cmdlet should not save the file in the current directory.

The maximum length for the path is 260 characters. The maximum length for the directory portion of the path is 248 characters.

This cmdlet creates any directories that do not already exist in that path. If the file already exists and you do not specify the Force parameter, the cmdlet prompts you to confirm whether or not you want to replace the file.

 

Required?

true

Position?

named

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>

 

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Template <HpcNodeTemplate>

Specifies an HpcNodeTemplate object for the node template that you want to export. Use the Get-HpcNodeTemplate cmdlet to get the HpcNodeTemplate object for a node template. You cannot specify both the Template and Name parameters.

 

Required?

true

Position?

named

Default Value

no default

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

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

Return Type

None.

Example 1

C:\PS>Export-HpcNodeTemplate -Name "Default ComputeNode Template" -Path C:\MyNodeTemplates\DefaultNodeTemplate.xml

Exports the default node template for compute nodes to the XML file located at C:\MyNodeTemplates\DefaultNodeTemplate.xml.

Example 2

C:\PS>Get-HpcNodeTemplate -Name MyNodeTemplate | Export-HpcNodeTemplate -Path C:\MyNodeTemplates\MyNodeTemplate.xml -Force

Gets the HpcNodeTemplate object for the node template named MyNodeTemplate, then exports that node template to the XML file located at C:\MyNodeTemplates\MyNodeTemplate.xml. If the file already exists, this example overwrites the file.

See Also

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

Community Additions

ADD
Show:
© 2014 Microsoft