The DTC SIP monitor object is used to determine the health of a SIP server such as SIP Proxies and Session Border Controllers, and SIP gateways by issuing SIP options to a server and examining the response provided by the server. The service is considered available If the received response matches the expected response.
References to dtc:monitor:sip are object references. The name part of a DTC SIP monitor object reference has the following components:
- Name of DTC SIP monitor
Example: dtc:monitor:sip/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCSip1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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 |
An optional cipher list for secure TLS/SIPS connection.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
An optional client certificate, supplied in TLS and SIPS mode if present.
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.
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 empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
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.
The interval for TCP health check.
Type
Unsigned integer.
Create
The default value is 5.
Search
The field is not available for search.
The display name for this DTC monitor.
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
Notes
The name is part of the base object.
The port value for SIP requests.
Type
Unsigned integer.
Create
The default value is 5060.
Search
The field is not available for search.
A SIP request to send
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The type of an expected result.
Type
String.
Create
The default value is CODE_IS.
Search
The field is not available for search.
The expected return code value.
Type
Unsigned integer.
Create
The default value is 200.
Search
The field is not available for search.
The value 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 1.
Search
The field is not available for search.
The value of how 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 1.
Search
The field is not available for search.
The timeout for TCP health check in seconds.
Type
Unsigned integer.
Create
The default value is 15.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| ciphers | String | N | N | N | N/A |
| client_cert | String | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| interval | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| port | Unsigned int | N | N | N | N/A |
| request | String | N | N | N | N/A |
| result | String | N | N | N | N/A |
| result_code | 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 |
| transport | String | N | N | N | N/A |
| validate_cert | Bool | N | N | N | N/A |
dtc:monitor:pdp : DTC PDP monitor object.
