dtc:lbdn : DTC LBDN object.

Load Balanced Domain Name (LBDN) is a Load balanced domain name record type, which is served by Infoblox Name Servers. LBDN is a qualified domain name associated with a specific service such as ftp.abc.com or www.abc.com.

Object Reference

References to dtc:lbdn are object references. The name part of a DTC LBDN object reference has the following components:

  • Name of DTC LBDN

Example: dtc:lbdn/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCLBDN1

Restrictions

The object does not support the following operations:

  • 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
lb_method  
name  
pools See the field description for more information
topology See the field description for more information

auth_zones

auth_zones

List of linked auth zones.

Type

A/An zone_auth object array.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

comment

comment

Comment for the DTC LBDN; 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 the DTC LBDN is disabled or not. When this is set to False, the fixed address is enabled.

Type

Bool.

Create

The default value is False.

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.

health

health

The LBDN health information.

Type

A/An Health information struct.

Search

The field is not available for search.

Notes

The health cannot be updated.

health cannot be written.

lb_method

lb_method

The load balancing method. Used to select pool.

Type

String.

Valid values are:
  • GLOBAL_AVAILABILITY
  • RATIO
  • ROUND_ROBIN
  • TOPOLOGY

Create

The field is required on creation.

Search

The field is not available for search.

name

name

The display name of the DTC LBDN, not DNS related.

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.

patterns

patterns

LBDN wildcards for pattern match.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

persistence

persistence

Maximum time, in seconds, for which client specific LBDN responses will be cached. Zero specifies no caching.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

pools

pools

The maximum time, in seconds, for which client specific LBDN responses will be cached. Zero specifies no caching.

Type

A/An DTC Pool link struct array.

Create

The field is required only when lb_method is set to other than TOPOLOGY.

Search

The field is not available for search.

priority

priority

The LBDN pattern match priority for “overlapping” DTC LBDN objects. LBDNs are “overlapping” if they are simultaneously assigned to a zone and have patterns that can match the same FQDN. The matching LBDN with highest priority (lowest ordinal) will be used.

Type

Unsigned integer.

Create

The default value is 1.

Search

The field is not available for search.

topology

topology

The topology rules for TOPOLOGY method.

Type

String.

This field supports nested return fields as described here.

Create

The field is required only when lb_method is set to TOPOLOGY.

Search

The field is not available for search.

ttl

ttl

The Time To Live (TTL) value for the DTC LBDN. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

ttl is associated with the field use_ttl (see use flag).

types

types

The list of resource record types supported by LBDN.

Type

Enum values array.

Valid values are:
  • A
  • AAAA
  • CNAME
  • NAPTR
  • SRV

Create

The default value is [‘A’, ‘AAAA’].

Search

The field is not available for search.

use_ttl

use_ttl

Use flag for: ttl

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

fqdn

fqdn

The FQDN of the DTC LBDN.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

fqdn is a search-only field.

status_member

status_member

The grid member name to search for.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

status_member is a search-only field.

Fields List

Field Type Req R/O Base Search
auth_zones [obj] N N N N/A
comment String N N Y : = ~
disable Bool N N N N/A
extattrs Extattr N N N ext
health struct N Y N N/A
lb_method String Y N N N/A
name String Y N Y : = ~
patterns [String] N N N N/A
persistence Unsigned int N N N N/A
pools [struct] Y* N N N/A
priority Unsigned int N N N N/A
topology String Y* N N N/A
ttl Unsigned int N N N N/A
types [Enum] N N N N/A
use_ttl Bool N N N N/A

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

Search-only Fields List

Field Type Search
fqdn String =
status_member String =