dtc:monitor : DTC monitor object.

The DTC Monitor object is used to determine the health of a server by evaluating the response to a health request.

Object Reference

References to dtc:monitor are object references.

The name part of a DTC monitor object reference has the following components:

• Name of the DTC monitor

Example: dtc:monitor/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCTcp1

Restrictions

The object does not support the following operations:

• Create (insert)
• Delete
• Modify (update)
• Read by object reference
• 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 basic version of the object contains the field(s): comment, name, type.

comment

comment

Comment for this DTC monitor; maximum 256 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

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.

interval

interval

The interval for a health check.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

monitor

monitor

The actual monitor object.

Type

String.

This field supports nested return fields as described here.

Create

The default value is undefined.

Search

The field is not available for search.

name

name

The display name for this DTC monitor.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

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

Notes

The name is part of the base object.

port

port

The health monitor port value.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

retry_down

retry_down

The number of how many times the server should appear as “DOWN” to be treated as dead after it was alive.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

retry_up

retry_up

The number of many times the server should appear as “UP” to be treated as alive after it was dead.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

timeout

timeout

The timeout for a health check.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

type

type

The request transport type.

Type

String.

Valid values are:

• HTTP
• ICMP
• PDP
• SIP
• SNMP
• TCP

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The type is part of the base object.

Fields List

Field	Type	Req	R/O	Base	Search
comment	String	N	N	Y	: = ~
extattrs	Extattr	N	N	N	ext
interval	Unsigned int	N	N	N	N/A
monitor	String	N	N	N	N/A
name	String	N	N	Y	: = ~
port	Unsigned int	N	N	N	N/A
retry_down	Unsigned int	N	N	N	N/A
retry_up	Unsigned int	N	N	N	N/A
timeout	Unsigned int	N	N	N	N/A
type	String	N	N	Y	N/A