top of page
Search

APIs for monitoring multiple VMware products

  • Writer: Mohammed Bilal
    Mohammed Bilal
  • Apr 30, 2022
  • 1 min read

Updated: May 6, 2022


This article helps and allows to monitor the health of the VMware software with API calls and explains how to interpret the response received


Note:

  • I used the Postman tool to use these API calls

  • I have created an environment variable {{vcsa}} for my lab VCSA FQDN

  • To run the below GET APIs against any product authentication token is not needed as it is a simple GET API

  • No request parameters are needed for GET API


vSphere 7.x


  • GET applmgmt service health status

This request returns the VMware Appliance Management Service health status API: 

GET https://{{vcsa}}/rest/appliance/health/applmgmt

Representation:

{
    "value" : "green"
}


  • GET database storage health status

This request returns the VCSA Database Storage health status API: 

GET https://{{vcsa}}/rest/appliance/health/database-storage

Representation:

{
    "value" : "green"
}

  • GET load health status

This request returns the VCSA load health status


API:


GET https://{{vcsa}}/rest/appliance/health/load

Representation:

{
    "value" : "green"
}

  • GET memory health status

This request returns the VCSA memory usage health status


API:

GET https://{{vcsa}}/rest/appliance/health/mem

Representation:

{
    "value" : "green"
}

  • GET storage health status

This request returns the VCSA storage usage health status


API:

GET https://{{vcsa}}/rest/appliance/health/storage

Representation:

{
    "value" : "green"
}

  • GET swap health status

This request returns the VCSA swap usage health status


API:

GET https://{{vcsa}}/rest/appliance/health/swap

Representation:

{
    "value" : "green"
}

  • GET overall system health status

This request returns the VCSA system health status


API:

GET https://{{vcsa}}/rest/appliance/health/system

Representation:

{
    "value" : "green"
}

  • GET the VCSA services status

This request returns the VCSA services status


API:

GET https://{{vcsa}}/rest/appliance/services

Representation:

{
    "value": [
        {
            "value": {
                "description": "ntpd.service",
                "state": "STARTED"
            },
            "key": "ntpd"
        },
        {
            …
        },
        {
            "value": {
                "description": "VMware Observability",
                "state": "STARTED"
            },
            "key": "observability"
        }
    ]
}

  • GET a VCSA service status

This request returns a specific VCSA service status API:

GET https://{{vcsa}}/rest/appliance/services/{service}

Representation:

{
    "value": {
        "description": "ntpd.service",
        "state": "STARTED"
    }
}

{service} - You need to provide a service name You can refer to this VMware KB for the list of vCenter services

vSAN 7. x

  • GET the vCenter Server vSAN Health service status


This request returns a vCenter Server service status

GET https://{{vcsa}}/rest/vcenter/services/vsan-health

SDDC Manager

  • NOTE: We need this token to be used for the next API calls

  • Authentication

This request creates an SDDC Manager token is needed for GET API calls


API: 

POST https://{{sddcmanager}}/v1/tokens

Path Parameters (Params): KEY VALUE

Content-Type application/json

Accept application/json


Body:

{ 		
"username" : "administrator@SSO.domain", 		
"password" : "SSO Password" 	
}

Representation:

{   "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNTFlZWI5Yy1mNWNmLTQ3N2UtYTJhYS0yMzg4ZmFmYzMwNDAiLCJpYXQiOjE1ODIxMzgzMzQsInN1YiI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsImlzcyI6InZjZi1hdXRoIiwiYXVkIjxxxxxxxxxxxxxxxx",   "refreshToken" : {     "id" : "3c6b3c30-3bf2-480b-9539-8483699ab911"   } }

  • NOTE: For the rest of the below GET APIs we would set the below Params under Parameters

Path Parameters (Params): KEY VALUE

Content-Type application/json

Accept application/json

Authorization Bearer Paste the token generated above

  • GET SDDC Manager list

This request returns the SDDC Manager list


API:

GET https://{{sddcmanager}}/v1/sddc-managers

Representation:

{
  "elements" : [ {
    "domain" : {
      "id" : "a282507a-7e2c-4335-98b8-1cc66687d5b5"
    },
    "id" : "bsedfeefz-azeg-6455-zf65-zefzf752zf4z87fz",
    "fqdn" : "xxxx.xxxx.xx",
    "version" : "4.0.1.0-16428904",
    "ipAddress" : "192.168.1.37"
  } ]
}


  • GET SDDC Manager upgradeable status

