edgeStatus

edgeStatus
edgeStatus

NSX Edge Appliance status.

JSON Example
{
    "edgeVmStatus": [
        {
            "edgeVMStatus": "string",
            "name": "string",
            "index": 0,
            "id": "string",
            "haState": "string",
            "preRulesGenerationNumber": 0
        }
    ],
    "lastPublishedPreRulesGenerationNumber": 0,
    "preRulesExists": false,
    "haVnicInUse": 0,
    "systemStatus": "string",
    "featureStatuses": [
        {
            "configured": false,
            "serverStatus": "string",
            "service": "string",
            "publishStatus": "string",
            "status": "string"
        }
    ],
    "edgeStatus": "string",
    "version": 0,
    "publishStatus": "string",
    "timestamp": 0,
    "activeVseHaIndex": 0
}
array of edgeVmStatus
edgeVmStatus
Optional

Detailed status of each of the deployed NSX Edge appliances.

integer As int64 As int64
lastPublishedPreRulesGenerationNumber
Optional

Value of the last published pre rules generation number.

boolean
preRulesExists
Optional

Value is true if pre rules publish is enabled.

integer As int32 As int32
haVnicInUse
Optional

Index of the vnic consumed for NSX Edge HA.

string
systemStatus
Optional

System status of the active NSX Edge appliance.

array of featureStatus
featureStatuses
Optional

Individual feature status.

string
edgeStatus
Optional

NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (none of the appliances are in serving state). If health check fails for 5 consecutive times for all appliance (2 for HA else 1) then status will turn from YELLOW to RED.

integer As int64 As int64
version
Optional

Version number of the current configuration.

string
publishStatus
Optional

Status of the latest configuration change for the NSX Edge. Values are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).

integer As int64 As int64
timestamp
Optional

Timestamp value at which the NSX Edge healthcheck was done.

integer As int32 As int32
activeVseHaIndex
Optional

Index of the active NSX Edge appliance. Values are 0 and 1.

Returned By