dtc:pool : DTC Pool object.

The collection of IDNS resources (virtual servers).

Object Reference

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

  • Name of DTC Pool

Example: dtc:pool/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCPool1

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_dynamic_ratio_preferred See the field description for more information
lb_preferred_method  
name  
servers See the field description for more information

availability

availability

A resource in the pool is available if ANY, at least QUORUM, or ALL monitors for the pool say that it is up.

Type

String.

Valid values are:
  • ALL
  • ANY
  • QUORUM

Create

The default value is ALL.

Search

The field is not available for search.

comment

comment

The comment for the DTC Pool; 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.

consolidated_monitors

consolidated_monitors

List of monitors and associated members statuses of which are shared across members and consolidated in server availability determination.

Type

A/An Consolidated monitor health structure struct array.

Create

The default value is:

empty

Search

The field is not available for search.

disable

disable

Determines whether the DTC Pool 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 health status.

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_alternate_method

lb_alternate_method

The alternate load balancing method. Use this to select a method type from the pool if the preferred method does not return any results.

Type

String.

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

Create

The default value is undefined.

Search

The field is not available for search.

lb_alternate_topology

lb_alternate_topology

The alternate topology for load balancing.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

lb_dynamic_ratio_alternate

lb_dynamic_ratio_alternate

The DTC Pool settings for dynamic ratio when it’s selected as alternate method.

Type

A/An Dynamic Ratio Setting for DTC Pool struct.

Create

The default value is:

  { 'invert_monitor_metric': False,
'method': 'MONITOR',
'monitor_weighing': 'RATIO'}

Search

The field is not available for search.

lb_dynamic_ratio_preferred

lb_dynamic_ratio_preferred

The DTC Pool settings for dynamic ratio when it’s selected as preferred method.

Type

A/An Dynamic Ratio Setting for DTC Pool struct.

Create

The field is required only when lb_preferred_method is set to DYNAMIC_RATIO.

Search

The field is not available for search.

lb_preferred_method

lb_preferred_method

The preferred load balancing method. Use this to select a method type from the pool.

Type

String.

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

Create

The field is required on creation.

Search

The field is not available for search.

lb_preferred_topology

lb_preferred_topology

The preferred topology for load balancing.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

monitors

monitors

The monitors related to pool.

Type

An array of the following objects: dtc:monitor:http, dtc:monitor:icmp, dtc:monitor:tcp, dtc:monitor:pdp, dtc:monitor:sip, dtc:monitor:snmp.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

name

name

The DTC Pool display name.

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.

quorum

quorum

For availability mode QUORUM, at least this many monitors must report the resource as up for it to be available

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

servers

servers

The servers related to the pool.

Type

A/An DTC Server 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.

ttl

ttl

The Time To Live (TTL) value for the DTC Pool. 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).

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.

status_member

status_member

The name of the status member to search for.

Type

String.

Search

The field is available for search via

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

Notes

status_member is a search-only field.

Fields List

Field Type Req R/O Base Search
availability String N N N N/A
comment String N N Y : = ~
consolidated_monitors [struct] N N N N/A
disable Bool N N N N/A
extattrs Extattr N N N ext
health struct N Y N N/A
lb_alternate_method String N N N N/A
lb_alternate_topology String N N N N/A
lb_dynamic_ratio_alternate struct N N N N/A
lb_dynamic_ratio_preferred struct Y* N N N/A
lb_preferred_method String Y N N N/A
lb_preferred_topology String N N N N/A
monitors obj N N N N/A
name String Y N Y : = ~
quorum Unsigned int N N N N/A
servers [struct] N N N N/A
ttl Unsigned int 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
status_member String : = ~