dtc:topology : DTC Topology object.

A topology is a named list of ordered topology rules. Topology rules map client IPs to pools or resources. They require the Topology DB and named labels refer to it.

Object Reference

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

  • Name of DTC Topology

Example: dtc:topology/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCTopology1

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
name  

comment

comment

The comment for the DTC TOPOLOGY monitor object; 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.

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

Display name of the DTC Topology.

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.

rules

rules

Topology rules.

Type

A/An dtc:topology:rule 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.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
extattrs Extattr N N N ext
name String Y N Y : = ~
rules [obj] N N N N/A