This object represents a subset of the Infoblox Member DHCP properties.
References to member:dhcpproperties are object references. The name part of a Member DHCP properties object reference has the following components:
Example: member:dhcpproperties/ZG5zLm5ldHdvcmtfdmlldyQxMTk:member.com
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): host_name, ipv4addr, ipv6addr.
The Authentication Server Group object associated with this member.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The captive portal responsible for authenticating this DHCP member.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The MAC filter representing the authenticated range.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The flag that controls if this DHCP member is enabled for captive portal authentication.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The MAC filter representing the guest range.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The flag that controls if this DHCP member can send authentication requests to an authentication server group.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The authority flag of a Grid member. This flag specifies if a DHCP server is authoritative for a domain.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
authority is associated with the field use_authority (see use flag).
The name of a file that DHCP clients need to boot. This setting overrides the Grid level setting.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootfile is associated with the field use_bootfile (see use flag).
The name of the server on which a boot file is stored. This setting overrides the Grid level setting.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootserver is associated with the field use_bootserver (see use flag).
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.
Notes
ddns_domainname is associated with the field use_ddns_domainname (see use flag).
Determines the ability of a member 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.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_generate_hostname is associated with the field use_ddns_generate_hostname (see use flag).
Determines the retry interval when the member 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.
Notes
ddns_retry_interval is associated with the field use_retry_ddns_updates (see use flag).
Determines that only the DHCP server is allowed to update DNS, regardless of the requests from the DHCP clients. This setting overrides the Grid level setting.
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.
Notes
ddns_ttl is associated with the field use_ddns_ttl (see use flag).
Determines if the member 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.
Notes
ddns_update_fixed_addresses is associated with the field use_ddns_update_fixed_addresses (see use flag).
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.
Notes
ddns_use_option81 is associated with the field use_ddns_use_option81 (see use flag).
An ordered list of zone primaries that will receive DDNS updates.
Type
A/An Ddns Zone Primary struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Determines if a BOOTP server denies BOOTP request or not. This setting overrides the Grid level setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
deny_bootp is associated with the field use_deny_bootp (see use flag).
The percentage of the total DHCP utilization of DHCP objects belonging to the Grid Member multiplied by 1000. This is the percentage of the total number of available IP addresses from all the DHCP objects belonging to the Grid Member versus the total number of all IP addresses in all of the DHCP objects on the Grid Member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dhcp_utilization cannot be updated.
dhcp_utilization cannot be written.
A string describing the utilization level of DHCP objects that belong to the Grid Member.
Type
String.
Search
The field is not available for search.
Notes
The dhcp_utilization_status cannot be updated.
dhcp_utilization_status cannot be written.
The update style for dynamic DNS updates.
Type
String.
Create
The default value is The default value is determined bythe Grid DHCP properties.
Search
The field is not available for search.
Notes
dns_update_style is associated with the field use_dns_update_style (see use flag).
The total number of DHCP leases issued for the DHCP objects on the Grid Member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dynamic_hosts cannot be updated.
dynamic_hosts cannot be written.
The email_list value of a member DHCP server.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
email_list is associated with the field use_email_list (see use flag).
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.
Notes
enable_ddns is associated with the field use_enable_ddns (see use flag).
Determines if the DHCP service of a member is enabled or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the DHCP service on the IPv6 LAN2 interface is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the DHCP service on the LAN2 interface 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. This setting overrides the Grid level setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_dhcp_thresholds is associated with the field use_enable_dhcp_thresholds (see use flag).
Determines if DHCPv6 service for the member is enabled or not.
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 fingerprint feature is enabled on this member. If you enable this feature, the server will match a fingerprint for incoming lease requests.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_fingerprint is associated with the field use_enable_fingerprint (see use flag).
Determines whether the appliance is 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.
Notes
enable_gss_tsig is associated with the field use_enable_gss_tsig (see use flag).
Determines if the Grid member’s host name rewrite feature is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_hostname_rewrite is associated with the field use_enable_hostname_rewrite (see use flag).
Determines if lease query is allowed or not. This setting overrides the Grid-level setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_leasequery is associated with the field use_enable_leasequery (see use flag).
Determines if SNMP warnings are enabled or disabled on this DHCP member. When DHCP threshold is enabled and DHCP address usage crosses a watermark threshold, the appliance sends an SNMP trap to the trap receiver that was defined for the Grid member level.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The list of GSS-TSIG keys for a member 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.
Notes
gss_tsig_keys is associated with the field use_gss_tsig_keys (see use flag).
Determines the high watermark value of a member 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.
Notes
high_water_mark is associated with the field use_enable_dhcp_thresholds (see use flag).
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.
Notes
high_water_mark_reset is associated with the field use_enable_dhcp_thresholds (see use flag).
Host name of the Grid member.
Type
String.
Search
The field is available for search via
Notes
The host_name is part of the base object.
The host_name cannot be updated.
host_name cannot be written.
The hostname rewrite policy that is in the protocol hostname rewrite policies array of the Grid DHCP object. This attribute is mandatory if enable_hostname_rewrite is “true”.
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.
Notes
hostname_rewrite_policy is associated with the field use_enable_hostname_rewrite (see use flag).
Determines if the ignore DHCP option list request flag of a Grid member 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.
Notes
ignore_dhcp_option_list_request is associated with the field use_ignore_dhcp_option_list_request (see use flag).
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.
Notes
ignore_id is associated with the field use_ignore_id (see use flag).
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 Immediate Fixed address configuration apply feature for the DHCP member is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
immediate_fa_configuration is associated with the field use_immediate_fa_configuration (see use flag).
The IPv4 Address of the Grid member.
Type
String.
Search
The field is available for search via
Notes
The ipv4addr is part of the base object.
The ipv4addr cannot be updated.
ipv4addr cannot be written.
The member DDNS IPv6 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.
Notes
ipv6_ddns_domainname is associated with the field use_ipv6_ddns_domainname (see use flag).
Controls whether the FQDN option sent by the DHCPv6 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.
Notes
ipv6_ddns_enable_option_fqdn is associated with the field use_ipv6_ddns_enable_option_fqdn (see use flag).
The member IPv6 DDNS hostname 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.
Notes
ipv6_ddns_hostname is associated with the field use_ipv6_ddns_hostname (see use flag).
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 member IPv6 DDNS TTL value.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Notes
ipv6_ddns_ttl is associated with the field use_ipv6_ddns_ttl (see use flag).
The update style for dynamic DHCPv6 DNS updates.
Type
String.
Create
The default value is The default value is determined bythe Grid DHCP properties.
Search
The field is not available for search.
Notes
ipv6_dns_update_style is associated with the field use_ipv6_dns_update_style (see use flag).
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.
Notes
ipv6_domain_name is associated with the field use_ipv6_domain_name (see use flag).
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.
Notes
ipv6_domain_name_servers is associated with the field use_ipv6_domain_name_servers (see use flag).
Determines if sending DDNS updates by the member DHCPv6 server is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ipv6_enable_ddns is associated with the field use_ipv6_enable_ddns (see use flag).
Determines whether the appliance is 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.
Notes
ipv6_enable_gss_tsig is associated with the field use_ipv6_enable_gss_tsig (see use flag).
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.
Notes
ipv6_enable_lease_scavenging is associated with the field use_ipv6_lease_scavenging (see use flag).
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.
Notes
ipv6_enable_retry_updates is associated with the field use_ipv6_enable_retry_updates (see use flag).
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.
Notes
ipv6_generate_hostname is associated with the field use_ipv6_generate_hostname (see use flag).
The list of GSS-TSIG keys for a member 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.
Notes
ipv6_gss_tsig_keys is associated with the field use_ipv6_gss_tsig_keys (see use flag).
Determines the IPv6 address or FQDN of the Kerberos server for DHCPv6 GSS-TSIG authentication. This setting overrides the Grid level setting.
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.
Notes
ipv6_kdc_server is associated with the field use_ipv6_enable_gss_tsig (see use flag).
The member-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.
Notes
ipv6_lease_scavenging_time is associated with the field use_ipv6_lease_scavenging (see use flag).
The Microsoft client DHCP IPv6 code page value of a Grid member. This value is the hostname translation code page for Microsoft DHCP IPv6 clients and overrides the Grid level Microsoft DHCP IPv6 client code page.
Type
String.
Create
The default value is None.
Search
The field is not available for search.
Notes
ipv6_microsoft_code_page is associated with the field use_ipv6_microsoft_code_page (see use flag).
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:
empty
Search
The field is not available for search.
Notes
ipv6_options is associated with the field use_ipv6_options (see use flag).
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 lease 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.
Notes
ipv6_recycle_leases is associated with the field use_ipv6_recycle_leases (see use flag).
Enable binding for expired DHCPv6 leases.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ipv6_remember_expired_client_association is associated with the field use_ipv6_lease_scavenging (see use flag).
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.
Notes
ipv6_retry_updates_interval is associated with the field use_ipv6_enable_retry_updates (see use flag).
The server DHCPv6 unique identifier (DUID) for the Grid member.
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 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.
Notes
ipv6_update_dns_on_lease_renewal is associated with the field use_ipv6_update_dns_on_lease_renewal (see use flag).
The IPv6 Address of the Grid member.
Type
String.
Search
The field is available for search via
Notes
The ipv6addr is part of the base object.
The ipv6addr cannot be updated.
ipv6addr cannot be written.
The IPv4 address or FQDN of the Kerberos server for DHCPv4 GSS-TSIG authentication. This setting overrides the Grid level setting.
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.
Notes
kdc_server is associated with the field use_enable_gss_tsig (see use flag).
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.
Notes
lease_per_client_settings is associated with the field use_lease_per_client_settings (see use flag).
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.
Notes
lease_scavenge_time is associated with the field use_lease_scavenge_time (see use flag).
This value specifies whether the grid member logs lease events. This setting overrides the Grid level setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
log_lease_events is associated with the field use_log_lease_events (see use flag).
This field contains the logic filters to be applied on the Grid member.
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.
Notes
logic_filter_rules is associated with the field use_logic_filter_rules (see use flag).
Determines the low watermark value. If the percent of allocated addresses drops below this watermark, the appliance makes a syslog entry and sends an e-mail notification (if enabled).
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Notes
low_water_mark is associated with the field use_enable_dhcp_thresholds (see use flag).
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.
Notes
low_water_mark_reset is associated with the field use_enable_dhcp_thresholds (see use flag).
The Microsoft client DHCP IPv4 code page value of a grid member. This value is the hostname translation code page for Microsoft DHCP IPv4 clients and overrides the Grid level Microsoft DHCP IPv4 client code page.
Type
String.
Create
The default value is None.
Search
The field is not available for search.
Notes
microsoft_code_page is associated with the field use_microsoft_code_page (see use flag).
The next server value of a member 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.
Notes
nextserver is associated with the field use_nextserver (see use flag).
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.
Type
A/An DHCP option struct array.
Create
The default value is:
[ { 'name': 'dhcp-lease-time',
'num': 51,
'use_option': False,
'value': '43200',
'vendor_class': 'DHCP'}]
Search
The field is not available for search.
Notes
options is associated with the field use_options (see use flag).
Specifies the number of pings that the Infoblox appliance sends to an IP address to verify that it is not in use. Values are 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.
Notes
ping_count is associated with the field use_ping_count (see use flag).
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.
Notes
ping_timeout is associated with the field use_ping_timeout (see use flag).
The preferred lifetime value.
Type
Unsigned integer.
Create
The default value is 27000.
Search
The field is not available for search.
Notes
preferred_lifetime is associated with the field use_preferred_lifetime (see use flag).
The Prefix length mode for DHCPv6.
Type
String.
Create
The default value is The default value is determined bythe Grid DHCP properties.
Search
The field is not available for search.
Notes
prefix_length_mode is associated with the field use_prefix_length_mode (see use flag).
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 empty.
Search
The field is not available for search.
Notes
pxe_lease_time is associated with the field use_pxe_lease_time (see use flag).
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.
Notes
recycle_leases is associated with the field use_recycle_leases (see use flag).
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.
Notes
retry_ddns_updates is associated with the field use_retry_ddns_updates (see use flag).
The number of static DHCP addresses configured in DHCP objects that belong to the Grid Member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The static_hosts cannot be updated.
static_hosts cannot be written.
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.
Notes
syslog_facility is associated with the field use_syslog_facility (see use flag).
The total number of DHCP addresses configured in DHCP objects that belong to the Grid Member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The total_hosts cannot be updated.
total_hosts cannot be written.
Controls whether the DHCP server updates DNS when a DHCP lease is renewed.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
update_dns_on_lease_renewal is associated with the field use_update_dns_on_lease_renewal (see use flag).
Use flag for: authority
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootfile
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_generate_hostname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_update_fixed_addresses
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_use_option81
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: deny_bootp
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: dns_update_style
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: email_list
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_dhcp_thresholds , high_water_mark, high_water_mark_reset, low_water_mark, low_water_mark_reset
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_fingerprint
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: kdc_server , enable_gss_tsig
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_hostname_rewrite , hostname_rewrite_policy
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_leasequery
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_one_lease_per_client
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: gss_tsig_keys
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_dhcp_option_list_request
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_id
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: immediate_fa_configuration
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_ddns_enable_option_fqdn
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_ddns_hostname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_ddns_ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_dns_update_style
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_domain_name
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_domain_name_servers
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_kdc_server , ipv6_enable_gss_tsig
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_enable_retry_updates , ipv6_retry_updates_interval
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_generate_hostname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_gss_tsig_keys
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_enable_lease_scavenging , ipv6_lease_scavenging_time, ipv6_remember_expired_client_association
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_microsoft_code_page
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_recycle_leases
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_update_dns_on_lease_renewal
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: lease_per_client_settings
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: lease_scavenge_time
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: log_lease_events
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: logic_filter_rules
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: microsoft_code_page
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: nextserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ping_count
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ping_timeout
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: preferred_lifetime
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: prefix_length_mode
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: pxe_lease_time
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: recycle_leases
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_retry_interval , retry_ddns_updates
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: syslog_facility
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: update_dns_on_lease_renewal
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: valid_lifetime
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The valid lifetime for Grid Member DHCP. Specifies the length of time addresses that are assigned to DHCPv6 clients remain in the valid state.
Type
Unsigned integer.
Create
The default value is 43200.
Search
The field is not available for search.
Notes
valid_lifetime is associated with the field use_valid_lifetime (see use flag).
Use this function to clear the NAC authentication cache.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
mac_address ( String. ) The MAC address used to clear specific authentication cache entry. If the MAC address is not present, the entire authentication cache is cleared. The default value is “None”.
Output fields
None
Use this function to purge IF-MAP data published by the member.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| auth_server_group | String | N | N | N | N/A |
| authn_captive_portal | String | N | N | N | N/A |
| authn_captive_portal_authenticated_filter | String | N | N | N | N/A |
| authn_captive_portal_enabled | Bool | N | N | N | N/A |
| authn_captive_portal_guest_filter | String | N | N | N | N/A |
| authn_server_group_enabled | Bool | N | N | N | N/A |
| authority | Bool | N | N | N | N/A |
| bootfile | String | N | N | N | N/A |
| bootserver | String | 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 |
| ddns_zone_primaries | [struct] | N | N | N | N/A |
| deny_bootp | Bool | N | N | N | N/A |
| dhcp_utilization | Unsigned int | N | Y | N | N/A |
| dhcp_utilization_status | String | N | Y | N | N/A |
| dns_update_style | String | N | N | N | N/A |
| dynamic_hosts | Unsigned int | N | Y | N | N/A |
| email_list | [String] | N | N | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_dhcp | Bool | N | N | N | N/A |
| enable_dhcp_on_ipv6_lan2 | Bool | N | N | N | N/A |
| enable_dhcp_on_lan2 | Bool | N | N | N | N/A |
| enable_dhcp_thresholds | Bool | N | N | N | N/A |
| enable_dhcpv6_service | 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_snmp_warnings | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| 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 |
| host_name | String | N | Y | Y | = ~ |
| 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 |
| ipv4addr | String | N | Y | Y | = ~ |
| ipv6_ddns_domainname | String | N | N | N | N/A |
| ipv6_ddns_enable_option_fqdn | Bool | N | N | N | N/A |
| ipv6_ddns_hostname | String | 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_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_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_server_duid | String | N | N | N | N/A |
| ipv6_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| ipv6addr | String | N | Y | Y | = ~ |
| kdc_server | 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 |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| recycle_leases | Bool | N | N | N | N/A |
| retry_ddns_updates | Bool | N | N | N | N/A |
| static_hosts | Unsigned int | N | Y | N | N/A |
| syslog_facility | String | N | N | N | N/A |
| total_hosts | Unsigned int | N | Y | N | N/A |
| update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| use_authority | Bool | N | N | N | N/A |
| use_bootfile | Bool | N | N | N | N/A |
| use_bootserver | Bool | N | N | N | N/A |
| use_ddns_domainname | Bool | N | N | N | N/A |
| use_ddns_generate_hostname | Bool | N | N | N | N/A |
| use_ddns_ttl | Bool | N | N | N | N/A |
| use_ddns_update_fixed_addresses | Bool | N | N | N | N/A |
| use_ddns_use_option81 | Bool | N | N | N | N/A |
| use_deny_bootp | Bool | N | N | N | N/A |
| use_dns_update_style | Bool | N | N | N | N/A |
| use_email_list | Bool | N | N | N | N/A |
| use_enable_ddns | Bool | N | N | N | N/A |
| use_enable_dhcp_thresholds | Bool | N | N | N | N/A |
| use_enable_fingerprint | Bool | N | N | N | N/A |
| use_enable_gss_tsig | Bool | N | N | N | N/A |
| use_enable_hostname_rewrite | Bool | N | N | N | N/A |
| use_enable_leasequery | Bool | N | N | N | N/A |
| use_enable_one_lease_per_client | Bool | N | N | N | N/A |
| use_gss_tsig_keys | Bool | N | N | N | N/A |
| use_ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| use_ignore_id | Bool | N | N | N | N/A |
| use_immediate_fa_configuration | Bool | N | N | N | N/A |
| use_ipv6_ddns_domainname | Bool | N | N | N | N/A |
| use_ipv6_ddns_enable_option_fqdn | Bool | N | N | N | N/A |
| use_ipv6_ddns_hostname | Bool | N | N | N | N/A |
| use_ipv6_ddns_ttl | Bool | N | N | N | N/A |
| use_ipv6_dns_update_style | Bool | N | N | N | N/A |
| use_ipv6_domain_name | Bool | N | N | N | N/A |
| use_ipv6_domain_name_servers | Bool | N | N | N | N/A |
| use_ipv6_enable_ddns | Bool | N | N | N | N/A |
| use_ipv6_enable_gss_tsig | Bool | N | N | N | N/A |
| use_ipv6_enable_retry_updates | Bool | N | N | N | N/A |
| use_ipv6_generate_hostname | Bool | N | N | N | N/A |
| use_ipv6_gss_tsig_keys | Bool | N | N | N | N/A |
| use_ipv6_lease_scavenging | Bool | N | N | N | N/A |
| use_ipv6_microsoft_code_page | Bool | N | N | N | N/A |
| use_ipv6_options | Bool | N | N | N | N/A |
| use_ipv6_recycle_leases | Bool | N | N | N | N/A |
| use_ipv6_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| use_lease_per_client_settings | Bool | N | N | N | N/A |
| use_lease_scavenge_time | Bool | N | N | N | N/A |
| use_log_lease_events | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_microsoft_code_page | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_ping_count | Bool | N | N | N | N/A |
| use_ping_timeout | Bool | N | N | N | N/A |
| use_preferred_lifetime | Bool | N | N | N | N/A |
| use_prefix_length_mode | Bool | N | N | N | N/A |
| use_pxe_lease_time | Bool | N | N | N | N/A |
| use_recycle_leases | Bool | N | N | N | N/A |
| use_retry_ddns_updates | Bool | N | N | N | N/A |
| use_syslog_facility | Bool | N | N | N | N/A |
| use_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| use_valid_lifetime | Bool | N | N | N | N/A |
| valid_lifetime | Unsigned int | N | N | N | N/A |
