edgeSummary

edgeSummary
edgeSummary

NSX Edge summary. Read only.

JSON Example 
{
    "featureCapabilities": {
        "timestamp": 0,
        "featureCapabilities": [
            {
                "configurationLimits": [
                    {
                        "value": "string",
                        "key": "string"
                    }
                ],
                "isSupported": false,
                "service": "string",
                "permission": {
                    "dataPermission": {
                        "savePermission": false,
                        "publishPermission": false
                    },
                    "isLicensed": false,
                    "accessPermission": {
                        "managePermission": false,
                        "viewPermission": false
                    }
                }
            }
        ]
    },
    "edgeType": "string",
    "logicalRouterScopes": {
        "logicalRouterScope": [
            {
                "type": "string",
                "id": "string"
            }
        ]
    },
    "recentJobInfo": {
        "status": "string",
        "edgeId": "string",
        "module": "string",
        "jobId": "string",
        "errorCode": "string",
        "result": [
            {
                "value": "string",
                "key": "string"
            }
        ],
        "startTime": "string",
        "message": "string",
        "endTime": "string"
    },
    "hypervisorAssist": false,
    "edgeAssistId": 0,
    "edgeStatus": "string",
    "edgeAssistInstanceName": "string",
    "objectId": "string",
    "nodeId": "string",
    "id": "string",
    "datacenterName": "string",
    "state": "string",
    "clientHandle": "string",
    "scope": {
        "objectTypeName": "string",
        "id": "string",
        "name": "string"
    },
    "type": {
        "name": "string"
    },
    "revision": 0,
    "vsmUuid": "string",
    "description": "string",
    "extendedAttributes": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "localEgressEnabled": false,
    "universalRevision": 0,
    "allowedActions": [
        "string"
    ],
    "objectTypeName": "string",
    "isUpgradeAvailable": false,
    "isUniversal": false,
    "name": "string",
    "lrouterUuid": "string",
    "appliancesSummary": {
        "dataStoreMoidOfActiveVse": "string",
        "enableFips": false,
        "hostNameOfActiveVse": "string",
        "vmBuildInfo": "string",
        "deployAppliances": false,
        "communicationChannel": "string",
        "vmNameOfActiveVse": "string",
        "numberOfDeployedVms": 0,
        "resourcePoolMoidOfActiveVse": "string",
        "dataStoreNameOfActiveVse": "string",
        "vmMoidOfActiveVse": "string",
        "statusFromVseUpdatedOn": 0,
        "fqdn": "string",
        "applianceSize": "string",
        "resourcePoolNameOfActiveVse": "string",
        "activeVseHaIndex": 0,
        "vmVersion": "string",
        "hostMoidOfActiveVse": "string"
    },
    "apiVersion": "string",
    "tenantId": "string",
    "datacenterMoid": "string",
    "numberOfConnectedVnics": 0
}
featureCapabilities
featureCapabilities
Optional

List of features and their capability details based on NSX Edge appliance form factor.

string
edgeType
Optional

NSX Edge type, whether 'gatewayServices' or 'distributedRouter'.

LogicalRouterScopes
logicalRouterScopes
Optional

logicalRouterScopes

edgeJob
recentJobInfo
Optional

Job status information for the configuration change carried out on NSX Edge.

boolean
hypervisorAssist
Optional

hypervisorAssist

integer As int64 As int64
edgeAssistId
Optional

ID generated by NSX Manager for Distributed Logical Router only.

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.

string
edgeAssistInstanceName
Optional

Name derived by NSX Manager only for Distributed Logical Router.

string
objectId
Optional

objectId

string
nodeId
Optional

nodeId

string
id
Optional

NSX Edge ID.

string
datacenterName
Optional

Datacenter name where the NSX Edge is deployed.

string
state
Optional

Deployment state of the NSX Edge appliance. Values are 'deployed' when VMs have been deployed, 'undeployed' when no VMs are deployed and 'active' when Edge type is Distributed Logical Router and has no appliance deployed but is serving data path.

string
clientHandle
Optional

clientHandle

ScopeInfo
scope
Optional

scope

ObjectType
type
Optional

type

integer As int64 As int64
revision
Optional

revision

string
vsmUuid
Optional

vsmUuid

string
description
Optional

description

array of ExtendedAttribute
extendedAttributes
Optional

extendedAttributes

boolean
localEgressEnabled
Optional

Value is true if local egress is enabled for UDLR traffic. Applicable only for Universal Distributed Logical Router.

integer As int64 As int64
universalRevision
Optional

universalRevision

array of string
allowedActions
Optional

allowedActions

string
objectTypeName
Optional

objectTypeName

boolean
isUpgradeAvailable
Optional

Value is true if NSX Edge upgrade is available.

boolean
isUniversal
Optional

isUniversal

string
name
Optional

name

string
lrouterUuid
Optional

Distributed Logical Router UUID provided by the NSX Controller.

appliancesSummary
appliancesSummary
Optional

NSX Edge appliance summary.

string
apiVersion
Optional

REST API version applicable for the NSX Edge.

string
tenantId
Optional

Tenant ID for the NSX Edge.

string
datacenterMoid
Optional

vCenter MOID of the datacenter where the NSX Edge is deployed.

integer As int32 As int32
numberOfConnectedVnics
Optional

Number of connected vnics that are configured on the NSX Edge.

Property Of