Skip to content

Latest commit

 

History

History
177 lines (138 loc) · 8.44 KB

README.md

File metadata and controls

177 lines (138 loc) · 8.44 KB
Raw

xDhcpServer

This module contains DSC resources for the management and configuration of Microsoft DHCP Server.

Build Status Azure DevOps coverage (branch) codecov Azure DevOps tests PowerShell Gallery (with prereleases) PowerShell Gallery

Code of Conduct

This project has adopted this Code of Conduct.

Releases

For each merge to the branch main a preview release will be deployed to PowerShell Gallery. Periodically a release version tag will be pushed which will deploy a full release to PowerShell Gallery.

Contributing

Please check out common DSC Community contributing guidelines.

Change log

A full list of changes in each version can be found in the change log.

Documentation

The documentation can be found in the xDhcpServer Wiki. The DSC resources schema files is used to automatically update the documentation on each PR merge.

Examples

You can review the Examples directory in the xDhcpServer module for some general use scenarios for all of the resources that are in the module.

The resource examples are also available in the xDhcpServer Wiki.

Resources

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

DhcpPolicyOptionValue

  • 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 multi-valued 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 }

DhcpReservedIPOptionValue

  • 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 multi-valued 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 }

DhcpScopeOptionValue

  • 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 multi-valued 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 }

xDhcpServerAuthorization

  • 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.

DhcpServerBinding

  • InterfaceAlias: Specifies the alias name for the network interface to manage.
  • Ensure: Specifies if the interface alias should be set or removed. Defaults to 'Present'. { Present | Absent }

xDhcpServerClass

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

DhcpServerExclusionRange

  • 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 }

xDhcpServerOptionDefinition

  • 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 multi-valued or not.
  • Description: Option description.
  • AddressFamily: Sets the address family for the option definition. Currently only IPv4 is supported. { IPv4 }
  • DefaultValue: The default value for the option.
  • Ensure: Whether option should be set or removed. { Present | Absent }

DhcpServerOptionValue

  • OptionId: Option ID, specify an integer between 1 and 255.
  • Value: Option data value. Could be an array of string for a multi-valued 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 }

xDhcpServerReservation

  • 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

xDhcpServerScope

  • 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.