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
 

Set-DhcpServerv4Reservation

Set-DhcpServerv4Reservation

ps_dhcpserverv4reservation_v1.0.0.cdxml

Synopsis

Modifies the properties of an IPv4 reservation.

Syntax

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

Detailed Description

The Set-DhcpServerv4Reservation cmdlet modifies the properties of an IPv4 reservation.

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 value of the client identifier (ID) to set on the reservation. For Windows clients, the MAC address is used as the client ID.

Aliases

None

Required?

false

Position

named

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 to set for the reservation.

Aliases

ReservationDescription

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-IPAddress <IPAddress>

Specifies the IPv4 address of the reservation for which the properties are modified.

Aliases

ReservedIP

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name to set for the reservation.

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

-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 that can be leased the reserved IPv4 address. The acceptable values for this parameter are:  Dhcp, BootP, or 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/DhcpServerv4Reservation

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example sets the name and description for an existing DHCPv4 reservation for IP address 10.10.10.5.

PS C:\>Set-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5 -Description "Fourth Floor Printer" -Name printer.contoso.com

Online Version
Add-DhcpServerv4Reservation
Get-DhcpServerv4Reservation
Remove-DhcpServerv4Reservation