[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"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

RouterHealthReport

Health Report of a Router


Properties

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.

JSON Example

{
	"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"
		}
	]
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    controlPlaneHealth:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    controlVmHealth:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    nsxManagersHealth:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    vdcReachabilityStatus:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"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
Returned By

Get Universal Router Health

Feedback

Was this page helpful?