NSX-T Data Center REST API

ManualHealthCheck (type)

{
  "description": "Describes a manual check to evaluate the VLAN MTU status of either a transport zone or the hosts in a vCenter cluster.",
  "extends": {
    "$ref": "ManagedResource"
  },
  "id": "ManualHealthCheck",
  "module_id": "HealthCheck",
  "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"
    },
    "cluster_scope_filter": {
      "$ref": "HealthCheckClusterScopeFilter",
      "description": "The transport node scope is determined by the combination of specified vCenter cluster and specified host group (optional). The host switch scope is determined by the specified host switch. This property cannot be set together with the transport_zone_id property",
      "required": false,
      "title": "vCenter cluster scope filter"
    },
    "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"
    },
    "id": {
      "can_sort": true,
      "title": "Unique identifier of this resource",
      "type": "string"
    },
    "operation_status": {
      "description": "The operation status for health check",
      "enum": [
        "IN_PROGRESS",
        "FINISHED",
        "PARTIAL_FINISHED",
        "FAILED"
      ],
      "readonly": true,
      "title": "Operation Status",
      "type": "string"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "type": "string"
    },
    "result": {
      "$ref": "HealthCheckResult",
      "readonly": true
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    },
    "transport_zone_id": {
      "description": "The entity ID works as a filter param. Entity ID and entity type should   be both provided or not at a query.",
      "required": false,
      "title": "Transport Zone ID",
      "type": "string"
    },
    "vlans": {
      "$ref": "HealthCheckSpecVlans",
      "description": "VLANs specificied for manual health check",
      "required": true,
      "title": "Specificied VLANs"
    }
  },
  "title": "Manual Health Check",
  "type": "object"
}