Field | Description | Example supported values |
dhcpDeployMode | How to use DHCP with Bare Metal Orchestrator. Options are no DHCP server and a managed Kubernetes pod providing a DHCP server or relay. | none server relay |
autoDiscoveryMode | Top-level field for server discovery by DHCP. | Not applicable |
discoveryViaDhcp | Set the server discovery by DHCP to automatic or none. | auto or none |
DhcpConfigData | Top-level field for your DHCP configuration values. | Not applicable |
dhcpSubnet | You can define as many subnets as you need. | Not applicable |
defaultLeaseTime | Default lease time for this subnet, in seconds. | 3000 |
maxLeaseTime | Maximum lease time for this subnet, in seconds. | 6000 |
netmask | The netmask for the subnet. | 255.255.255.0 |
optionBroadcastAddress | The broadcast address that is provided to clients for this subnet. | IPv4 address |
optionRouters | The gateway that is provided to clients for this subnet. | IPv4 address |
optionSubnetMask | The subnet mask that is provided to clients for this subnet. | 255.255.255.0 |
subnet | The IP address of the subnet. | IPv4 address |
dhcpPool | Define one or more DHCP IP pools. | Not applicable |
allowMembers | Define what can lease an IP address from this DHCP IP pool. This must be a vendor class identifier that is specified in the vendorClassIdentifier list. | For example: iDRAC |
denyMembers | Define what cannot lease an IP address from this DHCP IP pool. This must be a vendor class identifier that is specified in the vendorClassIdentifier list. Vendor class identifiers are transmitted with DHCP requests for IP addresses from clients. | For example: A Linux server could send Linux 2.4.34 i686 |
endRange | DHCP pool starting IP address. | IPv4 address |
startRange | DHCP pool ending IP address. | IPv4 address |
interfaces | A comma-separated list of network interface names that the DHCP server services clients on. | ens192, ens224 |
domain | Top-level domain for your DHCP server. | example.com |
dns | A comma-separated list of DNS server IP addresses. | IPv4 addresses |
additionalDhcpConfig | A semicolon-separated list of DHCP server configuration commands. | See: ISC DHCP 4.4 Manual Pages - dhcpd.conf |
vendorClassIdentifier | Every DHCP client includes a vendor class identifier in DHCP requests that it sends to a DHCP server. A vendor class identifier is a text string that identifies the type of device. For iDRACs, the vendor class identifier is "iDRAC". This setting is used in the allowMembers and denyMembers fields. This action configures the DHCP server to only provide IP addresses from a pool to devices that have the given vendor class identifier. A DHCP pool that has allowMembers: "iDRAC" causes the DHCP server to only allocate IPs in this pool to iDRACs. In this example, "iDRAC" must also appear in the vendorClassIdentifier list. Note: For Supermicro servers, the vendor class identifier is udhcp 1.23.1 for the SYS-1019P-FRN2T model. For Dell switches, the vendor class identifier is onie_vendor:x86_64-dellemc. For HPE iLO servers, the vendor class identifier is CPQRIB3. | All values are supported. |
dhcpRelayConfig | Top-level field for DHCP relay configuration. | Not applicable |
dhcpForwardIpAddress | The forwarding IP address of the external DHCP server. | IPv4 addresses |
bootSize | The size of the primary boot image to download from the TFTP server. It is calculated from the size of the boot file in bytes divided by 512. | 370 |
inbandIP | The private IP from which the PXE InBand VLAN is configured. | A valid IP address |