The IPv6 network template used to create IPv6 networks in a quick and consistent way. IPv6 networks created from an IPv6 network template inherit all the properties defined in the IPv6 network template, except for the comment and CIDR that can be defined in the IPv6 network.
References to ipv6networktemplate are object references. The name part of a IPv6 network template object reference has the following components:
- Name of the IPv6 network template
Example: ipv6networktemplate/5ldHdvcmskMTEuMC4:abcd%3A%3A/80/external
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 |
|---|---|
| cidr | Field cidr is required if allow_any_netmask is False. |
| name |
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 “cidr” field for the network template object.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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 CIDR of the network in CIDR format.
Type
Unsigned integer.
Create
Field cidr is required if allow_any_netmask is False.
Search
The field is not available for search.
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).
Use this method to set or retrieve the ddns_enable_option_fqdn flag of a DHCP IPv6 Network object. This method controls whether the FQDN option sent by the client is to be used, or if the server can automatically generate the FQDN. This setting overrides the upper-level settings.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_enable_option_fqdn is associated with the field use_ddns_enable_option_fqdn (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_enable_option_fqdn 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).
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.
Use this method to set or retrieve the domain_name value of a DHCP IPv6 Network object.
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
domain_name is associated with the field use_domain_name (see use flag).
Use this method to set or retrieve the dynamic DNS updates flag of a DHCP IPv6 Network object. The DHCP server can send DDNS updates to DNS servers in the same Grid and to external DNS servers. This setting overrides the member level settings.
Type
String array.
This field allows +/- to be specified as part of the field name when updating the object that adds or removes the specified value(s) to the list. An error will be returned if you add already existing value(s) or if you remove non-existent values(s). Note that this is supported only if you use JSON to access the WAPI.
Create
The default value is empty.
Search
The field is not available for search.
Notes
domain_name_servers is associated with the field use_domain_name_servers (see use flag).
The dynamic DNS updates flag of a DHCP IPv6 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).
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 IPv6 fixed address templates assigned to this IPv6 network template object. When you create an IPv6 network based on an IPv6 network template object that contains IPv6 fixed address templates, the IPv6 fixed addresses are created based on the associated IPv6 fixed address templates.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The IPv6 Address prefix of the DHCP IPv6 network.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
This field contains the logic filters to be applied on this IPv6 network template.
This list corresponds to the match rules that are written to the DHCPv6 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).
A list of members that serve DHCP for the 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
A/An Grid member serving DHCP struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The name of this IPv6 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.
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).
Use this method to set or retrieve the preferred lifetime value of a DHCP IPv6 Network object.
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 list of IPv6 address range templates assigned to this IPv6 network template object. When you create an IPv6 network based on an IPv6 network template object that contains IPv6 range templates, the IPv6 address ranges are created based on the associated IPv6 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 IPv6 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 associated with the IPv6 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 action for the RIR registration.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
The registration status of the IPv6 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: ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_enable_option_fqdn
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: domain_name
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: domain_name_servers
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: logic_filter_rules
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: preferred_lifetime
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: 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.
Use this method to set or retrieve the valid lifetime value of a DHCP IPv6 Network object.
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).
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| allow_any_netmask | Bool | N | N | N | N/A |
| auto_create_reversezone | Bool | N | N | N | N/A |
| cidr | Unsigned int | Y* | 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_enable_option_fqdn | Bool | 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 |
| delegated_member | struct | N | N | N | N/A |
| domain_name | String | N | N | N | N/A |
| domain_name_servers | [String] | N | N | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| fixed_address_templates | [String] | N | N | N | N/A |
| ipv6prefix | String | N | N | N | = ~ |
| logic_filter_rules | [struct] | N | N | N | N/A |
| members | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| options | [struct] | N | N | N | N/A |
| preferred_lifetime | 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_ddns_domainname | Bool | N | N | N | N/A |
| use_ddns_enable_option_fqdn | 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_domain_name | Bool | N | N | N | N/A |
| use_domain_name_servers | Bool | N | N | N | N/A |
| use_enable_ddns | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_preferred_lifetime | 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 |
| use_valid_lifetime | Bool | N | N | N | N/A |
| valid_lifetime | Unsigned int | N | N | N | N/A |
* Required in some cases, see detailed field description above.
ipv6networkcontainer : DHCP IPv6NetworkContainer object.