Export-HpcNodeXml

Reference

Module:: HPCPack2016

Exports information about compute nodes to an XML file.

Syntax

Export-HpcNodeXml
      -Path <String>
      [-Force]
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [<CommonParameters>]

Export-HpcNodeXml
      -Path <String>
      [-Force]
      [-Name] <String[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [<CommonParameters>]

Export-HpcNodeXml
      -Path <String>
      [-Force]
      -Node <HpcNode[]>
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [<CommonParameters>]

Description

The Export-HpcNodeXml cmdlet exports information about the specified compute nodes to an XML file. You can specify the compute nodes by name or by using HpcNode objects that you get with the Get-HpcNode cmdlet.

Examples

Example 1: Export a compute node

PS C:\>Export-HpcNodeXML -Name "ComputeNode01" -Path "C:\MyNodeXMLFiles\ComputeNode01.xml"

This command exports information about the compute node named ComputeNode01 to the XML file located at C:\MyNodeXMLFiles\ComputeNode01.xml.

Example 2: Get multiple nodes and export them

PS C:\>Get-HpcNode -Group NodeGroupA | Export-HpcNodeXML -Path "C:\MyNodeXMLFiles\NodeGroupA.xml" -Force

This command gets the HpcNode objects for the nodes in the NodeGroupA node group, and then exports information about those nodes to the XML file located at C:\MyNodeXMLFiles\NodeGroupA.xml. If this XML file already exists, the Export-HpcNodeXML cmdlet overwrites it without prompting.

Parameters

-ClusterConnectionString

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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies an array of the names of compute nodes that you want to export. You cannot specify both the Name and Node parameters.

Type:	String[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Node

Specifies an array of HpcNode objects for the compute nodes that you want to export. Use the Get-HpcNode cmdlet to get the HpcNode objects for the nodes. You cannot specify both the Node and Name parameters.

Type:	HpcNode[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

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

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.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Scheduler

Specifies the host name or IP address of the head node for the cluster that includes 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\>

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

HpcNode

Outputs

None

Notes

You cannot export a head node. You can import the node XML file later to add compute nodes to a cluster by using the Import-HpcNodeXml cmdlet. For example, if you export the information about the nodes to a node XML file with the Export-HpcNodeXML cmdlet, then remove those nodes from the cluster with the Remove-HpcNode cmdlet to upgrade them or perform maintenance on them, you can add the nodes back to the cluster by importing the node xml file.
You must be a cluster administrator to run this cmdlet successfully.