DhcpServerOptionDefinitions.adoc

DSC Resource 'DhcpServerOptionDefinitions'

DhcpServerOptionDefinitions manages custom DHCP server option definitions.

When to use 'DhcpServerOptionDefinitions'

Use this resource when you need to define custom DHCP options beyond the standard ones (e.g., vendor-specific options for IP phones, PXE boot, or custom applications). Option definitions must be created before the option values can be set via DhcpServerOptions or DhcpScopeOptions.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DhcpServerOptionDefinitions
DSC Resource	DhcpServerDsc
Documentation	xDhcpServerOptionDefinition

Table 1. Attributes of category 'DhcpServerOptionDefinitions'

Parameter	Attribute	DataType	Description	Allowed Values
ServerOptionDefinitions		Hashtable[]	Set of server option definitions.

Table 2. Attributes of category 'DhcpServerOptionDefinitions/ServerOptionDefinitions'

Parameter	Attribute	DataType	Description	Allowed Values
OptionId	Key	UInt32	Option ID, specify an integer between 1 and 255.
VendorClass	Key	String	Vendor class. Use an empty string for default vendor class.
AddressFamily	Key	String	Sets the address family for the option definition. Currently only IPv4 is supported.	IPv4
Name	Mandatory	String	Option name.
Type	Mandatory	String	Option data type.	Byte Word Dword DwordDword IPv4Address String BinaryData EncapsulatedData
Multivalued		Boolean	Whether option is multi-valued or not.	True False
Description		String	Option description.
Ensure		String	Whether the DHCP server class should exist.	Present Absent

Example

DhcpServerOptionDefinitions:
  ServerOptionDefinitions:
    - AddressFamily: IPv4
      Name: PXEClientType
      OptionId: 60
      Type: string
      VendorClass: ''
      Description: PXE Support

See also

• DhcpServer

• DhcpServerOptions

• DhcpScopeOptions