ipv6rangetemplate : IPv6 DHCP Range template object.

The IPv6 range template used to create an IPv6 range object in a quick and consistent way. The DHCP IPv6 range created from the DHCP IPv6 range template will inherit the properties defined in this template.

Object Reference

References to ipv6rangetemplate are object references.

The name part of the IPv6 DHCP Range template object reference has the following components:

  • Name of the IPv6 DHCP Range template.

Example: ipv6rangetemplate/ZG5zLmJpbmRfY25h:templatename

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

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, name, number_of_addresses, offset.

The following fields are required to create this object:

Field Notes
name  
number_of_addresses  
offset  

cloud_api_compatible

cloud_api_compatible

Determines whether the IPv6 DHCP range 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

comment

The IPv6 DHCP range template descriptive comment.

Type

String.

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.

delegated_member

delegated_member

The vConnector member that the object should be delegated to when created from the IPv6 DHCP range template. I assume that vConnector refers to VMware vConnector.

Type

A/An Grid member serving DHCP struct.

Create

The default value is empty.

Search

The field is not available for search.

exclude

exclude

These are ranges of IPv6 addresses that the appliance does not use to assign to clients. You can use these excluded addresses as static IPv6 addresses. They contain the start and end addresses of the excluded range, and optionally, information about this excluded range.

Type

A/An Exclusion range template struct array.

Create

The default value is:

empty

Search

The field is not available for search.

member

member

The member that will provide service for the IPv6 DHCP range.

Set server_association_type to ‘MEMBER’ if you want the server specified here to serve the range. For searching by this field, use an HTTP method that contains a body (POST or PUT) with MS DHCP server structure 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

Name of the IPv6 DHCP range 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

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

Notes

The name is part of the base object.

number_of_addresses

number_of_addresses

The number of addresses for the IPv6 DHCP range.

Type

Unsigned integer.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The number_of_addresses is part of the base object.

offset

offset

The start address offset for the IPv6 DHCP range.

Type

Unsigned integer.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The offset is part of the base object.

recycle_leases

recycle_leases

Determines whether the leases are kept in Recycle Bin until one week after expiry. If this is set to False, 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).

server_association_type

server_association_type

The type of server that is going to serve the IPv6 DHCP range.

Type

String.

Valid values are:
  • FAILOVER
  • MEMBER
  • MS_FAILOVER
  • MS_SERVER
  • NONE

Create

The default value is NONE.

Search

The field is available for search via

  • ‘=’ (exact equality)

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.

Fields List

Field Type Req R/O Base Search
cloud_api_compatible Bool N N N N/A
comment String N N Y : = ~
delegated_member struct N N N N/A
exclude [struct] N N N N/A
member struct N N N =
name String Y N Y : = ~
number_of_addresses Unsigned int Y N Y N/A
offset Unsigned int Y N Y N/A
recycle_leases Bool N N N N/A
server_association_type String N N N =
use_recycle_leases Bool N N N N/A