InlineEdgeClusterItem1

InlineEdgeClusterItem1

JSON Example

{
    "id": "urn:vcloud:edgeCluster:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "description": "string",
    "regionRef": {
        "name": "string",
        "id": "string"
    },
    "deploymentType": "string",
    "nodeCount": 0,
    "orgCount": 0,
    "vpcCount": 0,
    "avgCpuUsagePercentage": "number",
    "avgMemoryUsagePercentage": "number",
    "healthStatus": "string",
    "defaultQosConfig": "GatewayQosConfig Object",
    "backingRef": "BackingRef Object"
}

string

id

Optional

The identifier of the Edge Cluster in URN format.

string

name

Optional

Display name for the Edge Cluster.

string

description

Optional

Description for the Edge Cluster.

EntityReference

regionRef

Optional

Entity reference used to describe VCD entities

string

deploymentType

Optional

Deployment type for transport nodes in the Edge Cluster. Possible values are:

• VIRTUAL_MACHINE - If all members are of type VIRTUAL_MACHINE
• PHYSICAL_MACHINE - If all members are of type PHYSICAL_MACHINE
• UNKNOWN - If there are no members or their type is not known

integer

nodeCount

Optional

Number of transport nodes in the Edge Cluster. If this information is not available, nodeCount will be set to -1.

integer

orgCount

Optional

Number of Organizations using the Edge Cluster.

integer

vpcCount

Optional

Number of VPCs using the Edge Cluster.

number As float As float

avgCpuUsagePercentage

Optional

Average CPU utilization across all member nodes. This is inclusive of both Data plane and Service CPU cores across all the member nodes.

number As float As float

avgMemoryUsagePercentage

Optional

Average RAM utilization across all member nodes.

string

healthStatus

Optional

The current health status of the Edge Cluster. Possible values are:

• UP - The Edge Cluster is healthy.
• DOWN - The Edge Cluster is down.
• DEGRADED - The Edge Cluster is not operating at capacity. One or more member nodes are down or inactive.
• UNKNOWN - The Edge Cluster state is unknown. If UNKNOWN, avgMemoryUsagePercentage and avgCpuUsagePercentage will be not be set.

GatewayQosConfig

defaultQosConfig

Optional

Represents the Ingress and Egress QoS config for a gateway.

BackingRef

backingRef

Optional

Backing Id for an entity not owned by VCD.

Used By

EdgeClusterItem