This request returns the SDDC Manager upgradable status

API:

GET https://{{sddcmanager}}/v1/system/upgradables

Representation:

{
  "elements" : [ {
    "bundleId" : "fd655436-ec3c-4f10-baed-3a3dde5a6bc6",
    "bundleType" : "SDDC_MANAGER",
    "resource" : {
      "resourceId" : "a282507a-7e2c-4335-98b8-1cc66687d5b5",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ {
      "id" : "5d089d1c-71e9-48c7-a3d1-c9e572cd4bd4",
      "type" : "SDDC_MANAGER"
    } ],
    "status" : "AVAILABLE"
  } ]
}


  • GET Domains list

This request returns the Domains list


API:

GET https://{{sddcmanager}}/v1/domains

Representation:

{
  "elements" : [ {
    "id" : "bsedfeefz-azeg-6455-zf65-zefzf752zf4z87fz",
    "name" : "XXXXXXXX",
    "type" : "MANAGEMENT",
    "vcenters" : [{"id" : "zefzf752zf4z87fz"}],
    "clusters" : [{"id" : "bsedfeefz-azeg"}]
  },
  {
    "id" : "bsedfeefz-azeg-6455-zf65-zefzf752zf4z87fz",
    "name" : "XXXXXXXX",
    "type" : "VI",
    "vcenters" : [{"id" : "zefzf752zf4z87fz"}],
    "clusters" : [{"id" : "bsedfeefz-azeg"}]
  }]
}


  • GET Regions list

This request returns the Regions list

API:

GET https://{{sddcmanager}}/v1/avns

Representation:

[
  {
    "id": " bsedfeefz-azeg-6455-zf65-zefzf752zf4z87fz ",
    "name": "avn01",
    "regionType": "REGION_A",
    "subnet": "xx.xxx.xxx.xxx",
    "subnetMask": "xx.xxx.xxx.xxx",
    "gateway": "xx.xxx.xxx.xxx",
    "mtu": "9000",
    "portGroupName": "xxxxx",
    "domainName": "xxxx",
    "routerName": "xxxxxx"
  }
]


  • GET the VCF services list

This request returns the VCF services list

API:

GET https://{{sddcmanager}}/v1/vcf-services

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "name" : "OPERATIONS_MANAGER",
      "type" : "4.0.1-vcf4040RELEASE-16428513"
    },
    {
      …
    }
  ]
}


  • GET the vCenter servers list

This request returns the vCenter servers list

API:

GET https://{{sddcmanager}}/v1/vcenters

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "fqdn" : "xxxxxxxx.xxx.xxx",
      "ipAddress" : "XX.XXX.XXX.XXX",
      "domain" : { "id" : "xxxxxxxxxxxx" }
    },
    {
      …
    }
  ]
}


  • GET the PSCs list

This request returns the Platform Service Controllers list


API:

GET https://{sddcmanager}/v1/pscs

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "fqdn" : "xxxxxxxx.xxx.xxx",
      "ipAddress" : "XX.XXX.XXX.XXX",
      "ssoDomainName" : "xxxxxxxx.xxx.xxx",
      "ssoSubDomainName" : "xxxxxxxx.xxx.xxx",
      "isReplica" : false,
      "domain" : { "id" : "xxxxxxxxxxxx" }
    },
    {
      …
    }
  ]
}


  • GET the SSO Domains list

This request returns the SSO Domains list

GET https://{{sddcmanager}}/v1/sso-domains

Representation:

{
  "elements" : [
    {
      "localos",
      "addomain.com",
      "vsphere.local"
    }
  ]
}


  • GET the vRSLCM servers list

This request returns the vRSLCM servers list

API:

GET https://{{sddcmanager}}/v1/vrslcm

Representation:

{
  "id" : "xxxxxxxxxxxxxxxxxxxx";
  "fqdn" : "xxxxxxxxxxxxxxxxxxxx";
  "ipAddress" : "XX.XXX.XXX.XX";
  "version" : "8.1.0-16256499";
  "status" : "ACTIVE"
}

  • GET the vSphere Clusters list

This request returns the vSphere Clusters list

API:

