Skip to content

DhcpScopeOptions.adoc

Latest commit

 

History

History
155 lines (127 loc) · 3.23 KB

DhcpScopeOptions.adoc

File metadata and controls

155 lines (127 loc) · 3.23 KB
Raw

DSC Resource 'DhcpScopeOptions'

DhcpScopeOptions manages DHCP option values at the scope level.

When to use 'DhcpScopeOptions'

Use this resource when you need to set DHCP options (such as DNS servers, domain name, or router addresses) for a specific DHCP scope. Scope-level options override server-level options and apply only to clients within that scope’s IP address range. Use DhcpServerOptions for server-wide settings instead.

Source

DSC Resource

Documentation
Table 1. Attributes of category 'DhcpScopeOptions'
Parameter Attribute DataType Description Allowed Values

ScopeOptions

Hashtable[]

Set of option values on scope level.
Table 2. Attributes of category 'DhcpScopeOptions/ScopeOptions'
Parameter Attribute DataType Description Allowed Values

ScopeId

Key

String

Scope ID to set the option.

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
DhcpScopeOptions:
  ScopeOptions:
    - ScopeId: 192.169.1.0
      OptionId: 6
      AddressFamily: IPv4
      UserClass: ''
      VendorClass: ''
      Value:
        - 192.168.10.10
        - 192.168.10.11
    - ScopeId: 192.169.1.0
      OptionId: 60
      Value: Support
      AddressFamily: IPv4
      VendorClass: ''
      UserClass: ''
    - ScopeId: 192.169.1.0
      OptionId: 66
      Value: 192.168.50.222
      AddressFamily: IPv4
      VendorClass: ''
      UserClass: ''
    - ScopeId: 192.169.1.0
      OptionId: 67
      Value: DCMgr\Boot\Windows\wdsnbp.com
      AddressFamily: IPv4
      VendorClass: ''
      UserClass: ''
    - ScopeId: 192.169.1.0
      OptionId: 3
      Value: 192.169.1.254
      AddressFamily: IPv4
      VendorClass: ''
      UserClass: ''