Distributed Virtual Portgroup Get Overall Status

General health of this managed entity.

The overall status of the managed entity is computed as the worst status among its alarms and the configuration issues detected on the entity. The status is reported as one of the following values:

red: The entity has alarms or configuration issues with a red status.
yellow: The entity does not have alarms or configuration issues with a red status, and has at least one with a yellow status.
green: The entity does not have alarms or configuration issues with a red or yellow status, and has at least one with a green status.
gray: All of the entity's alarms have a gray status and the configuration status of the entity is not being monitored.

In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualPortgroup/{moId}/overallStatus

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case DistributedVirtualPortgroup/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns string of type(s) application/json

Operation doesn't return any data structure

On This Page