Add-DhcpServerv6Reservation

Add-DhcpServerv6Reservation

Adds an IPv6 Reservation to an IPv6 prefix or scope.

Syntax

Parameter Set: Add0
Add-DhcpServerv6Reservation [-Prefix] <IPAddress> [-IPAddress] <IPAddress> [-ClientDuid] <String> [-Iaid] <UInt32> [[-Name] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Description <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Add-DhcpServerv6Reservation cmdlet reserves a specified IPv6 address for the client identified by the specified Dynamic Host Configuration Protocol (DHCP) v6 unique identifier (ID) (DUID) and identity association ID (IAID).

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClientDuid<String>

Specifies the DUID of the client.


Aliases

Duid

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.


Aliases

Cn,ReservationServer

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies the description string for the IPv6 reservation that is created.


Aliases

ReservationDescription

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Iaid<UInt32>

Specifies the DHCPv6 IAID of a specific network interface of the client.


Aliases

none

Required?

true

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IPAddress<IPAddress>

Specifies the IPv6 address to reserve for the client.


Aliases

ReservedIP

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the client. This parameter value can be the actual host name of the client or a name assigned to identify the reserved client on the DHCP server service.


Aliases

HostName,ReservationName

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Prefix<IPAddress>

Specifies the IPv6 prefix which identifies the scope in which the reservation is created.


Aliases

ReservationScopeID

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


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.

Outputs

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

Examples

Example 1: Reserve an IP address

This example reserves the specified IPv6 address for the specified ClientDuid and Iaid parameter values. After the reservation is added, the DHCP server service assigns only the specified IP address to the client request which contains the specified ClientDuid and Iaid parameter values.


PS C:\> Add-DhcpServerv6Reservation -Prefix 2001:4898:7020:1020:: -IPAddress 2001:4898:7020:1020::1 -ClientDuid "00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E" -Iaid 234890455

Example 2: Reserve IP addresses from a file

This example adds all of the reservations in the file that is named Reservations.csv to the DHCP server service that runs on the computer named dhcpserver.contoso.com. The Import-Csv cmdlet returns the objects that have reservation fields and pipes the objects to this cmdlet, which adds these reservations to the DHCP server service. The file that is named Reservations.csv should contain the reservations in the following comma-separated values (CSV) format:

Prefix,IPAddress,Name,ClientDuid,Iaid,Description
2001:4898:7020:1020::,2001:4898:7020:1020::1,Computer1,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E,234890455,Reserved for Computer1
2001:4898:7020:1020::,2001:4898:7020:1020::2,Computer2,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-6E,234890465,Reserved for Computer2
2001:4898:7020:1020::,2001:4898:7020:1020::3,Computer3,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-7E,234890475,Reserved for Computer3


PS C:\> Import-Csv –Path "Reservations.csv" | Add-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com"

Example 3: Reserve any IP address in a scope

This example creates a reservation for the client identified by the specified client ID from any of the free IP address in the scope 2001:4898:7020:1020::. The Get-DhcpServerv6FreeIPAddress cmdlet fetches a free IP address in that scope, and then this cmdlet reserves the IP address for the specified client ID.


PS C:\> $FreeIP = Get-DhcpServerv6FreeIPAddress -ComputerName "dhcpserver.contoso.com" -Prefix 2001:4898:7020:1020::
PS C:\> Add-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com" -Prefix 2001:4898:7020:1020::  -IPAddress $FreeIP -ClientDuid "00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E" -Iaid 234890455 -Description "Reservation for Printer"

Example 4: Convert a lease into a reservation

This example converts one of the leases into a reservation. The Get-DhcpServerv6Lease cmdlet returns an IP address lease object and pipes the object to this cmdlet, which creates the reservation with the IP address, client DUID, and IAID in the lease object.


PS C:\> Get-DhcpServerv6Lease -ComputerName "dhcpserver.contoso.com" -IPAddress 2001:4898:7020:1020::11 | Add-DhcpServerv6Reservation -ComputerName "dhcpserver.contoso.com" -Prefix 2001:4898:7020:1020:: 

Related topics

Community Additions

ADD
Show: