A shared network is a network segment to which you assign two or more subnets. When subnets in a shared network contain IP addresses that are available for dynamic allocation, the addresses are put into a common pool for allocation when client requests arise. When you create a shared network, the DHCP server can assign IP addresses to client requests from any subnet (that resides on the same network interface) in the shared network.
References to ipv6sharednetwork are object references. The name part of an ipv6 shared network object reference has the following components:
Example: ipv6sharednetwork/5ldHdvcmskMTEuMC4:sharedname
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, network_view, networks.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| networks |
Comment for the IPv6 shared 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 only the DHCP server is allowed to update DNS, regardless of the DHCP clients 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 an IPv6 shared 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).
The support for DHCP Option 81 at the IPv6 shared 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).
Determines whether an IPv6 shared network is disabled or not. When this is set to False, the IPv6 shared network is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use this method to set or retrieve the domain_name value of a DHCP IPv6 Shared 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 Shared 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 an IPv6 shared 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.
This field contains the logic filters to be applied on the this IPv6 shared network.
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).
The name of the IPv6 Shared Network.
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 of the network view in which this IPv6 shared network resides.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default DNS view.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The network_view cannot be updated.
A list of IPv6 networks belonging to the shared network
Each individual list item must be specified as an object containing a ‘_ref’ parameter to a network reference, for example:
[{
"_ref": "ipv6network/ZG5zdHdvcmskMTAuAvMTYvMA",
}]
if the reference of the wanted network is not known, it is possible to specify search parameters for the network instead in the following way:
[{
"_ref": {
'network': 'aabb::/64',
}
}]
note that in this case the search must match exactly one network for the assignment to be successful.
Type
A/An ipv6network object array.
This field supports nested return fields as described here.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The networks 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 Shared 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).
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_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_use_option81
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: 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 Shared 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 |
|---|---|---|---|---|---|
| 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_use_option81 | Bool | N | N | N | N/A |
| disable | Bool | 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 |
| logic_filter_rules | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | Y | = |
| networks | [obj] | Y | N | Y | N/A |
| options | [struct] | N | N | N | N/A |
| preferred_lifetime | Unsigned int | 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_generate_hostname | Bool | N | N | N | N/A |
| use_ddns_ttl | Bool | N | N | N | N/A |
| use_ddns_use_option81 | 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_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 |
ipv6rangetemplate : IPv6 DHCP Range template object.
kerberoskey : Kerberos key object.
Enter search terms or a module, class or function name.