GET https://{{sddcmanager}}/v1/clusters

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "name" : "xxxxxxxx ",
      "primaryDatastoreName" : "xxxxxx",
      "primaryDatastoreType" : "VSAN",
      "hosts" : [
            {"id" : "xxxxxxxxxxxxxxxxxxxxxx"},
            {"id" : "xxxxxxxxxxxxxxxxxxxxxx"},
            {"id" : "xxxxxxxxxxxxxxxxxxxxxx"}
      ],
      "isStretched" : true
    },
    {
      …
    }
  ]
}

  • GET the virtual Distributed switches of a vSphere Cluster

This request returns the VDS of a vSphere Cluster

API:

GET https://{{sddcmanager}}/v1/clusters/{clusterID}/vdses

ClusterID can be retrieved from the previous topic

Representation:

[
  {
    "id" : "xxxxxxxxxxxxxxxxxxxxxx",
    "name" : "XXXXXXXX",
    "isUsedByNsxt" : true,
    "mtu" : 1500,
    "portgroups" : […],
    "niocBandwithAllocations" : […],
  },
  {
    …
  }
]

  • GET the NSX-T clusters list

This request returns the NSX-T clusters list

API:

GET https://{{sddcmanager}}/v1/clusters/{clusterID}/nsxt-clusters

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "vipFqdn" : "xxxxxxxx",
      "vip" : "xxxxxx",
      "domains" : [
            {
              "id" : "xxxxxxxxxxxxxxxxxxxxxx",
              "name" : "xxxxxxxxxxxxxxxxxxxxxx"
            }
      ],
      "nodes" : [
            {
              "fqdn" : "xxxxxxxxxxxxxxxxxxxxxx",
              "ipAddress" : "xxxxxxxxxxxxxxxxxxxxxx",
              "name" : "xxxxxxxxxxxxxxxxxxxxxx"
            }
      ],
      "isShared" : false,
      "isShareable" : false,
      "isVlcmCompatible" : false
    },
    {
      …
    }
  ]
}

  • GET the Edge cluster list

This request returns the Edge clusters list

API:

GET https://{{sddcmanager}}/v1/clusters/{clusterID}/edge-clusters

Representation:

{
  "elements" : [
    {
      "id" : "xxxxxxxxxxxxxxxxxxxxxx",
      "name" : "xxxxxxxx",
      "clusters" : [
            {
              "id" : "xxxxxxxxxxxxxxxxxxxxxx"
            }
      ],
      "nsxtClusters" : [
            {
              "id" : "xxxxxxxxxxxxxxxxxxxxxx",
              "vipFqdn" : "xxxxxxxxxxxxxxxxxxxxxx",
              "vip" : "xxxxxxxxxxxxxxxxxxxxxx"
            }
      ]
    },
    {
      …
    }
  ]
}

vRSLCM

  • GET all vRSLCM controller's service status

This request returns all vRSLCM controller service status

API:

GET https://{vrslcm_node}/lcm/health/api/status

Representation:

  {
    "bootstrap": "UP",
    "postgres": "UP",
    "blackstone": "UP",
    "vrlcm-server": "UP"
  }

Workspace One

  • GET Workspace One health status

This request returns if the Workspace One is healthy


API:

GET https://{{ws1_node}}/SAAS/API/1.0/REST/system/health

Representation:

{
  "AnalyticsUrl": "http://198.51.100.0"
  "ElasticsearchServiceOk": "true"
  "EhCacheClusterPeers": ""
  "ElasticsearchMasterNode": "198.51.100.1"
  "ElasticsearchIndicesCount": "13"
  "ElasticsearchDocsCount": "11173"
  "AuditPollInterval": "1000"
  "AnalyticsConnectionOk": "true"
  ...
  "IpAddress": "198.51.100.2"
  "AuditDisabled": "false"
  "AllOk": "true"
}

  • GET Workspace One Access service status

This request returns if the Workspace One Access service is healthy

API:

GET https://{{ws1_node}}/SAAS/API/1.0/REST/system/health/heartbeat

Representation:

ok


  • GET Workspace One Catalog Portal service health

This request returns if the Workspace One Catalog Portal service is healthy

API:

GET https://{{ws1_node}}/catalog-portal/services/health

Representation:

{
  "status": "UP",
  "details": {
    "uiService": {"status": "UP"},
    "apiService": {"status": "UP"},
    "eucCacheEngine": {"status": "UP"},
    "cacheEngineClient": {"status": "UP"},
    "diskSpace":{
      "status": "UP",
      "details": {…}
    }
  }
}


  • GET Workspace One Connector health

This request returns if the Workspace One Connector is healthy

API:

GET https://{{ws1_node}}/hc/API/1.0/REST/system/health

Representation:

{
         "HorizonDaaSSyncConfigurationStatus": "",
         "AppManagerServiceOk": "true",
         "DomainJoinEnabled": "false",
         "XenAppEnabled": "true",
         "ViewSyncConfigurationStatus": "",
         "ThinAppServiceOk": "true",
         "ThinAppSyncConfigurationStatus": "unknown",
         "Activated": "true",
         "XenAppServiceOk": "false",
         "DirectoryServiceStatus": "Connection test successful",
          "BuildVersion": "2017.1.1.0 Build 5077496",
         "ThinAppServiceStatus": "unknown",
          "XenAppServiceStatus": "A problem was encountered Sync Integration Broker",
         "HostName": "hostname.company.local",
         "NumberOfWarnAlerts": "0",
         "JoinedDomain": "true",
         "XenAppSyncConfigurationStatus": "Sync configured (manually)",
         "DirectorySyncConfigurationStatus": "Sync configured (manually)",
         "NumberOfErrorAlerts": "0",
         "DirectoryServiceOk": "true",
         "HorizonDaaSTenantOk": "true",
         "ThinAppDirectoryPath": "",
         "StatusDate": "2017-06-27 10:52:59 EDT",
         "ViewSyncEnabled": "false",
         "ViewServiceOk": "true",
         "HorizonDaaSEnabled": "false",
         "AppManagerUrl": "https://workspaceurl.com/SAAS/t/qwe12312qw/",
         "HorizonDaaSServiceStatus": "unknown",
         "DirectoryConnection": "ldap:///ldapcall",
         "ServiceVersion": "VMware-C2-2017.1.1.0 Build 5077496",
         "IpAddress": "169.118.86.105",
         "DomainJoinStatus": "Domain: customerdomainname",
         "AllOk": "false",
         "ViewServiceStatus": "unknown",
         "ThinAppEnabled": "false",
         "XenAppSyncSsoBroker": "integrationbrokersso:443 / integrationbrokersync:443"
}

NSX-T

  • NOTE: We need this token to be used for the next API calls

  • Authentication

This request creates an NSX-T token

API:

POST https://{{nsxt_manager}}/api/session/create

Path Parameters (Params): KEY VALUE

Content-Type application/json

Accept application/json

Body:

{ 		
"username" : "admin", 		
"password" : "Password" 	
}

Representation:

{
  "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNTFlZWI5Yy1mNWNmLTQ3N2UtYTJhYS0yMzg4ZmFmYzMwNDAiLCJpYXQiOjE1ODIxMzgzMzQsInN1YiI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsImlzcyI6InZjZi1hdXRoIiwiYXVkIjxxxxxxxxxxxxxxxx",
  "refreshToken" : {
    "id" : "3c6b3c30-3bf2-480b-9539-8483699ab911"
  }
}

  • NOTE: For the rest of the below GET APIs we would set the below Params under Parameters

Path Parameters (Params): KEY VALUE

Authorization Basic

  • GET NSX-T cluster status

This request returns the NSX-T cluster status

API:

GET https://{{nsx-t_manager}}/api/v1/cluster/status

Representation:

{
  " cluster_id": "42311EA11584645845dazd574",
  "control_cluster_status": {
    "status": "STABLE"
  },
  "mgmt_cluster_status": {
    "online_nodes": [
      {
       "mgmt_cluster_listen_ip_address": "192.168.110.31",
        "uuid": "42311EA1-D13F-C347-A2E4-7821B20F31BE"
      }
    ],
    "status": "STABLE"
  }
}


  • GET NSX-T node services list

This request returns the NSX-T node services list

API:

GET https://{{nsx-t_manager}}/api/v1/node/services

Representation:

{
  "result_count": 5,
  "results": [
    {
        …
        "service_name": "snmp"
    },
    {
        …
        "service_name": "syslog"
    },
    {
        …
    }
  ]
}


  • Get NSX-T manager service status

This request returns the NSX-T manager service status

API:

GET https://{{nsx-t_manager}}/api/v1/node/services/{service}/status

{service} - You need to specify the service whose status you need to check.

Representation:

{
  "_schema": "NodeServiceStatusProperties",
  "_self": {
    "href": "/node/services/liagent/status",
    "rel": "self"
  },
  "pids": [],
  "runtime_state": "stopped"
}


  • GET NSX-T edge config diagnosis

This request returns the NSX-T edge services status

API:

GET https://{{nsx-t_edge}}/api/v1/node/diagnosis

Representation:

{
    "config": {
        "failed": {
            "nestdb": "not running"
        },
        "passed": [
            "nsxa-state",
            "nsxa-edge-cluster",
            "nsxa-lrouter",
           "nsxa-service-router",
            "manager",
            "controller",
            "edge-agent",
            "dataplane",
            "nsd",
            "core"
        ],
        "warning": {
            "nsxa-edge-cluster": "no peers"
        }
    },
    "ha-state": "active"
}


  • GET a high-level summary of a transport node

This request returns the high-level summary of a transport node

GET https://{{nsx-t_manager}}/api/v1/transport-nodes/{id}/pnic-bond-status

Representation:

{ "results": [
    {
      "name": "pnic0",
      "status":"UP",
      "type": "PNIC"
    },
    {
      "name": "pnic1",
      "status":"DOWN",
      "type": "PNIC"
    }
   ]
}


  • GET status of all transport nodes with tunnel connections to a transport node

This request returns the status of all transport nodes with tunnel connections to the transport node

API:

GET https://{{nsx-t_manager}}/api/v1/{id}/remote-transport-node-status

Representation:

{
  "result_count": 1,
  "results": [
    {
      "control_connection_status": {
        "degraded_count": 0,
        "down_count": 0,
        "up_count": 1,
        "status": "UP"
      },
      "tunnel_status": {
        "down_count": 0,
        "up_count": 1,
        "status": "UP",
        "bfd_status": {
          "bfd_admin_down_count": 0,
          "bfd_up_count": 1,
          "bfd_init_count": 0,
          "bfd_down_count": 0
        },
        "bfd_diagnostic": {
         "echo_function_failed_count": 0,
          "no_diagnostic_count": 1,
          "path_down_count": 0,
         "administratively_down_count": 0,
         "control_detection_time_expired_count": 0,
         "forwarding_plane_reset_count": 0,
         "reverse_concatenated_path_down_count": 0,
         "neighbor_signaled_session_down_count": 0,
         "concatenated_path_down_count": 0
        }
      },
      "pnic_status": {
        "degraded_count": 0,
        "down_count": 0,
        "up_count": 2,
        "status": "UP"
      },
      "threat_status": {
        "status": "NORMAL"
      },
      "agent_status": {
        "status": "UP",
        "up_count: 2
        "down_count": 0,
        "agents": [ {
            "name": "NSX_AGENT",
            "stauts": "UP"
         },
         {
            "name": "NSX_NESTDB",
            "stauts": "UP"
         }
        ]
      },
      "node_status": {
          "last_heartbeat_timestamp": 1446675283540,
          "lcp_connectivity_status": "UP",
          "mpa_connectivity_status": "UP",
          "system_status": {
            "mem_used": 2551264,
            "system_time": 1446649452000,
            "file_systems": [
              {
                "file_system": "root",
                "total": 32768,
                "used": 476,
                "type": "ramdisk",
                "mount": "/"
              },
              {
                "file_system": "etc",
                "total": 28672,
                "used": 220,
                "type": "ramdisk",
                "mount": "/etc"
              },
              {
                "file_system": "opt",
                "total": 32768,
                "used": 1040,
                "type": "ramdisk",
                "mount": "/opt"
              },
              {
                "file_system": "var",
                "total": 49152,
                "used": 1196,
                "type": "ramdisk",
                "mount": "/var"
              },
              {
                "file_system": "tmp",
                "total": 262144,
                "used": 24136,
                "type": "ramdisk",
                "mount": "/tmp"
              },
              {
                "file_system": "hostdstats",
                "total": 302080,
                "used": 2072,
                "type": "ramdisk",
                "mount": "/var/lib/vmware/hostd/stats"
              }
            ],
            "load_average": [
              0.17000000178813934,
              0.17000000178813934,
              0.15000000596046448
            ],
            "swap_total": 0,
            "mem_cache": 0,
            "cpu_cores": 16,
            "source": "cached",
            "mem_total": 25119208,
            "swap_used": 0,
            "uptime": 7213000
          },
          "last_sync_time": 1473837914408,
         "mpa_connectivity_status_details": "Client is responding to heartbeats",
          "software_version": "1.1.0.0.0.3195008",
         "host_node_deployment_status": "INSTALL_SUCCESSFUL",
          "lcp_connectivity_status_details": [
            {
              "control_node_ip": "192.168.110.34",
              "failure_status": "UNKNOWN_FAILURE_STATUS",
              "status": "UP"
            }
          ],
          "inventory_sync_paused": false
        },
      "mgmt_connection_status": "UP",
      "node_uuid": "e8d0d75c-4f39-11e7-b9d7-5d1bfa96a140",
      "status": "UP"
    }
  ]
}


  • GET status of a transport node

This request returns the status of a transport node

API:

GET https://{{nsx-t_manager}}/api/v1/transport-nodes/{id}/status

Representation:


{
  "control_connection_status" : {
   "degraded_count" : 0,
   "down_count" : 0,
   "up_count" : 1,
   "status" : "UP"
  },
  "tunnel_status" : {
    "down_count" : 0,
    "up_count" : 0,
    "status" : "DOWN",
    "bfd_status" : {
      "bfd_admin_down_count" : 0,
      "bfd_up_count" : 0,
      "bfd_init_count" : 0,
      "bfd_down_count" : 0
    },
    "bfd_diagnostic" : {
     "echo_function_failed_count" : 0,
     "no_diagnostic_count" : 0,
     "path_down_count" : 0,
     "administratively_down_count" : 0,
    "control_detection_time_expired_count" : 0,
     "forwarding_plane_reset_count" : 0,
    "reverse_concatenated_path_down_count" : 0,
    "neighbor_signaled_session_down_count" : 0,
     "concatenated_path_down_count" : 0
    }
  },
  "pnic_status" : {
    "degraded_count" : 0,
    "down_count" : 0,
    "up_count" : 2,
    "status" : "UP"
  },
  "threat_status": {
     "status": "NORMAL"
  },
  "agent_status": {
    "status": "UP",
    "up_count: 2
    "down_count": 0,
    "agents": [ {
        "name": "NSX_AGENT",
        "stauts": "UP"
     },
     {
        "name": "NSX_NESTDB",
        "stauts": "UP"
     }
    ]
  },
   "node_status": {
          "last_heartbeat_timestamp": 1446675283540,
          "lcp_connectivity_status": "UP",
          "mpa_connectivity_status": "UP",
          "system_status": {
            "mem_used": 2551264,
            "system_time": 1446649452000,
            "file_systems": [
              {
                "file_system": "root",
                "total": 32768,
                "used": 476,
                "type": "ramdisk",
                "mount": "/"
              },
              {
                "file_system": "etc",
                "total": 28672,
                "used": 220,
                "type": "ramdisk",
                "mount": "/etc"
              },
              {
                "file_system": "opt",
                "total": 32768,
                "used": 1040,
                "type": "ramdisk",
                "mount": "/opt"
              },
              {
                "file_system": "var",
                "total": 49152,
                "used": 1196,
                "type": "ramdisk",
                "mount": "/var"
              },
              {
                "file_system": "tmp",
                "total": 262144,
                "used": 24136,
                "type": "ramdisk",
                "mount": "/tmp"
              },
              {
                "file_system": "hostdstats",
                "total": 302080,
                "used": 2072,
                "type": "ramdisk",
                "mount": "/var/lib/vmware/hostd/stats"
              }
            ],
            "load_average": [
              0.17000000178813934,
              0.17000000178813934,
              0.15000000596046448
            ],
            "swap_total": 0,
            "mem_cache": 0,
            "cpu_cores": 16,
            "source": "cached",
            "mem_total": 25119208,
            "swap_used": 0,
            "uptime": 7213000
          },
          "last_sync_time": 1473837914408,
         "mpa_connectivity_status_details": "Client is responding to heartbeats",
          "software_version": "1.1.0.0.0.3195008",
         "host_node_deployment_status": "INSTALL_SUCCESSFUL",
         "lcp_connectivity_status_details": [
            {
              "control_node_ip": "192.168.110.34",
              "failure_status": "UNKNOWN_FAILURE_STATUS",
              "status": "UP"
            }
          ],
          "inventory_sync_paused": false
        },
  "mgmt_connection_status" : "UP",
  "node_uuid" : "07cd4582-189c-11e7-b77f-7f1dfdccba5e",
  "status" : "DOWN"
}

vRNI

  • GET the id of the vRNI node

This request returns the id of the vRNI node


API:

GET https://{{vrniplatform}}/api/ni/infra/nodes

Representation:

