The DTC SNMP Health Monitor determines the health of SNMP servers, such as SNMP Proxies and Session Border Controllers, and SNMP gateways by issuing SNMP options to a server and examining the response sent by the server. The service is considered available if the returned response matches the expected response.
References to dtc:monitor:snmp are object references. The name part of a DTC SNMP monitor object reference has the following components:
- Name of DTC SNMP monitor
Example: dtc:monitor:snmp/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCSnmp1
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 |
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.
The SNMP community string for SNMP authentication.
Type
String.
Create
The default value is public.
Search
The field is not available for search.
The SNMPv3 context.
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
The SNMPv3 engine identifier.
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
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.
A list of OIDs for SNMP monitoring.
Type
A/An DTC SNMP Monitor OID struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The port value for SNMP requests.
Type
Unsigned integer.
Create
The default value is 161.
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 |
|---|---|---|---|---|---|
| comment | String | N | N | Y | : = ~ |
| community | String | N | N | N | N/A |
| context | String | N | N | N | : = ~ |
| engine_id | String | N | N | N | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| interval | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| oids | [struct] | N | N | N | N/A |
| 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 |
| user | String | N | N | N | N/A |
| version | String | N | N | N | N/A |
dtc:monitor:sip : DTC SIP monitor object.