NSX-T Data Center REST API

AgentStatus (type)

{
  "id": "AgentStatus",
  "module_id": "Heatmap",
  "properties": {
    "components": {
      "description": "List of agent subcomponent statuses",
      "items": {
        "$ref": "AgentSubStatus"
      },
      "title": "agent subcomponent statuses",
      "type": "array"
    },
    "health_metrics": {
      "description": "Periodically collected critical health metrics.",
      "items": {
        "$ref": "ComponentHealthMetric"
      },
      "title": "Health metrics of components",
      "type": "array"
    },
    "last_status_changed_time": {
      "$ref": "EpochMsTimestamp",
      "title": "Timestamp of the last status change, in epoch milliseconds"
    },
    "name": {
      "enum": [
        "NSX_AGENT",
        "NSX_OPSAGENT",
        "NSX_CFGAGENT",
        "NSX_NESTDB",
        "NSX_EXPORTER",
        "NSX_VDPI",
        "NSX_VDL2",
        "NSX_SWSEC",
        "NSX_OBSRV",
        "NSX_KCP",
        "NSX_FC",
        "NSX_VSWITCH",
        "NSX_VDR",
        "NSX_ENS",
        "NSX_PROXY",
        "NSX_PLATFORM_CLIENT",
        "NSX_SHA"
      ],
      "title": "Agent name",
      "type": "string"
    },
    "resource_usage": {
      "$ref": "AgentResource",
      "description": "Periodically collected critical resource usage including memory usage.",
      "title": "Resource usage of this agent"
    },
    "status": {
      "enum": [
        "UP",
        "DOWN",
        "UNKNOWN",
        "DEGRADED"
      ],
      "title": "Agent status",
      "type": "string"
    },
    "status_description": {
      "description": "Describe what makes the status not UP",
      "title": "Status description",
      "type": "string"
    }
  },
  "type": "object"
}