{
    "results": [
        {
            "id": "18230:901:1585583463",
            "entity_type": "NODE"
        },
        {
            "id": "18230:901:1706494033",
            "entity_type": "NODE"
        },

    ],
    "total_count": 2
}


  • GET the vRNI node details

This request returns the vRNI node details

API:

GET https://{vrniplatform}/api/ni/infra/nodes/{id}

{id} - ID captured in the previous step

Representation:

{
    "id": "18230:901:1585583463",
    "entity_type": "NODE",
    "node_type": "PROXY_VM",
    "node_id": "IOYHU2J",
    "ip_address": "10.126.103.156"
}

vRLI

  • NOTE: We need this token to be used for the next API calls

  • Authentication

This request creates a vRLI token


API: 

POST https://{vrli_vip_or_node}/api/v1/sessions

Path Parameters (Params): KEY VALUE

Content-Type application/json

Accept application/json

Body:

{
    "username": "username / username@domain / username",
    "password": "password",
    "provider": "Local / vIDM / ActiveDirectory"
}

Representation:

{
  "userId": "cc251b9f-b4d0-437d-86de-8ac560d45e55",
  "sessionId": "80Lmue52xwIgDiQMu7as9jLdLFFs+Hn3HI2WP0fx6kH0ApL",
  "ttl": 1800
}

  • NOTE: For the rest of the below GET APIs we would set the below Params under Parameters

Path Parameters (Params): KEY VALUE

Authorization Bearer Paste the token generated above


  • GET VIP and nodes status

This request returns the vRLI VIP and nodes status

API:

GET https://{vrli_vip_or_node}/api/v1/cluster/vips

Representation:

{
  "vips": [
    {
      "uuid": "10.11.12.13",
      "ipAddress": "10.11.12.13",
      "fqdn": "test1.example.com",
      "tags": {
        "k1": "v1",
        "k2": "v2"
       },
      "status": "AVAILABLE"
    },
    {
      "uuid": "10.11.12.14",
      "ipAddress": "10.11.12.14",
      "fqdn": "",
      "tags": {
        "k3": "v3"
       },
      "status": "UNAVAILABLE"
    },
    {
      "uuid": "10.11.12.15",
      "ipAddress": "10.11.12.15",
      "fqdn": "test3.example.com",
      "tags": "key3=val3",
      "tags": {
         "k4": "v4",
         "k5": "v5"
       },
      "status": "UNKNOWN"
    }
  ]
}


vROPS

  • GET node status

This request returns the vROPS node status

API:

GET https://{{vropsnode}}/suite-api/api/deployment/node/status

Representation:

{
  "status" : "ONLINE",
  "systemTime" : 0
}


  • GET service status

This request returns the vROPS one service health

API:

GET https://{vropsnode}/suite-api/api/deployment/node/services/{service}/info

Representation:

{
  "name" : "ADMINUI",
  "health" : "OK",
  "others" : [ ],
  "otherAttributes" : { }
}


  • GET overall services status

This request returns the vROPS overall services health

API:

GET https://{vropsnode}}/suite-api/api/deployment/node/services/info

Representation:

{
  "service" : [ {
    "name" : "ADMINUI",
    "health" : "OK",
    "others" : [ ],
    "otherAttributes" : { }
  }, {
    "name" : "API",
    "health" : "OK",
    "others" : [ ],
    "otherAttributes" : { }
  }, { … } ]
}

vRA

  • GET the catalog items list

This request return the vRA Catalog items list


API:

GET https://{vra_node}/catalog/api/items

Representation:

{
  "content" : […],
  "pageable" : {…},
  …
  "empty" : true
}


  • GET the deployments list

This request return the vRA Catalog items list

API:

GET https://{vra_node}/deployment/api/deployments

Representation:

{
  "content" : […],
  "pageable" : {…},
  …
  "empty" : true
}

HCX

  • GET the HCX Web engine status

This request return the HCX Web Engine status

API:

GET https://{{hcx_appliance}}:9443/components/web/status

Representation:

{
  "result" : "RUNNING",
  "operationStatus" : "SUCCESS"
}


  • GET the HCX App engine status

This request return the HCX App Engine status

API:

GET https://{{hcx_appliance}}:9443/components/appengine/status

Representation:

{
  "result" : "RUNNING",
  "operationStatus" : "SUCCESS"
}



Comments

Subscribe Form

Thanks for submitting!

©2022 by virualbug.in

bottom of page