ipv6fixedaddresstemplate : The IPv6 fixed address template object.

The IPv6 fixed address template used to create IPv6 fixed address objects in a quick and consistent way. An IPv6 fixed address object created from an IPv6 fixed address template will inherit most properties defined in the IPv6 fixed address template object; therefor, most of the IPv6 fixed address template properties are the same as the fixed address object properties.

Object Reference

References to ipv6fixedaddresstemplate are object references.

The name part of an IPv6 DHCP Fixed Address template object reference has the following components:

  • Name of the IPv6 fixed address template

Example: ipv6fixedaddresstemplate/ZG5zLmJpbmRfY25h:template_name

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.

The following fields are required to create this object:

Field Notes
name  

comment

comment

A descriptive comment of an IPv6 fixed address template object.

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.

domain_name

domain_name

Domain name of the IPv6 fixed address template 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).

domain_name_servers

domain_name_servers

The IPv6 addresses of DNS recursive name servers to which the DHCP client can send name resolution requests. The DHCP server includes this information in the DNS Recursive Name Server option in Advertise, Rebind, Information-Request, and Reply messages.

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

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.

name

name

Name of an IPv6 fixed address template object.

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 IPv6 addresses for this fixed address.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

offset

offset

The start address offset for this IPv6 fixed address.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

options

options

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

preferred_lifetime

preferred_lifetime

The preferred lifetime value for this DHCP IPv6 fixed address template 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).

use_domain_name

use_domain_name

Use flag for: domain_name

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_domain_name_servers

use_domain_name_servers

Use flag for: domain_name_servers

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_options

use_options

Use flag for: options

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_preferred_lifetime

use_preferred_lifetime

Use flag for: preferred_lifetime

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_valid_lifetime

use_valid_lifetime

Use flag for: valid_lifetime

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

valid_lifetime

valid_lifetime

The valid lifetime value for this DHCP IPv6 fixed address template 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).

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
domain_name String N N N N/A
domain_name_servers [String] N N N N/A
extattrs Extattr N N N ext
name String Y N Y : = ~
number_of_addresses Unsigned int N N N N/A
offset Unsigned int N N N N/A
options [struct] N N N N/A
preferred_lifetime Unsigned int 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_options Bool N N N N/A
use_preferred_lifetime Bool N N N N/A
use_valid_lifetime Bool N N N N/A
valid_lifetime Unsigned int N N N N/A