The Dynamic Host Configuration Protocol (DHCP) IPv4 object {{bibref|RFC2131}}. This entire object applies to IPv4 only. It contains the {{object|Client}}, {{object|Server}}, and {{object|Relay}} objects. {{numentries}} This object contains DHCP client settings for an associated ''IP Interface'' indicated by {{param|Interface}}. For enabled table entries, if {{param|Interface}} is not a valid reference then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Note: The {{object}} table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the offending {{object}} row. Enables or disables the DHCP Client entry. {{datatype|expand}} {{reference}} The IP Interface associated with the ''Client'' entry. The status of this table entry. {{enum}} The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. The DHCP Client status as defined in {{bibref|RFC2131}}. {{enum}} Note: This value is only relevant when the DHCP Client is operationally enabled (i.e. when {{param|Status}} is {{enum|Enabled|Status}}). IPv4 Address option received from the DHCP Server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Subnet mask option received from the DHCP Server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Option 1. {{list}} Items represent IP Router IPv4 Address(es) received from the DHCP server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Options 3, 33 or 121. {{list}} Items represent DNS Server IPv4 Address(es) received from the DHCP server. {{empty}} when {{param|Status}} is not equal to {{enum|Bound|DHCPStatus}}. Value is information received via DHCP Option 6. DHCP lease time remaining in {{units}}. A value of -1 indicates an infinite lease. The IPv4 address of the current DHCP server. If {{false}}, the DHCP Client retrieved IP address information is configured on the referenced {{param|Interface}} object. If {{true}}, the DHCP Client retrieved information is propagated to the parameters in the referenced {{param|PassthroughDHCPPool}} object, replacing any existing configuration (including ''MinAddress'', ''MaxAddress'', ''SubnetMask'', ''IPRouters'', and ''DNSServers''). {{reference}}When {{param}} is set to {{empty}}, {{param|PassthroughEnable}} MUST be set to {{false}} (i.e. passthrough can not be enabled without a pool reference specified). {{numentries}} {{numentries}} Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed. Enables or disables this SentOption table entry. {{datatype|expand}} Option tag as defined in {{bibref|RFC2132}}. A hexbinary encoded option value. Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed. Enables or disables this ReqOption table entry. Position of the option in the DHCP client request. A value of ''1'' indicates the first entry. When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction. The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value. {{datatype|expand}} Option tag as defined in {{bibref|RFC2132}}. A hexbinary encoded, most recently received DHCP option value. If no option value has been received, then the value MUST represent {{empty}}. Received DHCP option values MAY, but need not, persist across CPE reboots. DHCP server configuration. Enables or disables the DHCP server. {{numentries}} DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if {{param|Interface}} is not a valid reference, or {{param|MinAddress}}, {{param|MaxAddress}}, or {{param|SubnetMask}} is not a valid value, then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Enables or disables the Pool entry. The status of this entry. {{enum}} The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. {{datatype|expand}} Position of the {{object}} entry in the order of precedence. A value of ''1'' indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction. The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). {{reference}} The IP Interface associated with the ''Pool'' entry. Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in {{bibref|RFC2132}}, matched according to the criterion in {{param|VendorClassIDMode}}. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. {{empty}} indicates this criterion is not used for conditional serving. If {{false}}, matching packets are those that match the {{param|VendorClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|VendorClassID}} entry, if specified. {{param|VendorClassID}} pattern match criterion. {{enum}} For example, if {{param|VendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}. Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in {{bibref|RFC2132}}. The option value is binary, so an exact match is REQUIRED. {{empty}} indicates this criterion is not used for conditional serving. If {{false}}, matching packets are those that match the {{param|ClientID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|ClientID}} entry, if specified. Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in {{bibref|RFC3004}}. {{empty}} indicates this criterion is not used for conditional serving. If {{false}}, matching packets are those that match the {{param|UserClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|UserClassID}} entry, if specified. Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. {{empty}} indicates this criterion is not used for conditional serving. Bit-mask for the MAC address, where matching of a packet's MAC address with the {{param|Chaddr}} is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or {{empty}} indicates all bits of the {{param|Chaddr}} are to be used for conditional serving classification. If {{false}}, matching packets are those that match the (masked) {{param|Chaddr}} entry, if specified. If {{true}}, matching packets are those that do not match the (masked) {{param|Chaddr}} entry, if specified. Pool association criterion. Determines which devices are allowed, {{enum}} All clients are served. Only clients, whose MAC address is listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. The parameter {{param|#.Chaddr}} is not used, if this value is set. Only clients, whose MAC address is '''not''' listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}. Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}. {{list}} List items represent addresses marked reserved from the address allocation pool. Specifies the client's network subnet mask. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}. {{list}} List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}. Sets the domain name to provide to clients on the LAN interface. {{list}} List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with {{param|##.Client.{i}.PassthroughEnable}} or a PPP interface with {{param|.PPP.Interface.{i}.IPCP.PassthroughEnable}} equal to {{true}}. Specifies the lease time in {{units}} of client assigned addresses. A value of -1 indicates an infinite lease. {{numentries}} {{numentries}} {{numentries}} DHCP static address table. Entries in this table correspond to what {{bibref|RFC2131}} calls "manual allocation", where a client's IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client. Enables or disables the StaticAddress table entry. Disabling an entry does not return the IP address to the pool. {{datatype|expand}} Hardware address (MAC address) of the physical interface of the DHCP client. IPv4 address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address). This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool. Enables or disables this Option table entry. {{datatype|expand}} Option tag as defined in {{bibref|RFC2132}}. A hexbinary encoded option value. DHCPv4 client table. This table lists details of DHCPv4 clients that matched the filter criteria of this {{object|#}} entry. {{datatype|expand}} Note: There is no guarantee that the {{param}} value on automatically-created {{object}} instances will be retained. This is because automatically-created {{object}} instances can be transitory. MAC address of the DHCPv4 client. Whether or not the DHCPv4 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv4 clients is OPTIONAL. If the CPE includes inactive DHCPv4 clients in this table, {{param}} MUST be set to {{false}} for each inactive DHCPv4 client. The length of time an inactive DHCPv4 client remains listed in this table is a local matter to the CPE. {{numentries}} {{numentries}} IPv4 addresses assigned to this client. IPv4 address. The time at which the DHCP lease will expire or {{null}} if not known. For an infinite lease, the parameter value MUST be 9999-12-31T23:59:59Z. DHCPv4 options supplied by this client, e.g. ''VendorClassID'' (Option 60), ''ClientID'' (option 61) or ''UserClassID'' (Option 77). Option tag as defined in {{bibref|RFC2132}}. A hexbinary encoded option value. DHCP Relay Agent (conditional relaying). Enables or disables the DHCP Relay Agent function. The status of the DHCP relay. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. {{numentries}} DHCP Relay Agent Forwarding table. For enabled table entries, if {{param|Interface}} is not a valid reference then the table entry is inoperable and the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}}. Enables or disables the Forwarding entry. The status of this entry. {{enum}} The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. {{datatype|expand}} Position of the {{object}} entry in the order of precedence. A value of ''1'' indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction. The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). {{reference}} The IP Interface associated with the ''Forwarding'' entry. Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in {{bibref|RFC2132}}, matched according to the criterion in {{param|VendorClassIDMode}}. Case sensitive. This is a normal string, e.g. "abc" is represented as "abc" and not say "616263" hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. {{empty}} indicates this criterion is not used as a relay classification criterion. If {{false}}, matching packets are those that match the {{param|VendorClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|VendorClassID}} entry, if specified. {{param|VendorClassID}} pattern match criterion. {{enum}} For example, if {{param|VendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}. Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in {{bibref|RFC2132}}. The option value is binary, so an exact match is REQUIRED. {{empty}} indicates this criterion is not used as a relay classification criterion. If {{false}}, matching packets are those that match the {{param|ClientID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|ClientID}} entry, if specified. Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in {{bibref|RFC3004}}. {{empty}} indicates this criterion is not used as a relay classification criterion. If {{false}}, matching packets are those that match the {{param|UserClassID}} entry, if specified. If {{true}}, matching packets are those that do not match the {{param|UserClassID}} entry, if specified. Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. {{empty}} indicates this criterion is not used as a relay classification criterion. Bit-mask for the MAC address, where matching of a packet's MAC address with the {{param|Chaddr}} is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or {{empty}} indicates all bits of the {{param|Chaddr}} are to be used for relay classification. If {{false}}, matching packets are those that match the (masked) {{param|Chaddr}} entry, if specified. If {{true}}, matching packets are those that do not match the (masked) {{param|Chaddr}} entry, if specified. If {{true}}, incoming DHCP requests will be forwarded to the CPE DHCP Server. If {{false}}, incoming DHCP requests will be forwarded to the {{param|DHCPServerIPAddress}} configured for this forwarding entry. IPv4 address of the DHCP server, where the request has to be sent to when there is a conditional match with this forwarding entry and {{param|LocallyServed}} is {{false}}. If {{param|LocallyServed}} is {{false}} and this parameter is not configured, then the DHCP request is dropped.