The xDhcpServer DSC resources are used for configuring and managing a DHCP server. They include xDhcpServerScope, xDhcpServerReservation, xDhcpServerOptions and xDhcpServerAuthorization.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

This is the branch containing the latest release - no contributions should be made directly to this branch.

This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.

Please check out common DSC Resources contributing guidelines.

• xDhcpServerClass manages DHCP Classes (Vendor or User).
• xDhcpServerScope sets a scope for consecutive range of possible IP addresses that the DHCP server can lease to clients on a subnet.
• xDhcpServerReservation sets lease assignments used to ensure that a specified client on a subnet can always use the same IP address.
• xDhcpServerOptions (DEPRECATED) currently supports setting DNS domain and DNS Server IP Address options at a DHCP server scope level.
• xDhcpServerAuthorization authorizes a DHCP in Active Directory.
• This resource must run on an Active Directory domain controller.
• xDhcpServerOptionDefinition manages DHCP option definitions.
• DhcpServerOptionValue manages an option value on server level.
• DhcpScopeOptionValue manages an option value on scope level.
• DhcpReservedIPOptionValue manages an option value on reserved IP level.
• DhcpPolicyOptionValue manages an option value on Policy level.
• DhcpServerExclusionRange manages exclusion ranges on server level.
• DhcpServerBinding manages network bindings on the server level.

• ScopeId: ScopeId of the DHCP scope
• IPStartRange: Starting address to set for this scope
• IPEndRange: Ending address to set for this scope
• Name: Name of this DHCP Scope
• SubnetMask: Subnet mask for the scope specified in IP address format
• LeaseDuration: Time interval for which an IP address should be leased
• This should be specified in the following format: Days.Hours:Minutes:Seconds
• For example, '02.00:00:00' is 2 days and '08:00:00' is 8 hours.
• State: Whether scope should be active or inactive.
• Ensure: Whether DHCP scope should be present or removed
• ScopeID: Scope Identifier. This is a read-only property for this resource.

• ScopeID: ScopeId for which reservations are set
• IPAddress: IP address of the reservation for which the properties are modified
• ClientMACAddress: Client MAC Address to set on the reservation
• Name: Reservation name
• AddressFamily: Address family type. Note: at this time, only IPv4 is supported.
• Ensure: Whether option should be set or removed

• ScopeID: ScopeID for which options are set
• DnsServerIPAddress: IP address of DNS Servers
• DnsDomain: Domain name of DNS Server
• AddressFamily: Address family type
• Router: The default gateway for clients
• Ensure: Whether option should be set or removed

• Ensure: Whether the DHCP server should be authorized.
• DnsName: FQDN of the server to authorize. If not specified, it defaults to the local hostname of the enacting node.
• IPAddress: IP v4 address of the server to authorized. If not specified, it default to the first IPv4 address of the enacting node.

• Name: DHCP Class Name.
• Type: Class type, should be Vendor or User.
• AsciiData: Class Data in a ascii formated string.
• AddressFamily: Currently should be "IPv4".
• Description: Class Description.
• Ensure: Whether class should be set or removed.

• OptionID: Option ID, should be a number between 1 and 255.
• VendorClass: Vendor class. Use an empty string for standard option class.
• Name: Option name.
• Type: Option data type. { Byte | Word | Dword | DwordDword | IPv4Address | String | BinaryData | EncapsulatedData }
• Multivalued: Whether option is multivalued or not.
• Description: Option description.
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• ScopeId: Scope ID where to set the option value.
• OptionId: Option ID, specify an integer between 1 and 255.
• Value: Option data value. Could be an array of string for a multivalued option.
• VendorClass: Vendor class. Use an empty string for default vendor class.
• UserClass: User class. Use an empty string for default user class.
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• OptionId: Option ID, specify an integer between 1 and 255.
• Value: Option data value. Could be an array of string for a multivalued option.
• VendorClass: Vendor class. Use an empty string for default vendor class.
• UserClass: User class. Use an empty string for default user class.
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• ReservedIP: Reserved IP to set the option value.
• OptionId: Option ID, specify an integer between 1 and 255.
• Value: Option data value. Could be an array of string for a multivalued option.
• VendorClass: Vendor class. Use an empty string for default vendor class.
• UserClass: User class. Use an empty string for default user class.
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• PolicyName: Dhcp Policy Name.
• OptionId: Option ID, specify an integer between 1 and 255.
• Value: Option data value. Could be an array of string for a multivalued option.
• ScopeId: Scope ID to get policy values from. Do not use it to get an option from server level.
• VendorClass: Vendor class. Use an empty string for default vendor class.
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• ScopeID: Scope ID for which exclusions are set
• IPStartRange: Starting IP address of the exclusion range
• IPEndRange: Ending IP address of the exclusion range
• AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
• Ensure: Whether option should be set or removed. { Present | Absent }

