dtc:topology:rule : DTC Topology Rule object.

Topology rules map client IPs to pools or resources. They require the Topology DB and named labels refer to it. Can be created only as part of topology.

Object Reference

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

  • Name of DTC Topology to which this rule belongs
  • Name of destination DTC Server or Pool

Example: dtc:topology:rule/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCTopology1/Server1

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Global search (searches via the search object)
  • 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 following fields are required to create this object:

Field Notes
dest_type  
destination_link  

dest_type

dest_type

The type of the destination for this DTC Topology rule.

Type

String.

Valid values are:
  • POOL
  • SERVER

Create

The field is required on creation.

Search

The field is not available for search.

sources

sources

The conditions for matching sources. Should be empty to set rule as default destination.

Type

A/An DTC topology rule source struct array.

Create

The default value is undefined.

Search

The field is not available for search.

topology

topology

The DTC Topology the rule belongs to.

Type

String.

This field supports nested return fields as described here.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The topology cannot be updated.

topology cannot be written.

valid

valid

True if the label in the rule exists in the current Topology DB. Always true for SUBNET rules. Rules with non-existent labels may be configured but will never match.

Type

Bool.

Search

The field is not available for search.

Notes

The valid cannot be updated.

valid cannot be written.

Fields List

Field Type Req R/O Base Search
dest_type String Y N N N/A
destination_link String Y N N N/A
sources [struct] N N N N/A
topology String N Y N =
valid Bool N Y N N/A