DhcpServerOptions.adoc

DSC Resource 'DhcpServerOptions'

DhcpServerOptions manages DHCP option values at the server level.

When to use 'DhcpServerOptions'

Use this resource when you need to set DHCP options that apply to all scopes on the server by default (e.g., DNS servers, domain name). Server-level options serve as defaults that can be overridden at the scope level using DhcpScopeOptions.

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

Table 1. Attributes of category 'DhcpServerOptions'

Parameter	Attribute	DataType	Description	Allowed Values
ServerOptions		Hashtable[]	Set of option values at server level.

Table 2. Attributes of category 'DhcpServerOptions/ServerOptions'

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.
UserClass	Key	String	User class. Use an empty string for default user class.
AddressFamily	Key	String	Sets the address family for the option definition. Currently only IPv4 is supported.	IPv4
Value		String[]	Option data value. Could be an array of string for a multi-valued option.
Ensure		String	Whether option should be set or removed.	Present Absent

Example

DhcpServerOptions:
  ServerOptions:
    - OptionId: 15
      AddressFamily: IPv4
      UserClass: ''
      VendorClass: ''
      Value: contoso.com

See also

• DhcpServer

• DhcpScopeOptions

• DhcpServerOptionDefinitions