Get Topology Summary
cnc_get_topology_summaryGet CNC topology totals and state breakdowns in one read-only call. Use it first to check if the topology is populated before drilling into nodes or links.
Instructions
Summarize the CNC topology: node/link totals and state breakdowns.
Read-only. Combines three topology-service calls (init,
nodes/summary, edges/summary) into one answer. Use it first to
learn whether the topology is populated at all (an empty topology with
a populated inventory usually means no reachable SR-PCE provider), then
drill in with cnc_get_topology, cnc_list_topology_nodes or
cnc_list_topology_links.
Returns:
str: JSON:
{"total_nodes": int, "unmapped_nodes": int, "max_logical_nodes": int,
"reachability": {"CONN_STATE_REACHABLE": 5, ...},
"link_state": {"Up": 1, "Degraded": 0, "Down": 0},
"node_breakdowns": {: {: }, ...},
"link_breakdowns": {: {: }, ...}}
unmapped_nodes counts nodes with no geographic location (they
render on the logical map only). node_breakdowns carries every
section the platform returned (e.g. device family) keyed by type.
Counts are null and breakdowns empty when the platform returns an
empty body (fresh, unpopulated topology).
On failure: "Error: ". An HTTP 500 "Internal Server
Error" from /v1/topology-service/... means the service rejected the
request body (mapType/viewId/params) — deterministic, do NOT retry.
(It is not the inventory's "NATS request failed" signal.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |