Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DhcpServerv4Reservation

Add-DhcpServerv4Reservation

ps_dhcpserverv4reservation_v1.0.0.cdxml

Synopsis

Reserves the specified IPv4 address in the scope for a client.

Syntax

Add-DhcpServerv4Reservation [-ScopeId] [-IPAddress] [-ClientId] [-AsJob] [-CimSession] [-ComputerName] [-Description] [-Name] [-PassThru] [-ThrottleLimit] [-Type] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DhcpServerv4Reservation cmdlet reserves the specified IPv4 address in the scope for a client. Once reserved, the IP address will be leased only to the client identified by the specific client identifier (ID).

Parameters

-AsJob <SwitchParameter>

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

-ClientId <String>

Specifies the unique identifier (ID) for the client. For Windows clients, the MAC address is used as the client ID.

Aliases

None

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 running the Dynamic Host Configuration Protocol (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 for the reservation being created.

Aliases

ReservationDescription

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-IPAddress <IPAddress>

Specifies the IPv4 address to be reserved 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 reservation being created. This parameter value can be the host name of the client or a name to be used to identify the reservation on the DHCP server service.

Aliases

HostName,ReservationName

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-ScopeId <IPAddress>

Specifies the identifier (ID) of the scope in which the reservation is being 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

-Type <String>

Specifies the type of client request for which this IP address is reserved. The acceptable values for this parameter are:  DHCP, BootP, or Both. The default value is Both.

Aliases

ReservationType

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation

Notes

None

Examples

EXAMPLE 1

This example adds a reserved IP address for the client identified by the specified client ID.

PS C:\> Add-DhcpServerv4Reservation -ScopeId 10.10.10.0 -IPAddress 10.10.10.8 -ClientId F0-DE-F1-7A-00-5E -Description "Reservation for Printer"

EXAMPLE 2

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

ScopeId,IPAddress,Name,ClientId,Description 10.10.10.0,10.10.10.10,Computer1,1a-1b-1c-1d-1e-1f,Reserved for Computer1 20.20.20.0,20.20.20.11,Computer2,2a-2b-2c-2d-2e-2f,Reserved for Computer2 30.30.30.0,30.30.30.12,Computer3,3a-3b-3c-3d-3e-3f,Reserved for Computer3

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

EXAMPLE 3

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

PS C:\>Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.11 | Add-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com

EXAMPLE 4

This example creates a reservation for the client identified by the specified client ID from any of the free IP addresses in the scope 10.10.10.0. The Get-DhcpServerv4FreeIPAddress cmdlet fetches a free IP address in the scope, then this cmdlet reserves an address for the specified client ID.

PS C:\> $freeip = Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0
PS C:\> Add-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -IPAddress $freeip -ClientId F0-DE-F1-7A-00-5E -Description "Reservation for Printer"

Online Version
Import-Csv
Get-DhcpServerv4FreeIPAddress
Get-DhcpServerv4Lease
Get-DhcpServerv4Reservation
Remove-DhcpServerv4Reservation
Set-DhcpServerv4Reservation