Export-HpcDHCPReservations

Export-HpcDHCPReservations

Saves information about the DHCP reservations.

Syntax

Parameter Set: AllNode
Export-HpcDHCPReservations -Path <String> [-ClusterConnectionString <String[]> ] [-Force] [-Scheduler <String[]> ] [ <CommonParameters>]

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

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




Detailed 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.

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

-Force

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

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.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Path<String>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

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>


Aliases

none

Required?

false

Position?

named

Default Value

none

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.

  • HpcNode

Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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.

Examples

Example 1: Export DHCP reservations for all nodes

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.


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

Example 2: Export DHCP reservations for named nodes

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


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

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

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.


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

Related topics

Community Additions

ADD
Show: