ipv6range : DHCP IPv6 Range object.

A DHCP IPv6 range defines the specified range of IP addresses in an IPv6 network. A DHCP IPv6 range should be added for an IPv6 network so the Infoblox appliance can assign IP addresses within that specified range to DHCP clients. If the client is on an IPv6 network that is assigned a DHCP IPv6 range, the device distributes an available IP address from that range to the DHCP client, or to a DHCP relay agent if the request came through an agent. The DHCP IPv6 range should also be assigned with a device. If devices are in a grid, the particular member serving DHCP for the DHCP IPv6 range must be specified. If the server is an independent device, this device must be specified as the member that serves the DHCP IPv6 range.

Object Reference

References to ipv6range are object references. The name part of a DHCP IPv6 Range object reference has the following components:

  • Start address of the range
  • End address of the range
  • Name of the view

Example: ipv6range/ZG5zLmJpbmRfY25h:abcd::1/abcd::10/external

Fields

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, end_addr, network, network_view, start_addr.

The following fields are required to create this object:

Field Notes
end_addr The field is required if address_type is ADDRESS/BOTH.
ipv6_end_prefix The field is required if address_type is PREFIX/BOTH.
ipv6_prefix_bits The field is required if address_type is PREFIX/BOTH.
ipv6_start_prefix The field is required if address_type is PREFIX/BOTH.
network  
start_addr The field is required if address_type is ADDRESS/BOTH.

address_type

address_type

Type of a DHCP IPv6 Range object. Valid values are “ADDRESS”, “PREFIX”, or “BOTH”. When the address type is “ADDRESS”, values for the ‘start_addr’ and ‘end_addr’ members are required. When the address type is “PREFIX”, values for ‘ipv6_start_prefix’, ‘ipv6_end_prefix’, and ‘ipv6_prefix_bits’ are required. When the address type is “BOTH”, values for ‘start_addr’, ‘end_addr’, ‘ipv6_start_prefix’, ‘ipv6_end_prefix’, and ‘ipv6_prefix_bits’ are all required.

Type

String.

Create

The default value is ADDRESS.

Search

The field is available for search via

  • ‘=’ (exact equality)

cloud_info

cloud_info

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

comment

Comment for the range; 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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

disable

disable

Determines whether a range is disabled or not. When this is set to False, the range is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

discover_now_status

discover_now_status

Discover now status for this range.

Type

String.

Valid values are:
  • COMPLETE
  • FAILED
  • NONE
  • PENDING
  • RUNNING

Search

The field is not available for search.

Notes

The discover_now_status cannot be updated.

discover_now_status cannot be written.

discovery_basic_poll_settings

discovery_basic_poll_settings

The discovery basic poll settings for this range.

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,
'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).

discovery_blackout_setting

discovery_blackout_setting

The discovery blackout setting for this range.

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).

discovery_member

discovery_member

The member that will run discovery for this range.

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).

enable_discovery

enable_discovery

Determines whether a discovery is enabled or not for this range. When this is set to False, the discovery for this range 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).

enable_immediate_discovery

enable_immediate_discovery

Determines if the discovery for the range 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.

end_addr

end_addr

The IPv6 Address end address of the DHCP IPv6 range.

Type

String.

Create

The field is required if address_type is ADDRESS/BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The end_addr is part of the base object.

endpoint_sources

endpoint_sources

The endpoints that provides data for the DHCP IPv6 Range object.

Type

A/An ciscoise:endpoint object array.

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.

exclude

exclude

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 struct array.

Create

The default value is:

empty

Search

The field is not available for search.

extattrs

extattrs

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.

ipv6_end_prefix

ipv6_end_prefix

The IPv6 Address end prefix of the DHCP IPv6 range.

Type

String.

Create

The field is required if address_type is PREFIX/BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

ipv6_prefix_bits

ipv6_prefix_bits

Prefix bits of the DHCP IPv6 range.

Type

Unsigned integer.

Create

The field is required if address_type is PREFIX/BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)

ipv6_start_prefix

ipv6_start_prefix

The IPv6 Address starting prefix of the DHCP IPv6 range.

Type

String.

Create

The field is required if address_type is PREFIX/BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

member

member

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 :ref: Dhcp Member structure<struct:dhcpmember> 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

  • ‘=’ (exact equality)

name

name

This field contains the name of the Microsoft scope.

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

network

network

The network this range belongs to, in IPv6 Address/CIDR format.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The network is part of the base object.

network_view

network_view

The name of the network view in which this range resides.

Type

String.

Create

The default value is The default network view.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view is part of the base object.

port_control_blackout_setting

port_control_blackout_setting

The port control blackout setting for this range.

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).

recycle_leases

recycle_leases

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).

restart_if_needed

restart_if_needed

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.

same_port_control_discovery_blackout

same_port_control_discovery_blackout

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).

server_association_type

server_association_type

The type of server that is going to serve the range. Valid values are:

  • MEMBER
  • NONE

Type

String.

Create

The default value is NONE.

Search

The field is available for search via

  • ‘=’ (exact equality)

start_addr

start_addr

The IPv6 Address starting address of the DHCP IPv6 range.

Type

String.

Create

The field is required if address_type is ADDRESS/BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The start_addr is part of the base object.

subscribe_settings

subscribe_settings

The DHCP IPv6 Range 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).

template

template

If set on creation, the range will be created according to the values specified in the named template.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

The template cannot be updated.

template is not readable.

use_blackout_setting

use_blackout_setting

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_discovery_basic_polling_settings

use_discovery_basic_polling_settings

Use flag for: discovery_basic_poll_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_enable_discovery

use_enable_discovery

Use flag for: discovery_member , enable_discovery

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_recycle_leases

use_recycle_leases

Use flag for: recycle_leases

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_subscribe_settings

use_subscribe_settings

Use flag for: subscribe_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Function Calls

next_available_ip

This function retrieves the next available IP in the range.

This function supports multiple object matches when called as part of an atomic insertion operation.

Input fields

exclude ( String array. ) A list of IP addresses to exclude.

num ( Unsigned integer. ) The number of IP addresses you are requesting.

Output fields

ips ( String array. ) The requested IP addresses.

Fields List

Field Type Req R/O Base Search
address_type String N N N =
cloud_info struct N N N N/A
comment String N N Y : = ~
disable Bool 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_member String N N N N/A
enable_discovery Bool N N N N/A
enable_immediate_discovery Bool N N N N/A
end_addr String Y* N Y = ~
endpoint_sources [obj] N Y N N/A
exclude [struct] N N N N/A
extattrs Extattr N N N ext
ipv6_end_prefix String Y* N N = ~
ipv6_prefix_bits Unsigned int Y* N N =
ipv6_start_prefix String Y* N N = ~
member struct N N N =
name String N N N = ~
network String Y N Y = ~
network_view String N N Y =
port_control_blackout_setting struct N N N N/A
recycle_leases Bool N N N N/A
restart_if_needed Bool N N N N/A
same_port_control_discovery_blackout Bool N N N N/A
server_association_type String N N N =
start_addr String Y* N Y = ~
subscribe_settings struct N N N N/A
template String N N N N/A
use_blackout_setting Bool N N N N/A
use_discovery_basic_polling_settings Bool N N N N/A
use_enable_discovery Bool N N N N/A
use_recycle_leases Bool N N N N/A
use_subscribe_settings Bool N N N N/A

* Required in some cases, see detailed field description above.