List Devices
cnc_list_devicesList network devices with optional filters and paging to discover UUIDs or host names before viewing, updating, or deleting them.
Instructions
List network devices (inventory nodes) with optional filters and paging.
Read-only. Use it to discover device uuids/host names before calling cnc_get_device, cnc_update_device or cnc_delete_device. Filters AND together. Unmanaged devices are hidden in the CNC UI's default table but are returned here.
Args: host_name, reachability, admin_state, credential_profile: exact-match filters (case-insensitive, '*' wildcard). Enum filters accept friendly or wire values. page_size, page: paging (page is 0-based). response_format: 'markdown' (default) or 'json'.
Returns: str: Markdown, one line per device: "host_name (uuid) ip=... reach=... oper=... admin=... profile=... dg=..." plus "More available: page=N." when another page exists. Or JSON: {"total": int|null, "count": int, "page": int, "page_size": int, "has_more": bool, "next_page": int|null, "collection_total": int|null, "items": []} 'total' is the number of matches for the filter (absent when zero matched); 'collection_total' is the size of the whole inventory. On failure: "Error: " (unknown enum value -> the accepted values are listed; 500 'NATS request failed' -> the platform could not parse the request).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 0-based page number. | |
| host_name | No | Filter by host name: exact match, case-insensitive, '*' wildcard (e.g. 'PE1' or 'PE*'). No substring match without '*'. | |
| page_size | No | Devices per page (e.g. 20). | |
| admin_state | No | Filter by admin state: 'up', 'down' or 'unmanaged' (or the wire value, e.g. 'ROBOT_ADMIN_STATE_UP'). | |
| reachability | No | Filter by reachability: 'reachable', 'unreachable', 'degraded' or 'unknown' (or the wire value, e.g. 'CONN_STATE_REACHABLE'). | |
| response_format | No | 'markdown' for a one-line-per-device summary, 'json' for all fields. | markdown |
| credential_profile | No | Filter by credential profile name (e.g. 'cml-xrd'); '*' wildcard. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |