List Topology Links
cnc_list_topology_linksList network topology links with up/down status, utilization, and endpoint node/interface details to inspect L2 and L3 connectivity.
Instructions
List the links (edges) on the topology map with status and utilisation.
Read-only. Each link carries its type (display name, e.g. "L2 Ethernet" for LT_L2_ETHERNET, "L3 ISIS IPv4 L1", "L3 OSPF IPv4", "L3 BGP EPE IPv4"), status (Up/Degraded/Down), both endpoint node names/UUIDs and interface names, and per-direction utilisation labels such as "0.00015% (1.5Kbps/1Gbps)" with a HEALTHY/... severity. L2 links come from LLDP collection; L3 links need an SR-PCE provider (BGP-LS).
Paging is a row window: startRow = page * page_size,
endRow = startRow + page_size. Past the end the platform returns
totalCount with no rows (reported as an empty page, not an error).
No filtering is available.
Args: page_size: rows per page (1-500). page: 0-based page number. response_format: markdown (default) or json.
Returns:
str: Markdown "status linkType: srcNode:srcIf <-> dstNode:dstIf (util)"
per link, or JSON:
{"total": int, "count": int, "page": int, "page_size": int,
"items": [{"uuid": str, "name": str, "linkType": "L2 Ethernet", "status": "Up",
"sourceNode-name": str, "sourceNode-uuid": str,
"sourceConnector-name": str, "targetNode-name": str,
"targetNode-uuid": str, "targetConnector-name": str,
"targetConnector-uto-label": str,
"targetConnector-uto-severity": "HEALTHY", ...}],
"has_more": bool, "next_page": int|null, ...}
Each item is the element's uuid merged with its attributes.
On failure: "Error: ". An HTTP 500 "Internal Server
Error" from /v1/topology-service/... means the service rejected the
request body (viewId/params) — deterministic, do NOT retry.
(It is not the inventory's "NATS request failed" signal.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 0-based page number. | |
| page_size | No | Rows per page (endRow - startRow). | |
| response_format | No | 'markdown' for human-readable output, 'json' for complete data. | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |