List Providers
cnc_list_providersList and filter Crosswork providers by name or family to discover provider UUIDs and check reachability before managing topology or services.
Instructions
List the providers configured in Crosswork (SR-PCE, NSO, WAE, ...).
Read-only. Providers are the external systems CNC integrates with; the SR-PCE provider is what feeds the L3/SR-TE topology (via BGP-LS), and the NSO provider is used for service provisioning. Use this to discover provider UUIDs and check their reachability before touching devices, topology, or services; use cnc_get_provider for the full record.
Filters AND together. Only name and family are supported
filters on this endpoint. Page with page/page_size (0-based).
Args:
name: exact/wildcard name filter (case-insensitive).
family: friendly family name (sr_pce, nso, wae, syslog_storage,
alert, proxy, onc, accedian_proxy) or wire value.
page_size, page: paging; has_more/next_page say whether to
fetch another page.
response_format: markdown (one line per provider: name, uuid,
family, reachability, endpoints, credential profile) or json.
Returns:
str: Markdown listing, or JSON:
{"total": int|null, "count": int, "page": int, "page_size": int,
"items": [{"uuid", "name", "family", "profile",
"reachability_state", "connectivity_info": [...],
"properties": {...}, ...}],
"has_more": bool, "next_page": int|null,
"collection_total": int|null, "offset": int, "next_offset": int|null}
total is the number of providers matching the filter (absent /
null when Crosswork omits it, which it does for zero matches);
collection_total is the size of the whole provider collection.
On failure: "Error: " (unknown family value ->
the list of accepted values; 500 "NATS request failed" -> malformed
request rather than an outage).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Provider name filter: exact match, case-insensitive, '*' is a wildcard (e.g. 'cml-pce' or '*pce*'). No substring match without '*'. | |
| page | No | 0-based page number (e.g. 0). | |
| family | No | Provider family filter, one of: accedian_proxy, alert, nso, onc, proxy, sr_pce, syslog_storage, wae (e.g. 'sr_pce'); wire values such as 'ROBOT_PROVIDER_SR_PCE' are accepted too. | |
| page_size | No | Providers per page (e.g. 20). | |
| response_format | No | 'markdown' for human-readable output, 'json' for complete data. | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |