This object represents a subset of the Infoblox Grid DHCP properties.
References to grid:dhcpproperties are object references. The name part of a Grid DHCP properties object reference has the following components:
Example: grid:dhcpproperties/ZG5zLm5ldHdvcmtfdmlldyQxMTk:Infoblox
The object does not support the following operations:
In addition the object does not support the following operations when managed on Cloud Platform members:
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): disable_all_nac_filters, grid.
The Grid-level authority flag. This flag specifies whether a DHCP server is authoritative for a domain.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of a file that DHCP clients need to boot. Some DHCP clients use BOOTP (bootstrap protocol) or include the boot file name option in their DHCPREQUEST messages.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The name of the server on which a boot file is stored.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The Grid-level capture hostname flag. Set this flag to capture the hostname and lease time when assigning a fixed address.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The member DDNS domain name value.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the ability of a DHCP server to generate a host name and update DNS with this host name when it receives a DHCP REQUEST message that does not include a host name is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines the retry interval when the DHCP server makes repeated attempts to send DDNS updates to a DNS server.
Type
Unsigned integer.
Create
The default value is 5.
Search
The field is not available for search.
Determines that only the DHCP server is allowed to update DNS, regardless of the requests from the DHCP clients.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The DDNS TTL (Dynamic DNS Time To Live) value specifies the number of seconds an IP address for the name is cached.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Determines if the Grid DHCP server’s ability to update the A and PTR records with a fixed address is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if support for option 81 is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if deny BOOTP is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
If set to True, NAC filters will be disabled on the Infoblox Grid.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The disable_all_nac_filters is part of the base object.
The update style for dynamic DNS updates.
Type
String.
Create
The default value is INTERIM.
Search
The field is not available for search.
The Grid-level email_list value. Specify an e-mail address to which you want the Infoblox appliance to send e-mail notifications when the DHCP address usage for the grid crosses a threshold. You can create a list of several e-mail addresses.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the member DHCP server’s ability to send DDNS updates is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Represents the watermarks above or below which address usage in a network is unexpected and might warrant your attention.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if e-mail warnings are enabled or disabled. When DHCP threshold is enabled and DHCP address usage crosses a watermark threshold, the appliance sends an e-mail notification to an administrator.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the fingerprint feature is enabled or not. If you enable this feature, the server will match a fingerprint for incoming lease requests.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether all appliances are enabled to receive GSS-TSIG authenticated updates from DHCP clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the Grid-level host name rewrite feature is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if lease query is allowed or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if DHCP servers in a Grid support roaming hosts or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determined if the SNMP warnings on Grid-level are enabled or not. When DHCP threshold is enabled and DHCP address usage crosses a watermark threshold, the appliance sends an SNMP trap to the trap receiver that you defined you defined at the Grid member level.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The format option for Option 82 logging.
Type
String.
Create
The default value is HEX.
Search
The field is not available for search.
Determines the Grid that serves DHCP. This specifies a group of Infoblox appliances that are connected together to provide a single point of device administration and service configuration in a secure, highly available environment.
Type
String.
Search
The field is available for search via
Notes
The grid is part of the base object.
The grid cannot be updated.
grid cannot be written.
The list of GSS-TSIG keys for a Grid DHCP object.
Type
A/An kerberoskey object array.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
Determines the high watermark value of a Grid DHCP server. If the percentage of allocated addresses exceeds this watermark, the appliance makes a syslog entry and sends an e-mail notification (if enabled). Specifies the percentage of allocated addresses. The range is from 1 to 100.
Type
Unsigned integer.
Create
The default value is 95.
Search
The field is not available for search.
Determines the high watermark reset value of a member DHCP server. If the percentage of allocated addresses drops below this value, a corresponding SNMP trap is reset. Specifies the percentage of allocated addresses. The range is from 1 to 100. The high watermark reset value must be lower than the high watermark value.
Type
Unsigned integer.
Create
The default value is 85.
Search
The field is not available for search.
The name of the default hostname rewrite policy, which is also in the protocol_hostname_rewrite_policies array.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is Default.
Search
The field is not available for search.
Determines if the ignore DHCP option list request flag of a Grid DHCP is enabled or not. If this flag is set to true all available DHCP options will be returned to the client.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Indicates whether the appliance will ignore DHCP client IDs or MAC addresses. Valid values are “NONE”, “CLIENT”, or “MACADDR”. The default is “NONE”.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
A list of MAC addresses the appliance will ignore.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the fixed address configuration takes effect immediately without DHCP service restart or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the IPv6 host name and lease time is captured or not while assigning a fixed address.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The Grid-level DDNS domain name value.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
Controls whether the FQDN option sent by the client is to be used, or if the server can automatically generate the FQDN.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the server always updates DNS or updates only if requested by the client.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The Grid-level IPv6 DDNS TTL value.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
The Grid-level IPv6 default prefix.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The update style for dynamic DHCPv6 DNS updates.
Type
String.
Create
The default value is INTERIM.
Search
The field is not available for search.
The IPv6 domain name.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The comma separated list of domain name server addresses in IPv6 address format.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Determines if sending DDNS updates by the DHCPv6 server is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines whether the all appliances are enabled to receive GSS-TSIG authenticated updates from DHCPv6 clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Indicates whether DHCPv6 lease scavenging is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the DHCPv6 server retries failed dynamic DNS updates or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the server generates the hostname if it is not sent by the client.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The list of GSS-TSIG keys for a Grid DHCPv6 object.
Type
A/An kerberoskey object array.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
The IPv6 address or FQDN of the Kerberos server for DHCPv6 GSS-TSIG authentication.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The Grid-level grace period (in seconds) to keep an expired lease before it is deleted by the scavenging process.
Type
Unsigned integer.
Create
The default value is 604800.
Search
The field is not available for search.
The Grid-level Microsoft client DHCP IPv6 code page value. This value is the hostname translation code page for Microsoft DHCP IPv6 clients.
Type
String.
Create
The default value is None.
Search
The field is not available for search.
An array of DHCP option structs that lists the DHCPv6 options associated with the object.
Type
A/An DHCP option struct array.
Create
The default value is undefined.
Search
The field is not available for search.
The Grid-level list of IPv6 prefixes.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the IPv6 recycle leases feature is enabled or not. If the feature is enabled, leases are kept in the Recycle Bin until one week after expiration. When the feature is disabled, the leases are irrecoverably deleted.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Enable binding for expired DHCPv6 leases.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines the retry interval when the member DHCPv6 server makes repeated attempts to send DDNS updates to a DNS server.
Type
Unsigned integer.
Create
The default value is 5.
Search
The field is not available for search.
The Grid-level TXT record handling value. This value specifies how DHCPv6 should treat the TXT records when performing DNS updates.
Type
String.
Create
The default value is ISC.
Search
The field is not available for search.
Controls whether the DHCPv6 server updates DNS when an IPv6 DHCP lease is renewed.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The IPv4 address or FQDN of the Kerberos server for DHCPv4 GSS-TSIG authentication.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The Grid member on which you want to store the DHCP lease history log. Infoblox recommends that you dedicate a member other than the master as a logging member. If possible, use this member solely for storing the DHCP lease history log. If you do not select a member, no logging can occur.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
Defines how the appliance releases DHCP leases. Valid values are “RELEASE_MACHING_ID”, “NEVER_RELEASE”, or “ONE_LEASE_PER_CLIENT”. The default is “RELEASE_MATCHING_ID”.
Type
String.
Create
The default value is RELEASE_MATCHING_ID.
Search
The field is not available for search.
Determines the lease scavenging time value. When this field is set, the appliance permanently deletes the free and backup leases, that remain in the database beyond a specified period of time.
To disable lease scavenging, set the parameter to -1. The minimum positive value must be greater than 86400 seconds (1 day).
Type
Integer.
Create
The default value is -1.
Search
The field is not available for search.
This value specifies whether the Grid DHCP members log lease events is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This field contains the logic filters to be applied on the Infoblox Grid.
This list corresponds to the match rules that are written to the dhcpd configuration file.
Type
A/An Logic Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Determines the low watermark value. If the percent of allocated addresses drops below this watermark, the appliance makes a syslog entry and if enabled, sends an e-mail notification.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Determines the low watermark reset value.If the percentage of allocated addresses exceeds this value, a corresponding SNMP trap is reset.
A number that specifies the percentage of allocated addresses. The range is from 1 to 100. The low watermark reset value must be higher than the low watermark value.
Type
Unsigned integer.
Create
The default value is 10.
Search
The field is not available for search.
The Microsoft client DHCP IPv4 code page value of a Grid. This value is the hostname translation code page for Microsoft DHCP IPv4 clients.
Type
String.
Create
The default value is None.
Search
The field is not available for search.
The next server value of a DHCP server. This value is the IP address or name of the boot file server on which the boot file is stored.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The list of option 60 match rules.
Type
A/An Option 60 Match Rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
An array of DHCP option structs that lists the DHCP options associated with the object. Note that WAPI does not return special options ‘routers’, ‘domain-name-servers’, ‘domain-name’ and ‘broadcast-address’ with empty values for this object.
Type
A/An DHCP option struct array.
Create
The default value is:
[ { 'name': 'dhcp-lease-time',
'num': 51,
'value': '43200',
'vendor_class': 'DHCP'}]
Search
The field is not available for search.
Specifies the number of pings that the Infoblox appliance sends to an IP address to verify that it is not in use. Values are range is from 0 to 10, where 0 disables pings.
Type
Unsigned integer.
Create
The default value is 1.
Search
The field is not available for search.
Indicates the number of milliseconds the appliance waits for a response to its ping.
Valid values are 100, 500, 1000, 2000, 3000, 4000 and 5000 milliseconds.
Type
Unsigned integer.
Create
The default value is 1000.
Search
The field is not available for search.
The preferred lifetime value.
Type
Unsigned integer.
Create
The default value is 27000.
Search
The field is not available for search.
The Prefix length mode for DHCPv6.
Type
String.
Create
The default value is EXACT.
Search
The field is not available for search.
The list of hostname rewrite policies.
Type
A/An hostnamerewritepolicy object array.
This field supports nested return fields as described here.
Create
The default value is [{‘replacement_character’: ‘-‘, ‘name’: ‘Default’, ‘valid_characters’: ‘a-z0-9_’}].
Search
The field is not available for search.
Specifies the duration of time it takes a host to connect to a boot server, such as a TFTP server, and download the file it needs to boot.
A 32-bit unsigned integer that represents the duration, in seconds, for which the update is cached. Zero indicates that the update is not cached.
Type
Unsigned integer.
Create
The default value is 43200.
Search
The field is not available for search.
Determines if the recycle leases feature is enabled or not. If you enabled this feature, and then delete a DHCP range, the appliance stores active leases from this range up to one week after the leases expires.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The restart setting.
Type
A/An Restart Setting struct.
Create
The default value is:
{ 'delay': 10, 'restart_offline': True, 'timeout': 60}
Search
The field is not available for search.
Indicates whether the DHCP server makes repeated attempts to send DDNS updates to a DNS server.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The syslog facility is the location on the syslog server to which you want to sort the syslog messages.
Type
String.
Create
The default value is DAEMON.
Search
The field is not available for search.
The Grid-level TXT record handling value. This value specifies how DHCP should treat the TXT records when performing DNS updates.
Type
String.
Create
The default value is ISC.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| authority | Bool | N | N | N | N/A |
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| capture_hostname | Bool | N | N | N | N/A |
| ddns_domainname | String | N | N | N | N/A |
| ddns_generate_hostname | Bool | N | N | N | N/A |
| ddns_retry_interval | Unsigned int | N | N | N | N/A |
| ddns_server_always_updates | Bool | N | N | N | N/A |
| ddns_ttl | Unsigned int | N | N | N | N/A |
| ddns_update_fixed_addresses | Bool | N | N | N | N/A |
| ddns_use_option81 | Bool | N | N | N | N/A |
| deny_bootp | Bool | N | N | N | N/A |
| disable_all_nac_filters | Bool | N | N | Y | N/A |
| dns_update_style | String | N | N | N | N/A |
| email_list | [String] | N | N | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_dhcp_thresholds | Bool | N | N | N | N/A |
| enable_email_warnings | Bool | N | N | N | N/A |
| enable_fingerprint | Bool | N | N | N | N/A |
| enable_gss_tsig | Bool | N | N | N | N/A |
| enable_hostname_rewrite | Bool | N | N | N | N/A |
| enable_leasequery | Bool | N | N | N | N/A |
| enable_roaming_hosts | Bool | N | N | N | N/A |
| enable_snmp_warnings | Bool | N | N | N | N/A |
| format_log_option_82 | String | N | N | N | N/A |
| grid | String | N | Y | Y | = |
| gss_tsig_keys | [obj] | N | N | N | N/A |
| high_water_mark | Unsigned int | N | N | N | N/A |
| high_water_mark_reset | Unsigned int | N | N | N | N/A |
| hostname_rewrite_policy | String | N | N | N | N/A |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| ignore_id | String | N | N | N | N/A |
| ignore_mac_addresses | [String] | N | N | N | N/A |
| immediate_fa_configuration | Bool | N | N | N | N/A |
| ipv6_capture_hostname | Bool | N | N | N | N/A |
| ipv6_ddns_domainname | String | N | N | N | N/A |
| ipv6_ddns_enable_option_fqdn | Bool | N | N | N | N/A |
| ipv6_ddns_server_always_updates | Bool | N | N | N | N/A |
| ipv6_ddns_ttl | Unsigned int | N | N | N | N/A |
| ipv6_default_prefix | String | N | N | N | N/A |
| ipv6_dns_update_style | String | N | N | N | N/A |
| ipv6_domain_name | String | N | N | N | N/A |
| ipv6_domain_name_servers | [String] | N | N | N | N/A |
| ipv6_enable_ddns | Bool | N | N | N | N/A |
| ipv6_enable_gss_tsig | Bool | N | N | N | N/A |
| ipv6_enable_lease_scavenging | Bool | N | N | N | N/A |
| ipv6_enable_retry_updates | Bool | N | N | N | N/A |
| ipv6_generate_hostname | Bool | N | N | N | N/A |
| ipv6_gss_tsig_keys | [obj] | N | N | N | N/A |
| ipv6_kdc_server | String | N | N | N | N/A |
| ipv6_lease_scavenging_time | Unsigned int | N | N | N | N/A |
| ipv6_microsoft_code_page | String | N | N | N | N/A |
| ipv6_options | [struct] | N | N | N | N/A |
| ipv6_prefixes | [String] | N | N | N | N/A |
| ipv6_recycle_leases | Bool | N | N | N | N/A |
| ipv6_remember_expired_client_association | Bool | N | N | N | N/A |
| ipv6_retry_updates_interval | Unsigned int | N | N | N | N/A |
| ipv6_txt_record_handling | String | N | N | N | N/A |
| ipv6_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| kdc_server | String | N | N | N | N/A |
| lease_logging_member | String | N | N | N | N/A |
| lease_per_client_settings | String | N | N | N | N/A |
| lease_scavenge_time | Integer | N | N | N | N/A |
| log_lease_events | Bool | N | N | N | N/A |
| logic_filter_rules | [struct] | N | N | N | N/A |
| low_water_mark | Unsigned int | N | N | N | N/A |
| low_water_mark_reset | Unsigned int | N | N | N | N/A |
| microsoft_code_page | String | N | N | N | N/A |
| nextserver | String | N | N | N | N/A |
| option60_match_rules | [struct] | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| ping_count | Unsigned int | N | N | N | N/A |
| ping_timeout | Unsigned int | N | N | N | N/A |
| preferred_lifetime | Unsigned int | N | N | N | N/A |
| prefix_length_mode | String | N | N | N | N/A |
| protocol_hostname_rewrite_policies | [obj] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| recycle_leases | Bool | N | N | N | N/A |
| restart_setting | struct | N | N | N | N/A |
| retry_ddns_updates | Bool | N | N | N | N/A |
| syslog_facility | String | N | N | N | N/A |
| txt_record_handling | String | N | N | N | N/A |
| update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| valid_lifetime | Unsigned int | N | N | N | N/A |
grid:dashboard : Grid Dashboard object.