Skip to content

DhcpReservedIPOptionValue

dscbot edited this page Oct 16, 2025 · 5 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
AddressFamily Key String Address family. Currently needs to be IPv4. IPv4
OptionId Key UInt32 Option ID, specify an integer between 1 and 255.
ReservedIP Key String Reserved IP to set the option value.
UserClass Key String User class. Use an empty string for default user class.
VendorClass Key String Vendor class. Use an empty string for default vendor class.
Ensure Write String Whether the DHCP option should exist. Present, Absent
Value Write StringArray[] Option data value. Could be an array of string for a multivalued option.

Description

The DhcpReservedIPOptionValue DSC resource manages option values on reserved IP level.

Requirements

  • Target machine must be running Windows Server 2012 R2 or later.
  • Target machine must be running at minimum Windows PowerShell 5.0.

Examples

Example 1

This example sets an option ID 8 (cookie servers) on a a reserved IP level.

configuration Example
{
    Import-DscResource -ModuleName 'PSDscResources' -ModuleVersion '2.12.0.0'
    Import-DscResource -moduleName 'DhcpServerDsc'

    WindowsFeature 'DHCP'
    {
        Name   = 'DHCP'
        Ensure = 'Present'
    }

    DhcpReservedIPOptionValue 'ReservedIPOptionValue_ID-008'
    {
        ReservedIP    = '192.168.0.1'
        OptionId      = 8
        Value         ='1.1.1.1'
        VendorClass   = ''
        UserClass     = ''
        AddressFamily = 'IPv4'
        Ensure        = 'Present'
    }
}

Clone this wiki locally