[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Universal Router Health

Description

Get Health information of a universal router and its associated entities such as egress points and routing. It includes information about reachability status of all the participating vDC’s of referenced vDC group and it also includes information about all the nsx managers covered by this universal router along with associated nsx controller cluster.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/health
Copy

Path Parameters

Path Parameters

string
universalRouterId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns RouterHealthReport of type(s) application/json;version=36.3
{
	"controlPlaneHealth": {
		"action": "string",
		"code": 0,
		"component": "string",
		"message": "string",
		"status": "enum"
	},
	"controlVmHealth": [
		{
			"action": "string",
			"code": 0,
			"component": "string",
			"message": "string",
			"status": "enum"
		}
	],
	"nsxManagersHealth": [
		{
			"action": "string",
			"code": 0,
			"component": "string",
			"message": "string",
			"status": "enum"
		}
	],
	"vdcReachabilityStatus": [
		{
			"action": "string",
			"code": 0,
			"component": "string",
			"message": "string",
			"status": "enum"
		}
	]
}
controlPlaneHealth Optional

Status of the nsx controller cluster associated with the nsx managers.


controlVmHealth Optional

Status of all the universal router control VMs within each network provider scope. This also includes status of egress points and routes configured for the universal router.


nsxManagersHealth Optional

Status of all the nsx managers spanned by the universal router.


vdcReachabilityStatus Optional

Reachability status for local and remote participating vDC’s of referenced vDC group. States whether a vDC is reachable from this local site.

Errors

Errors

404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/health


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?