A network can contain child networks. The network that contains child networks is called a network container. This object encapsulates an IPv6 network container object.
References to ipv6networkcontainer are object references. The name part of a nc object reference has the following components:
- Address of the network container
- CIDR for the network container
- Name of the network view
Example: ipv6networkcontainer/5ldHdvcmskMTEuMC4:abcd%3A%3A/80/external
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, network, network_view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| network |
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.
Notes
The auto_create_reversezone cannot be updated.
auto_create_reversezone is not readable.
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Create
The default value is empty.
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 container.
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 Container 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 container 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 reason for deleting the RIR registration request.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
delete_reason is not readable.
Discover now status for this network container.
Type
String.
Search
The field is not available for search.
Notes
The discover_now_status cannot be updated.
discover_now_status cannot be written.
The discovery basic poll settings for this network container.
Type
A/An Basic Poll Settings struct.
Create
The default value is:
{ 'auto_arp_refresh_before_switch_port_polling': True,
'cli_collection': True,
'complete_ping_sweep': False,
'credential_group': 'default',
'device_profile': False,
'netbios_scanning': False,
'port_scanning': False,
'smart_subnet_ping_sweep': False,
'snmp_collection': True,
'switch_port_data_collection_polling': 'PERIODIC',
'switch_port_data_collection_polling_interval': 3600}
Search
The field is not available for search.
Notes
discovery_basic_poll_settings is associated with the field use_discovery_basic_polling_settings (see use flag).
The discovery blackout setting for this network container.
Type
A/An Blackout Setting struct.
Create
The default value is:
{ 'enable_blackout': False}
Search
The field is not available for search.
Notes
discovery_blackout_setting is associated with the field use_blackout_setting (see use flag).
The network discovery engine type.
Type
String.
Search
The field is available for search via
Notes
The discovery_engine_type cannot be updated.
discovery_engine_type cannot be written.
The member that will run discovery for this network container.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
discovery_member is associated with the field use_enable_discovery (see use flag).
Use this method to set or retrieve the dynamic DNS updates flag of a DHCP IPv6 Network Container 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 container 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 whether a discovery is enabled or not for this network container. When this is set to False, the network container discovery is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_discovery is associated with the field use_enable_discovery (see use flag).
Determines if the discovery for the network container should be immediately enabled.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
enable_immediate_discovery is not readable.
The endpoints that provides data for the DHCP IPv6 Network Container.
Type
An array of the following objects: ciscoise:endpoint, pxgrid:endpoint.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The endpoint_sources cannot be updated.
endpoint_sources cannot be written.
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 timestamp when the last RIR registration update was sent.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_rir_registration_update_sent cannot be updated.
last_rir_registration_update_sent cannot be written.
Last RIR registration update status.
Type
String.
Search
The field is not available for search.
Notes
The last_rir_registration_update_status cannot be updated.
last_rir_registration_update_status cannot be written.
This field contains the logic filters to be applied on the this network container.
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).
This field controls whether this object is synchronized with the Multi-Grid Master. If this field is set to True, objects are not synchronized.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
mgm_private is associated with the field use_mgm_private (see use flag).
This field is assumed to be True unless filled by any conforming objects, such as Network, IPv6 Network, Network Container, IPv6 Network Container, and Network View. This value is set to False if mgm_private is set to True in the parent object.
Type
Bool.
Search
The field is not available for search.
Notes
The mgm_private_overridable cannot be updated.
mgm_private_overridable cannot be written.
The Microsoft Active Directory user related information.
Type
A/An Active Directory User Data struct.
Search
The field is not available for search.
Notes
The ms_ad_user_data cannot be updated.
ms_ad_user_data cannot be written.
The network address in IPv6 Address/CIDR format. For regular expression searches, only the IPv6 Address portion is supported. Searches for the CIDR portion is always an exact match.
For example, both network containers 16::0/28 and 26::0/24 are matched by expression ‘.6’ and only 26::0/24 is matched by ‘.6/24’.
Type
String.
The field also supports automatic selection of the next available network with selected CIDR in the specified IPv6 network or network container. You can specify the IPv6 network or network container in the following ways:
Using a IPv6 network or network container WAPI reference:
- func:nextavailablenetwork:<reference>,<CIDR>
Using a IPv6 network lookup (if the view is not specified, the default view will be used):
- func:nextavailablenetwork:<network>[,<network view>],<CIDR>
Scheduled and approval operations are not supported when using the automatic network selection.
If you specify a network view for automatic network selection, you should also add a network_view field in the object to be inserted with the same network view because the network view for automatic network selection is not used for the actual object insertion.
NOTE: Automatic selection is supported only for JSON and XML requests.
Examples:
- func:nextavailablenetwork:ipv6network/ZG54dfgsrDFEFfsfsLzA:1000::/8/default,16
- func:nextavailablenetwork:1000::/8,16
- func:nextavailablenetwork:1000::/8,external,16
This field can also be retrieved from a function call as part of an object insertion. The supported function calls for this field are:
- the next_available_network function call in object ipv6networkcontainer (default parameters: {‘num’: 1})
To find out if the function can be called when _object_parameters matches multiple objects, see the function documentation.
The default parameters are passed to the specified function call and can be overridden by passing different values for the same parameter in _parameters.
To execute the function call, a dictionary must be set in this field with the following parameters:
Mandatory Name Comment Y _object_function The name of the function. Y _result_field The field in which the function returns its result. See comment _object The WAPI object type on which the function calls. Either _object or _object_ref must be set. See comment _object_ref A WAPI object reference on which the function calls. Either _object or _object_ref must be set. N _parameters The parameters to be passed to the function. See comment _object_parameters The parameters used for the object search, mandatory if _object is set. As part of the insertion, the object identified by _object and _object_parameters will be fetched, and the function identified by _object_function will be called with the parameters specified in _parameters. The result of this function will be retrieved and the field of this function specified in _result_field will be extracted and used as the value for this field.
Note that if the function call returns a list, and the field requires a single value, the first value on the list will be used.
The following example uses a value for the ‘next_available_ip’ field in the 9.0.0.0/8 network, excluding IP addresses 9.0.0.1 and 9.0.0.2:
{ '_object_function': 'next_available_ip', '_parameters': { 'exclude': ['9.0.0.1', '9.0.0.2'], }, '_result_field': 'ips', '_object': 'network', '_object_parameters': { 'network': '9.0.0.0/8', 'network_view': 'newdefaultnv', } }Note this function call might not be valid for this particular field, this is just an example.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The network is part of the base object.
The network cannot be updated.
The network container to which this network belongs, if any.
Type
String.
Search
The field is available for search via
Notes
The network_container cannot be updated.
network_container cannot be written.
The name of the network view in which this 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.
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 port control blackout setting for this network container.
Type
A/An Blackout Setting struct.
Create
The default value is:
{ 'enable_blackout': False}
Search
The field is not available for search.
Notes
port_control_blackout_setting is associated with the field use_blackout_setting (see use flag).
Use this method to set or retrieve the preferred lifetime value of a DHCP IPv6 Network Container 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).
Restarts the member service.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
restart_if_needed is not readable.
The registry (RIR) that allocated the IPv6 network container 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 container.
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 undefined.
Search
The field is not available for search.
Notes
rir_registration_action is not readable.
The registration status of the IPv6 network container in RIR.
Type
String.
Create
The default value is NOT_REGISTERED.
Search
The field is not available for search.
If the field is set to True, the discovery blackout setting will be used for port control blackout setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
same_port_control_discovery_blackout is associated with the field use_blackout_setting (see use flag).
Determines whether to send the RIR registration request.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
send_rir_request is not readable.
The DHCP IPv6 Network Container Cisco ISE subscribe settings.
Type
A/An Cisco ISE subscribe settings struct struct.
Create
The default value is empty.
Search
The field is not available for search.
Notes
subscribe_settings is associated with the field use_subscribe_settings (see use flag).
Determines whether the network container is unmanaged or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
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: discovery_blackout_setting , port_control_blackout_setting, same_port_control_discovery_blackout
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_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: discovery_basic_poll_settings
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: discovery_member , enable_discovery
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: mgm_private
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: subscribe_settings
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 flag for: zone_associations
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The network container utilization in percentage.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The utilization cannot be updated.
utilization cannot be written.
Use this method to set or retrieve the valid lifetime value of a DHCP IPv6 Network Container 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).
The list of zones associated with this network container.
Type
A/An Zone association struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
zone_associations is associated with the field use_zone_associations (see use flag).
This function will retrieve the next available network in the network container.
This function supports multiple object matches when called as part of an atomic insertion operation.
Input fields
cidr ( Unsigned integer. ) The CIDR of the requested network(s). This is a required parameter.
exclude ( String array. ) An array of networks you want to exclude from the results.
num ( Unsigned integer. ) The number of networks you are requesting.
Output fields
networks ( String array. ) The requested network(s).
These fields are used only as delete arguments. They are not actual members of the object and therefore will never be returned by the server with this name unless they are nested return fields.
Remove subnets delete option. Determines whether all child objects should be removed alongside with the IPv6 network container or child objects should be assigned to another parental container. By default child objects are deleted with this network container.
Type
Bool.
Notes
remove_subnets is a delete argument.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| auto_create_reversezone | Bool | N | N | N | N/A |
| cloud_info | struct | 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 |
| delete_reason | String | N | N | N | N/A |
| discover_now_status | String | N | Y | N | N/A |
| discovery_basic_poll_settings | struct | N | N | N | N/A |
| discovery_blackout_setting | struct | N | N | N | N/A |
| discovery_engine_type | String | N | Y | N | = |
| discovery_member | String | N | N | N | N/A |
| domain_name_servers | [String] | N | N | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_discovery | Bool | N | N | N | N/A |
| enable_immediate_discovery | Bool | N | N | N | N/A |
| endpoint_sources | obj | N | Y | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| last_rir_registration_update_sent | Timestamp | N | Y | N | N/A |
| last_rir_registration_update_status | String | N | Y | N | N/A |
| logic_filter_rules | [struct] | N | N | N | N/A |
| mgm_private | Bool | N | N | N | N/A |
| mgm_private_overridable | Bool | N | Y | N | N/A |
| ms_ad_user_data | struct | N | Y | N | N/A |
| network | String | Y | N | Y | = ~ |
| network_container | String | N | Y | N | = |
| network_view | String | N | N | Y | = |
| options | [struct] | N | N | N | N/A |
| port_control_blackout_setting | struct | N | N | N | N/A |
| preferred_lifetime | Unsigned int | N | N | N | N/A |
| restart_if_needed | 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 |
| same_port_control_discovery_blackout | Bool | N | N | N | N/A |
| send_rir_request | Bool | N | N | N | N/A |
| subscribe_settings | struct | N | N | N | N/A |
| unmanaged | Bool | N | N | N | = |
| update_dns_on_lease_renewal | Bool | N | N | N | N/A |
| use_blackout_setting | 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_discovery_basic_polling_settings | 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_enable_discovery | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_mgm_private | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_preferred_lifetime | Bool | N | N | N | N/A |
| use_subscribe_settings | 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 |
| use_zone_associations | Bool | N | N | N | N/A |
| utilization | Unsigned int | N | Y | N | N/A |
| valid_lifetime | Unsigned int | N | N | N | N/A |
| zone_associations | [struct] | N | N | N | N/A |
| Argument | Type |
|---|---|
| remove_subnets | Bool |
ipv6network : DHCP IPv6Network object.