ClusterConfig

Cluster Config

Configuration and status information for a cluster, including health metrics, DFW/IDPS status, and remediation messages.

JSON Example

{
    "cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cluster_name": "Production-Cluster-01",
    "cluster_type": "VLCM",
    "dfw_status": "ON",
    "hosts_count": 25,
    "idps_status": "ON",
    "turbo_eligible": "ELIGIBLE",
    "classic_eligible": "INELIGIBLE",
    "health": {
        "overall_health": "HIGH",
        "health_breakdown": [
            {
                "health_level": "CRITICAL",
                "host_count": 0
            },
            {
                "health_level": "HIGH",
                "host_count": 2
            },
            {
                "health_level": "NORMAL",
                "host_count": 22
            },
            {
                "health_level": "UNKNOWN",
                "host_count": 1
            },
            {
                "health_level": "INCORRECT_CONFIGURATION",
                "host_count": 0
            },
            {
                "health_level": "REQUIREMENT_NOT_MET",
                "host_count": 0
            }
        ]
    },
    "turbo_status": "ON",
    "remediation_message": [
        {
            "key": "MEMORY_THRESHOLD_EXCEEDED",
            "value": "Host memory usage above 90% on 2 hosts"
        }
    ]
}

string

cluster_id

Required  

Unique identifier for the cluster.

string

cluster_name

Required  

Display name of the cluster.

VcClusterType

cluster_type

Required  

Type of cluster (VLCM or VUM).

Enumeration: VLCM, VUM

SecurityFeatureStatus

dfw_status

Required  

Status of Distributed Firewall on the cluster (ON or OFF).

Enumeration: ON, OFF

integer As int64 As int64

hosts_count

Required  

Number of hosts in the cluster.

SecurityFeatureStatus

idps_status

Required  

Status of Intrusion Detection and Prevention System on the cluster (ON or OFF).

Enumeration: ON, OFF

EligibilityStatus

turbo_eligible

Required  

Eligibility status of the cluster for TURBO mode.

Enumeration: ELIGIBLE, INELIGIBLE, INCORRECT_CONFIGURATION

EligibilityStatus

classic_eligible

Required  

Eligibility status of the cluster for CLASSIC mode.

Enumeration: ELIGIBLE, INELIGIBLE, INCORRECT_CONFIGURATION

ClusterHealth

health

Required  

Health metrics and status breakdown for the cluster.

TurboStatus

turbo_status

Required  

Status of TURBO mode on the cluster (ON, OFF, ERROR, UNKNOWN, or INCORRECT_CONFIGURATION). If turbo_status is INCORRECT_CONFIGURATION, then the health breakdown will be empty.

Enumeration: ON, OFF, ERROR, UNKNOWN, INCORRECT_CONFIGURATION

RemediationMessage

remediation_message

Optional

Array of key-value pairs of remediation messages describing issues and recommended actions.

EpochMsTimestamp

last_updated

Optional

Timestamp in milliseconds since epoch indicating when the health assessment was last computed for this cluster. This reflects the freshness of the health data. This value is extracted from the health assessment that was actually used to determine the cluster's health (either Turbo or Classic health based on the cluster's configuration). May be empty if no health assessment data is available (e.g., when DFW is OFF or health data is unavailable).