Import-HpcNodeXml

Import-HpcNodeXml

Imports nodes from the lists of nodes in one or more specified node XML files, and adds the nodes to the HPC cluster.

Syntax

Parameter Set: Default
Import-HpcNodeXml [-Path] <String[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Import-HpcNodeXml cmdlet imports nodes from the lists of nodes in one or more specified node XML files, and adds the nodes to the 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

-Path<String[]>

Specifies an array of names for node XML files from which you want to import nodes, including the relative or full path if the files are not in the current directory. The file name and path must be valid.


Aliases

none

Required?

true

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 to which you want to add the compute nodes. 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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

  • None

Notes

  • The Import-HpcNodeXML cmdlet skips any nodes that are already part of the HPC cluster and have a known state. You can use this cmdlet to update properties of nodes that are in the unknown state. The Import-HpcNodeXML cmdlet corresponds to the process of adding compute nodes under Configuration in HPC Cluster Manager. The cmdlet provisions the nodes and leaves the nodes in the offline state after provisioning is complete. You can bring the nodes online by running the Set-HpcNodeState cmdlet or by using HPC Cluster Manager.

  • For information about creating a node XML file that you can import, see Appendix 2: Creating a Node XML File (http://go.microsoft.com/fwlink/?LinkId=124145).

  • The built-in ConfirmImpact setting for this cmdlet is High. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$False. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$True.

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

Examples

Example 1: Import compute nodes

This command imports the compute nodes listed in the XML file located at C:\MyNodeXMLFiles\NewNodes.xml, and adds those nodes to the cluster.


PS C:\> Import-HpcNodeXML -Path "C:\MyNodeXMLFiles\NewNodes.xml"

Related topics

Show: