NSX-T Data Center REST API
LbUdpMonitor (schema) (Deprecated)
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| fall_count | num of consecutive checks must fail before marking it down | integer | Minimum: 1 Maximum: 2147483647 Default: "3" |
| id | Unique identifier of this resource | string | Sortable |
| interval | the frequency at which the system issues the monitor check (in second) | integer | Minimum: 1 Maximum: 2147483647 Default: "5" |
| monitor_port | port which is used for healthcheck If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. For ICMP monitor, monitor_port is not required. |
PortElement | |
| receive | expected data received from server Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period. |
string | Required |
| resource_type | Must be set to the value LbUdpMonitor | MonitorType | Required |
| rise_count | num of consecutive checks must pass before marking it up | integer | Minimum: 1 Maximum: 2147483647 Default: "3" |
| send | data to send The data to be sent to the monitored server. |
string | Required |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| timeout | the number of seconds the target has in which to respond to the monitor request | integer | Minimum: 1 Maximum: 2147483647 Default: "15" |