The network template used to create networks in a quick and consistent way. Networks created from a network template inherit all the properties defined in the network template, except for the comment and netmask that can be defined in the network.
References to networktemplate are object references. The name part of a network template object reference has the following components:
- Name of the network template
Example: networktemplate/5ldHdvcmskMTEuMC4:testnt
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.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| netmask | See the field description for more information |
This flag controls whether the template allows any netmask. You must specify a netmask when creating a network using this template. If you set this parameter to false, you must specify the “netmask” field for the network template object.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Authority for the DHCP network.
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).
This flag controls whether reverse zones are automatically created when the network is added.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The boot server IPv4 Address or name in FQDN format for the network. You can specify the name and/or IP address of the boot server that the host needs to boot.
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 network. 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.
Comment for the network; maximum 256 characters.
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 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 network.
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).
This field controls whether the DHCP server is allowed to update DNS, regardless of the DHCP client requests. Note that changes for this field take effect only if ddns_use_option81 is True.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The DNS update Time to Live (TTL) value of a DHCP network object.
The TTL is 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 0.
Search
The field is not available for search.
Notes
ddns_ttl is associated with the field use_ddns_ttl (see use flag).
By default, the DHCP server does not update DNS when it allocates a fixed address to a client. You can configure the DHCP server to update the A and PTR records of a client with a fixed address. When this feature is enabled and the DHCP server adds A and PTR records for a fixed address, the DHCP server never discards the records.
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).
The support for DHCP Option 81 at the network level.
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).
Reference the Cloud Platform Appliance to which authority of the object should be delegated when the object is created using the template.
Type
A/An Grid member serving DHCP struct.
Create
The default value is empty.
Search
The field is not available for search.
If set to True, 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).
The dynamic DNS updates flag of a DHCP network object. If set to True, 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 network.
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 send through SNMP.
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 fixed address templates assigned to this network template object. When you create a network based on a network template object that contains fixed address templates, the fixed addresses are created based on the associated fixed address templates.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The percentage of DHCP network usage threshold above which network 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 network 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).
The e-mail lists to which the appliance sends IPAM threshold alarm e-mail messages.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
ipam_email_addresses is associated with the field use_ipam_email_addresses (see use flag).
The IPAM Threshold settings for this network template.
Type
A/An IPAM Threshold Settings struct.
Create
The default value is:
{ 'reset_value': 85, 'trigger_value': 95}
Search
The field is not available for search.
Notes
ipam_threshold_settings is associated with the field use_ipam_threshold_settings (see use flag).
The IPAM Trap settings for this network template.
Type
A/An IPAM Trap Settings struct.
Create
The default value is:
{ 'enable_email_warnings': False, 'enable_snmp_warnings': True}
Search
The field is not available for search.
Notes
ipam_trap_settings is associated with the field use_ipam_trap_settings (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 the this network template.
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 network 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 network usage threshold below which network 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.
A list of members or Microsoft (r) servers that serve DHCP for this network.
All members in the array must be of the same type. The struct type must be indicated in each element, by setting the “_struct” member to the struct type.
Type
One of the following: MS DHCP server struct, Grid member serving DHCP struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The name of this network template.
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 netmask of the network in CIDR format.
Type
Unsigned integer.
Create
Field netmask is required if allow_any_netmask is False.
Search
The field is not available for search.
The name in FQDN and/or IPv4 Address 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).
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 of a DHCP Network 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).
The list of IP address range templates assigned to this network template object. When you create a network based on a network template object that contains range templates, the IP address ranges are created based on the associated IP address range templates.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
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).
THe registry (RIR) that allocated the network address space.
Type
String.
Search
The field is available for search via
Notes
The rir cannot be updated.
rir cannot be written.
The RIR organization assoicated with the network.
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 available for search via
The RIR registration action.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
The registration status of the network in RIR.
Type
String.
Create
The default value is NOT_REGISTERED.
Search
The field is not available for search.
Determines whether to send the RIR registration request.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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: 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: 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: ipam_email_addresses
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipam_threshold_settings
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipam_trap_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: logic_filter_rules
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.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| allow_any_netmask | Bool | N | N | N | N/A |
| authority | Bool | N | N | N | N/A |
| auto_create_reversezone | Bool | N | N | N | N/A |
| 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 |
| 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 |
| delegated_member | struct | 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 |
| extattrs | Extattr | N | N | N | ext |
| fixed_address_templates | [String] | 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 |
| ipam_email_addresses | [String] | N | N | N | N/A |
| ipam_threshold_settings | struct | N | N | N | N/A |
| ipam_trap_settings | struct | 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 |
| members | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| netmask | Unsigned int | Y* | N | N | N/A |
| nextserver | String | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| range_templates | [String] | N | N | N | N/A |
| recycle_leases | Bool | N | N | N | N/A |
| rir | String | N | Y | N | = |
| rir_organization | String | N | N | N | = |
| rir_registration_action | String | N | N | N | N/A |
| rir_registration_status | String | N | N | N | N/A |
| send_rir_request | Bool | N | N | 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_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_ipam_email_addresses | Bool | N | N | N | N/A |
| use_ipam_threshold_settings | Bool | N | N | N | N/A |
| use_ipam_trap_settings | 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_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_update_dns_on_lease_renewal | Bool | N | N | N | N/A |
* Required in some cases, see detailed field description above.
networkcontainer : DHCP Network Container object.