• InterfaceAlias: Alias for the network interface to manage
• Ensure: Whether option should be set or removed. { Present | Absent }

• Update appveyor.yml to use the default template.
• Added default template files .codecov.yml, .gitattributes, and .gitignore, and .vscode folder.
• Added DhcpServerExclusionRange resource
• Added DhcpServerBinding resource

• BREAKING CHANGE: Switch to ScopeId as a key property for xDhcpServerScope (issue #43. Bartek Bielawski (@bielawb)

• Changes to xDhcpServer
  • Updated year in LICENSE file.
  • Updated year in module manifest.
  • Added Codecov and status badges to README.md.
  • Update appveyor.yml to use the default template.
• Added xDhcpServerOptionDefinition
• Added DhcpScopeOptionValue
• Added DhcpServerOptionValue
• Added DhcpReservedIPOptionValue
• Added DhcpPolicyOptionValue

added xDhcpServerClass

• Converted AppVeyor.yml to pull Pester from PSGallery instead of Chocolatey
• Bug Fix fixes xDhcpServerOption\Get-TargetResource not returning Router property

• Bug Fix fixes localization bug in xDhcpServerScope option enumeration

• Added xDhcpServerAuthorization resource.
• Bug Fix LeaseDuration is no longer mandatory for xDhcpServerScope resource.
• Bug Fix DnsServerIPAddress is no longer mandatory for xDhcpServerOption resource.
• Bug Fix corrects verbose display output in xDhcpServerOption resource.

• Fix "Cannot set default gateway on xDhcpServerOption".

• Bug fix, enables creating more than 1 DHCP server scope.

• Initial release with the following resources
  • xDhcpServerScope
  • xDhcpServerReservation
  • xDhcpServerOptions

configuration Sample_xDhcpsServerScope_NewScope
{
    Import-DscResource -module xDHCpServer
    xDhcpServerScope Scope
    {
        ScopeId = '192.168.1.0'
        Ensure = 'Present'
        IPEndRange = '192.168.1.254'
        IPStartRange = '192.168.1.1'
        Name = 'PowerShellScope'
        SubnetMask = '255.255.255.0'
        LeaseDuration = ((New-TimeSpan -Hours 8 ).ToString())
        State = 'Active'
        AddressFamily = 'IPv4'
    }
}

configuration Sample_xDhcpsServerScope_ResizeScope
{
    Import-DscResource -module xDHCpServer
    xDhcpServerScope SmallerScope
    {
        ScopeId = '192.168.1.0'
        Ensure = 'Present'
        IPEndRange = '192.168.1.100'
        IPStartRange = '192.168.1.1'
        Name = 'PowerShellScope'
        SubnetMask = '255.255.255.0'
        LeaseDuration = ((New-TimeSpan -Hours 8 ).ToString())
        State = 'Active'
        AddressFamily = 'IPv4'
    }
}

configuration Sample_xDhcpServerReservation_IPReservation
{
    Import-DscResource -module xDHCpServer
    xDhcpServerReservation PullServerIP
    {
        Ensure = 'Present'
        ScopeID = '192.168.1.0'
        ClientMACAddress = '00155D8A54A1'
        IPAddress = '192.168.1.2'
        Name = 'DSCPullServer'
        AddressFamily = 'IPv4'
    }
}

configuration Sample_xDhcpServerOption_SetScopeOption
{
    Import-DscResource -module xDHCpServer
    xDhcpServerOption Option
    {
        Ensure = 'Present'
        ScopeID = '192.168.1.0'
        DnsDomain = 'contoso.com'
        DnsServerIPAddress = '192.168.1.22','192.168.1.1'
        AddressFamily = 'IPv4'
        Router = '192.168.1.1'
    }
}

configuration Sample_Local_xDhcpServerAuthorization
{
    Import-DscResource -module xDHCpServer
    xDhcpServerAuthorization LocalServerActivation
    {
        Ensure = 'Present'
    }
}

configuration Sample_Remote_xDhcpServerAuthorization
{
    Import-DscResource -module xDHCpServer
    xDhcpServerAuthorization RemoteServerActivation
    {
        Ensure = 'Present'
        DnsName = 'servertoauthorize.contoso.com'
        IPAddress = '192.168.0.1'
    }
}

configuration Sample_DHCPServerClass
{
    Import-DscResource -module xDHCpServer
    xDhcpServerClass DHCPServerClass
    {
        ensure = 'Present'
        Name = 'VendorClass'
        Type = 'Vendor'
        AsciiData = 'sampledata'
        AddressFamily = 'IPv4'
        Description = 'Vendor Class Description'
    }
}