Export-HpcDHCPReservations

Reference

Module:: HPCPack2019

Saves information about the DHCP reservations.

Syntax

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

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

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

Description

The Export-HpcDHCPReservations cmdlet saves information about the Dynamic Host Configuration Protocol (DHCP) reservations for the specified node to the specified XML file, or for all of the nodes in the cluster if none are specified. You can specify the nodes by name or by HpcNode objects that represent the nodes.

DHCP reservations of IP addresses are based on media access control (MAC) addresses. Each reserved IP address is linked to the MAC address of the network adapter to which that IP address is assigned.

Examples

Example 1: Export DHCP reservations for all nodes

PS C:\>Export-HpcDHCPReservations -Path "C:\Reservations\AllNodes.xml"

This command saves information about the DHCP reservations for all of the compute nodes in the cluster to the file at C:\Reservations\AllNodes.xml.

Example 2: Export DHCP reservations for named nodes

PS C:\>Export-HpcDHCPReservations -Node ComputeNode1,ComputeNode2 -Path "C:\Reservations\ComputeNodes01and02.xml"

This command saves information about the DHCP reservations for the compute nodes named ComputeNode01 and ComputeNode02 to the file at C:\Reservations\ComputeNodes01and02.xml.

Example 3: Get a node and export DHCP reservations for it

PS C:\>Get-HpcNode -Name "ComputeNode04" | Export-HpcDHCPReservations -Path "C:\Reservations\ComputeNode04.xml" -Force

This command gets the HpcNode object for the compute node named ComputeNode04, and then specifies that object in the Export-HpcDHCPReservations cmdlet to save information about the DHCP reservations for that node to the file at C:\Reservations\ComputeNode04.xml. This example overwrites the file without prompting the user if the file already exists.

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 specified XML file if it already exists, without prompting the user.

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 the nodes for which you want to export DHCP reservations. You cannot specify both the Name and Node parameters. To get the nodes for the HPC cluster, use the Get-HpcNode cmdlet.

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

-Node

Specifies an array of the nodes for which you want to export DHCP reservations. You cannot specify both the Node and Name parameters. To get an HpcNode object for a node, use the Get-HpcNode command.

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 in which you want to save the information about the DHCP reservations for the nodes, including the full or relative path to the file, if the Export-HpcDCHPReservations cmdlet should not save the file in the current directory.

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 of the HPC cluster for which you want to export DHCP reservations. 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 must be a cluster administrator to run this cmdlet successfully.
This cmdlet was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Export-HpcNodeXml