get_edge_cluster_status
Check the health and overall status of VMware NSX edge clusters to monitor member availability and cluster operational state.
Instructions
Check status of an edge cluster (member health, overall status).
Args: cluster_id: The edge cluster ID. target: Optional NSX Manager target name from config. Uses default if omitted.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cluster_id | Yes | ||
| target | No |
Implementation Reference
- vmware_nsx/ops/health.py:123-148 (handler)Actual implementation of the get_edge_cluster_status logic which interacts with the NSX API.
def get_edge_cluster_status(client: NsxClient, cluster_id: str) -> dict: """Get status of an edge cluster and its member nodes. Args: client: Authenticated NSX API client. cluster_id: Edge cluster UUID. Returns: Dict with overall cluster status and per-member status. """ data = client.get(f"/api/v1/edge-clusters/{cluster_id}/status") members = data.get("member_status", []) return { "cluster_id": cluster_id, "edge_cluster_status": data.get("edge_cluster_status", ""), "member_count": len(members), "members": [ { "transport_node_id": _sanitize( m.get("transport_node_id", "") ), "status": m.get("status", ""), } for m in members ], } - mcp_server/server.py:315-325 (registration)Tool registration and delegation to the underlying health implementation in mcp_server/server.py.
def get_edge_cluster_status(cluster_id: str, target: str | None = None) -> dict: """Check status of an edge cluster (member health, overall status). Args: cluster_id: The edge cluster ID. target: Optional NSX Manager target name from config. Uses default if omitted. """ from vmware_nsx.ops.health import get_edge_cluster_status as _get_ec_status client = _get_connection(target) return _get_ec_status(client, cluster_id)