DhcpServerAuthorization.adoc

DSC Resource 'DhcpServerAuthorization'

DhcpServerAuthorization authorizes a DHCP server in Active Directory so it can serve IP addresses to clients.

When to use 'DhcpServerAuthorization'

Use this resource when you need to authorize a DHCP server in an Active Directory environment. A DHCP server must be authorized in AD before it can begin serving IP leases. This is a prerequisite step that is separate from scope and option configuration.

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

Important

This resource must run on an Active Directory domain controller.

Table 1. Attributes of category 'DhcpServerAuthorization'

Parameter	Attribute	DataType	Description	Allowed Values
DnsName		String	DHCP Server FQDN or empty string for localhost.
IPAddress		String	DHCP Server IP Address or empty string for localhost.
Ensure		String	Whether the DHCP server should be authorized within Active Directory	Present (default) Absent

Example

DhcpServerAuthorization:
    # authorize remote DHCP server
    DnsName: dhcp.contoso.com
    IPAddress: 192.168.1.12
    Ensure: Present

See also

• DhcpServer

• DhcpScopes

• DhcpScopeOptions