NSX-T Data Center REST API

LbUdpMonitor (type) (Deprecated)

{
  "additionalProperties": false,
  "deprecated": true,
  "extends": {
    "$ref": "LbActiveMonitor"
  },
  "id": "LbUdpMonitor",
  "module_id": "LoadBalancer",
  "polymorphic-type-descriptor": {
    "type-identifier": "LbUdpMonitor"
  },
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of resource creation",
      "readonly": true
    },
    "_create_user": {
      "description": "ID of the user who created this resource",
      "readonly": true,
      "type": "string"
    },
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of last modification",
      "readonly": true
    },
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource",
      "readonly": true,
      "type": "string"
    },
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_protection": {
      "description": "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.",
      "readonly": true,
      "title": "Indicates protection status of this resource",
      "type": "string"
    },
    "_revision": {
      "computed": true,
      "description": "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.",
      "title": "Generation of this resource config",
      "type": "int"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "_system_owned": {
      "description": "Indicates system owned resource",
      "readonly": true,
      "type": "boolean"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "computed": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "fall_count": {
      "default": 3,
      "maximum": 2147483647,
      "minimum": 1,
      "required": false,
      "title": "num of consecutive checks must fail before marking it down",
      "type": "integer"
    },
    "id": {
      "can_sort": true,
      "title": "Unique identifier of this resource",
      "type": "string"
    },
    "interval": {
      "default": 5,
      "maximum": 2147483647,
      "minimum": 1,
      "required": false,
      "title": "the frequency at which the system issues the monitor check (in second)",
      "type": "integer"
    },
    "monitor_port": {
      "$ref": "PortElement",
      "description": "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.",
      "required": false,
      "title": "port which is used for healthcheck"
    },
    "receive": {
      "description": "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.",
      "required": true,
      "title": "expected data received from server",
      "type": "string"
    },
    "resource_type": {
      "$ref": "MonitorType",
      "required": true
    },
    "rise_count": {
      "default": 3,
      "maximum": 2147483647,
      "minimum": 1,
      "required": false,
      "title": "num of consecutive checks must pass before marking it up",
      "type": "integer"
    },
    "send": {
      "description": "The data to be sent to the monitored server.",
      "required": true,
      "title": "data to send",
      "type": "string"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    },
    "timeout": {
      "default": 15,
      "maximum": 2147483647,
      "minimum": 1,
      "required": false,
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n",
      "type": "integer"
    }
  },
  "type": "object"
}