The range template used to create a range objects in a quick and consistant way. Range object created from a range template will inherit most properties defined in range template object so most of the range template properties are the same as the range object properties.
References to rangetemplate are object references. The name part of a DHCP Range template object reference has the following components:
- Name of the DHCP Range template
Example: rangetemplate/ZG5zLmJpbmRfY25h:templatename
The object does not support the following operations:
The object cannot be 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): comment, name, number_of_addresses, offset.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| number_of_addresses | |
| offset |
The bootfile name for the range. You can configure the DHCP server to support clients that use 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.
Notes
bootfile is associated with the field use_bootfile (see use flag).
The bootserver address for the range. You can specify the name and/or IP address of the boot server that the host needs to boot.
The boot server IPv4 Address or name in FQDN format.
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).
This flag controls whether this template can be used to create network objects in a cloud-computing deployment.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
A descriptive comment of a range template object.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
The dynamic DNS domain name the appliance uses specifically for DDNS updates for this range.
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).
If this field is set to True, the DHCP server generates a hostname and updates DNS with it when the DHCP client request does not contain a hostname.
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).
The vconnector member that the object should be delegated to when created from this range template.
Type
A/An Grid member serving DHCP struct.
Create
The default value is empty.
Search
The field is not available for search.
If True, send NAK forcing the client to take the new address.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if BOOTP settings are disabled and BOOTP requests will be denied.
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 e-mail lists to which the appliance sends DHCP threshold alarm e-mail messages.
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 DHCP server sends DDNS updates to DNS servers in the same Grid, and to external DNS servers.
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 DHCP thresholds are enabled for the range.
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 DHCP threshold warnings are sent through email.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Set this to True if you want the DHCP server to use a different lease time for PXE clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if DHCP threshold warnings are sent through SNMP.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
These are ranges of IP addresses that the appliance does not use to assign to clients. You can use these exclusion addresses as static IP addresses. They contain the start and end addresses of the exclusion range, and optionally, information about this exclusion range.
Type
A/An Exclusion range template struct array.
Create
The default value is:
empty
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 name of the failover association: the server in this failover association will serve the IPv4 range in case the main server is out of service.
server_association_type must be set to ‘FAILOVER’ or ‘FAILOVER_MS’ if you want the failover association specified here to serve the range.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
This field contains the fingerprint filters for this DHCP range.
The appliance uses matching rules in these filters to select the address range from which it assigns a lease.
Type
A/An Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The percentage of DHCP range usage threshold above which range usage is not expected and may warrant your attention. When the high watermark is reached, the Infoblox appliance generates a syslog message and sends a warning (if enabled).
A number that 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.
The percentage of DHCP range usage below which the corresponding SNMP trap is reset.
A number that 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.
If this field is set to False, the appliance returns all DHCP options the client is eligible to receive, rather than only the list of options the client has requested.
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).
Permission for known clients. If set to ‘Deny’ known clients will be denied IP addresses.
Known clients include roaming hosts and clients with fixed addresses or DHCP host entries. Unknown clients include clients that are not roaming hosts and clients that do not have fixed addresses or DHCP host entries.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
known_clients is associated with the field use_known_clients (see use flag).
An integer that specifies the period of time (in seconds) that frees and backs up leases remained in the database before they are automatically deleted. 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 field contains the logic filters to be applied on this range.
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).
The percentage of DHCP range usage below which the Infoblox appliance generates a syslog message and sends a warning (if enabled).
A number that specifies the percentage of allocated addresses. The range is from 1 to 100.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
The percentage of DHCP range usage threshold below which range usage is not expected and may warrant your attention. When the low watermark is crossed, the Infoblox appliance generates a syslog message and sends a warning (if enabled).
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.
This field contains the MAC filters to be applied to this range.
The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.
Type
A/An Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The member that will provide service for this range.
server_association_type needs to be set to ‘MEMBER’ if you want the server specified here to serve the range. For searching by this field you should use a HTTP method that contains a body (POST or PUT) with Dhcp Member structure and the request should have option _method=GET.
Type
A/An Grid member serving DHCP struct.
Create
The default value is empty.
Search
The field is available for search via
The Microsoft DHCP options for this range.
Type
A/An Microsoft DHCP Options struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
ms_options is associated with the field use_ms_options (see use flag).
The Microsoft server that will provide service for this range.
server_association_type needs to be set to ‘MS_SERVER’ if you want the server specified here to serve the range. For searching by this field you should use a HTTP method that contains a body (POST or PUT) with MS DHCP server structure and the request should have option _method=GET.
Type
A/An MS DHCP server struct.
Create
The default value is empty.
Search
The field is available for search via
This field contains the NAC filters to be applied to this range.
The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.
Type
A/An Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The name of a range template object.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The name in FQDN and/or IPv4 Address format of the next server that the host needs to boot.
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 number of addresses for this range.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The number_of_addresses is part of the base object.
The start address offset for this range.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The offset is part of the base object.
This field contains the Option filters to be applied to this range.
The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.
Type
A/An Filter 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).
The PXE lease time value for a range object. Some hosts use PXE (Preboot Execution Environment) to boot remotely from a server. To better manage your IP resources, set a different lease time for PXE boot requests. You can configure the DHCP server to allocate an IP address with a shorter lease time to hosts that send PXE boot requests, so IP addresses are not leased longer than necessary.
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).
If the field is set to True, the leases are kept in the Recycle Bin until one week after expiration. Otherwise, the leases are permanently deleted.
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).
This field contains the Relay Agent filters to be applied to this range.
The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.
Type
A/An Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The type of server that is going to serve the range.
Type
String.
Create
The default value is NONE.
Search
The field is available for search via
Permission for unknown clients. If set to ‘Deny’ unknown clients will be denied IP addresses.
Known clients include roaming hosts and clients with fixed addresses or DHCP host entries. Unknown clients include clients that are not roaming hosts and clients that do not have fixed addresses or DHCP host entries.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
unknown_clients is associated with the field use_unknown_clients (see use flag).
This field 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: 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: deny_bootp
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
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: known_clients
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: logic_filter_rules
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ms_options
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: 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.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| cloud_api_compatible | Bool | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| ddns_domainname | String | N | N | N | N/A |
| ddns_generate_hostname | Bool | N | N | N | N/A |
| delegated_member | struct | N | N | N | N/A |
| deny_all_clients | Bool | N | N | N | N/A |
| deny_bootp | Bool | 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_pxe_lease_time | Bool | N | N | N | N/A |
| enable_snmp_warnings | Bool | N | N | N | N/A |
| exclude | [struct] | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| failover_association | String | N | N | N | = |
| fingerprint_filter_rules | [struct] | 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 |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| known_clients | String | N | N | N | N/A |
| lease_scavenge_time | Integer | 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 |
| mac_filter_rules | [struct] | N | N | N | N/A |
| member | struct | N | N | N | = |
| ms_options | [struct] | N | N | N | N/A |
| ms_server | struct | N | N | N | = |
| nac_filter_rules | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| nextserver | String | N | N | N | N/A |
| number_of_addresses | Unsigned int | Y | N | Y | N/A |
| offset | Unsigned int | Y | N | Y | N/A |
| option_filter_rules | [struct] | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| recycle_leases | Bool | N | N | N | N/A |
| relay_agent_filter_rules | [struct] | N | N | N | N/A |
| server_association_type | String | N | N | N | = |
| unknown_clients | String | N | N | N | N/A |
| update_dns_on_lease_renewal | 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_deny_bootp | 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_ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| use_known_clients | Bool | N | N | N | N/A |
| use_lease_scavenge_time | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_ms_options | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | 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_unknown_clients | Bool | N | N | N | N/A |
| use_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
