Tools

Note

This page is generated by scripts/gen_tool_docs.py from the server’s own tool definitions.

✎ marks a tool that changes your network. It only runs when writes are enabled for the connection; 🔒 tools also need confirm=true.

Session and system

cvcue_session_info

Show the current CV-CUE API session: logged-in key/user, role, customer, timezone and allowed locations, plus the server base URL and version. Good first call to confirm connectivity.

No parameters.

cvcue_server_info

CV-CUE server version, supported API module versions and server health. Use to check whether an endpoint/version is available on this server.

No parameters.

Connections (hosted, signed-in users)

cvcue_list_connections

List your saved CV-CUE connections (signed-in users only) and which one is in use. Use cvcue_use_connection to switch before working on another CV-CUE account.

No parameters.

cvcue_use_connection

Make another saved connection the default. Takes effect from the NEXT tool call (the current call still used the previous connection).

Parameter	Type	Default	Description
name	string	required	Connection name from cvcue_list_connections (case-insensitive)

Locations

cvcue_list_locations

List the CV-CUE location hierarchy (folders and floors) as a flat list with id, type, parentId and full path. Location ids scope most other tools via location_id (data for the whole subtree is returned).

Parameter	Type	Default	Description
name_contains	string	None	Optional case-insensitive filter on name or path

cvcue_get_location

Get one location with its path and direct children.

Parameter	Type	Default	Description
location_id	int	required	Location id (from cvcue_list_locations)

cvcue_create_location ✎

Create a folder or floor location under a parent. Requires CVCUE_ENABLE_WRITES=true.

Parameter	Type	Default	Description
name	string	required	Name of the new location
parent_id	int	required	Parent location id (folders only can hold children)
location_type	string	'folderlocation'	‘folderlocation’ (campus/building) or ‘floorlocation’
timezone_id	string	'UTC'	Java timezone id, e.g. ‘America/Los_Angeles’. Folders only: CV-CUE makes floors inherit the parent folder’s timezone
venue_id	string	None	Optional venue id / label
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

cvcue_delete_location ✎ 🔒

Delete a location AND all of its child locations. Irreversible. Requires CVCUE_ENABLE_WRITES=true and confirm=true.

Parameter	Type	Default	Description
location_id	int	required	Location id to delete — its child locations are deleted too
confirm	bool	False	Must be true to proceed
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

Access points

cvcue_list_aps

List managed Arista APs (GET /manageddevices/aps) with status, model, firmware, IP, location and client count. Use cvcue_ap_health_summary for fleet-wide rollups and cvcue_get_ap for one AP.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
active	bool	None	true = online, false = offline
name	string[]	None	AP name(s)
model	string[]	None	Model(s), e.g. [‘C-360’]
software_version	string[]	None	Firmware version(s)
start	int	0	0-based record offset
page_size	int	50	Records per page (max 500)
include_radios	bool	False	Include per-radio details

cvcue_get_ap

Get full details for one managed AP (radios, wired interfaces, mesh, health) by MAC or name.

Parameter	Type	Default	Description
mac_or_name	string	required	AP MAC address or exact AP name

cvcue_ap_health_summary

Fleet health rollup for managed APs: online/offline counts, breakdown by model, firmware, upgrade/config-push status, plus lists of offline APs and APs with problems (crashes, low power, tunnels down, config errors).

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree

cvcue_list_radios

List Wi-Fi radios across managed APs (channel, width, tx power, noise, RF utilization, client count) — the RF view for channel/power analysis.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
ap_name	string[]	None	Filter by AP name(s)
active	bool	None	Only active/inactive radios
start	int	0	0-based record offset
page_size	int	100	Records per page (max 500)

cvcue_reboot_aps ✎ 🔒

Reboot one or more managed APs (clients will be disconnected). Requires CVCUE_ENABLE_WRITES=true and confirm=true.

Parameter	Type	Default	Description
mac_addresses	string[]	required	MAC addresses of the APs to reboot
confirm	bool	False	Must be true to proceed
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

Clients

cvcue_list_clients

List Wi-Fi clients (GET /clients) with SSID, AP, signal, protocol, data rates, IP, username and OS. Defaults to currently connected clients.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
active	bool	True	true = currently connected (default), false = disconnected/historic
ssid	string[]	None	SSID name(s)
associated_ap	string[]	None	Associated AP name(s)
username	string[]	None	802.1X / portal username(s)
os_type	string[]	None	OS type(s), e.g. [‘iOS’, ‘Windows’]
start	int	0	0-based record offset
page_size	int	50	Records per page (max 500)

cvcue_find_client

Find a client by MAC, IP, username or device name (active or recently seen). Tries the most specific field first and returns all matches.

Parameter	Type	Default	Description
query	string	required	Client MAC, IP address, username or device name

cvcue_client_health_summary

Rollup of currently connected clients: totals by SSID, AP, protocol/band, OS, vendor and signal-quality bucket, plus clients with poor performance.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree

cvcue_client_association_history

Recent associations for a client (which APs/SSIDs it joined and when).

Parameter	Type	Default	Description
mac_address	string	required	Client MAC address

cvcue_disconnect_client ✎ 🔒

Force-disconnect (deauthenticate) a wireless client. The client may reconnect. Requires CVCUE_ENABLE_WRITES=true and confirm=true.

Parameter	Type	Default	Description
mac_address	string	required	Client MAC address to disconnect
confirm	bool	False	Must be true to proceed
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

SSIDs

cvcue_list_ssids

List SSID profiles (WLANs): SSID name, enabled, VLAN, security mode, guest, client isolation and where the profile was created. Use cvcue_get_ssid for the full configuration.

Parameter	Type	Default	Description
location_id	int	None	Location context (defaults to root)
include_subtree	bool	True	Also return profiles defined at child locations

cvcue_get_ssid

Full configuration of one SSID profile (security, network, QoS, firewall, portal…).

Parameter	Type	Default	Description
template_id	int	required	SSID profile templateId (from cvcue_list_ssids)
location_id	int	None	Location context

cvcue_ssid_usage

Live monitoring data per SSID/WLAN (GET /manageddevices/aps/wlans): which SSIDs are broadcast, on which bands, and how many APs/clients use them.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
active_only	bool	True	Only SSIDs currently broadcast

cvcue_delete_ssid ✎ 🔒

Delete an SSID profile. Fails if the profile is still referenced by a device template (check GET /deviceconfiguration/ssidprofiles/{templateid}/references). Requires CVCUE_ENABLE_WRITES=true and confirm=true.

Parameter	Type	Default	Description
template_id	int	required	SSID profile templateId to delete
confirm	bool	False	Must be true to proceed
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

Events and WIPS

cvcue_query_events

Recent CV-CUE events/alerts (WIPS, performance, connectivity, system), newest first, with severity, category, type, summary and timestamps.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
hours	number	24	Look-back window in hours (default 24)
severity	string[]	None	Keep only these severities (e.g. [‘HIGH’,‘MEDIUM’])
text	string	None	Case-insensitive substring match on the event summary
mac_address	string[]	None	Events involving these device MACs
limit	int	100	Max events returned (default 100, max 1000)

cvcue_event_summary

Summarize events in a time window: totals by severity, category and type, the most frequent summaries, and the latest high-severity events.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
hours	number	24	Look-back window in hours (default 24)

cvcue_list_rogue_aps

List APs detected by CV-CUE WIPS sensors by classification (rogue, external neighbor, uncategorized, authorized) with SSIDs, vendor, signal and clients.

Parameter	Type	Default	Description
group	string	'ROGUE'	Classification: ROGUE (default), EXTERNAL, UNCATEGORIZED, AUTHORIZED
location_id	int	None	Scope to a location subtree
active_only	bool	True	Only APs currently seen on the air
start	int	0	0-based record offset
page_size	int	50	Records per page (max 500)

cvcue_rogue_ap_summary

WIPS overview: number of detected (non-managed) APs per classification, rogue APs with associated clients, top vendors and top SSIDs among rogues.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree

Troubleshooting

cvcue_network_health

Key network health metrics for a location and each child location: connectivity success (association/auth/DHCP/DNS failures), performance (latency, retries, coverage, data rate), application experience and infrastructure health — the CV-CUE “Network Health” dashboard.

Parameter	Type	Default	Description
location_id	int	None	Location to analyse (children are broken out)
hours	number	24	Look-back window in hours (default 24)
ssid	string[]	None	Limit to SSID(s)

cvcue_client_events

Client connection event logs reported by APs (association, authentication, DHCP, DNS, roaming…) — defaults to failures in the last 24h.

Parameter	Type	Default	Description
mac_address	string	None	Limit to one client MAC
event_type	string[]	None	Any of Failure, Success, Intermediate (default: Failure)
location_id	int	None	Scope to a location subtree
hours	number	24	Look-back window in hours (default 24)
ssid	string	None	SSID name pattern
ap_name	string	None	AP name pattern
start	int	0	0-based record offset
page_size	int	100	Records per page (max 500)

cvcue_device_logs

Consolidated AP/device event logs (reboots, crashes, config, upgrades), newest first.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
start	int	0	0-based record offset
page_size	int	100	Records per page (max 500)

cvcue_troubleshoot_client

One-shot client troubleshooting: current client record, recent associations, connection logs, failure events and CV-CUE inferences (root-cause hints) for a client MAC. Sections that fail (e.g. permissions) are reported inline.

Parameter	Type	Default	Description
mac_address	string	required	Client MAC address
hours	number	24	Look-back window in hours (default 24)

Wired

cvcue_list_switches

List switches discovered via AP uplinks (LLDP): name, vendor, chassis id, number of APs/clients behind each, AP distribution by PoE and link speed.

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
start	int	0	0-based record offset
page_size	int	50	Records per page (max 500)

cvcue_list_wired_clients

List wired hosts seen on AP LAN ports (MAC, IP, VLAN, port, auth status, traffic).

Parameter	Type	Default	Description
location_id	int	None	Scope to a location subtree
start	int	0	0-based record offset
page_size	int	50	Records per page (max 500)

Full API discovery

cvcue_api_modules

List the CV-CUE API modules with operation counts (step 1 of API discovery). Modules group related resources: session, locations, manageddevices (your APs), aps (all detected APs incl. rogues), clients, configuration (policies), deviceconfiguration (SSID/role/RADIUS profiles, device templates), events, troubleshooting, system, reports, analytics, switches, users, … Pass a module name as module to cvcue_api_search.

No parameters.

cvcue_api_search

Search CV-CUE API endpoints (step 2 of API discovery). Matches every word of keyword against path, operationId, summary and description. Use cvcue_api_schema on a result before cvcue_api_execute.

Parameter	Type	Default	Description
keyword	string	required	Search term, e.g. ‘reboot’, ‘ssid’, ‘packet capture’, ‘rogue’
module	string	None	Optional module filter (from cvcue_api_modules)
method_filter	string	None	Optional HTTP method: GET/POST/PUT/DELETE
limit	int	40	Max results (default 40)

cvcue_api_schema

Get parameters, request body and response schema for one endpoint (step 3 of API discovery). Component $refs are inlined up to ref_depth. Also returns caveats (live-tested quirks the spec doesn’t state) and your_notes (quirks saved earlier with cvcue_save_endpoint_note). Read both before calling the endpoint.

Parameter	Type	Default	Description
path	string	required	API path exactly as in search results, e.g. ‘/clients/{macaddress}/associationhistory’
method	string	'GET'	HTTP method
ref_depth	int	3	How deep to inline $ref schemas (0-6, default 3)

cvcue_api_execute

Execute ANY CV-CUE API call (step 4 of API discovery). Paths are relative to the API base URL (…/wifi/api). Most list endpoints page with startindex (0-based offset) + pagesize, and accept locationid to scope results to a location subtree (see cvcue_list_locations). Examples: GET /system/version GET /manageddevices/aps query_params={“pagesize”: 20, “active”: true} GET /clients/{macaddress}/associationhistory path_params={“macaddress”: “AA:BB:CC:DD:EE:FF”} GET /troubleshooting/clientevents query_params={“fromtime”: , “pagesize”: 50} Large responses: many GETs accept fields=[…] for a selective fetch (a field that doesn’t support it fails with SELECTIVE_FETCH_OR_UPDATE_NOT_SUPPORTED_FOR_FIELD — drop that field and retry). /deviceconfiguration/devicetemplates is huge unless you pass modelspecific=false. Oversized results are refused with a shape preview. Secret values (passphrases, RADIUS secrets…) come back as REDACTED. Never send that placeholder back in a write body — omit the field or supply the real value. Non-GET calls require writes to be enabled for this connection. If write guard is on, the first attempt returns a preview and a confirm_token instead of writing: show it to the user and, after an explicit yes, repeat the identical call with confirm_token.

Parameter	Type	Default	Description
method	string	required	HTTP method: GET, POST, PUT, DELETE
path	string	required	API path, e.g. ‘/manageddevices/aps’ or ‘/clients/{macaddress}/snapshots’
path_params	object	None	Substitutions for {placeholders} in path
query_params	object	None	Query parameters (lists become repeated params)
body	object | any[] | string	None	JSON request body for POST/PUT/DELETE
version	string	None	Optional module API Version header (default: server latest)
confirm_token	string	None	Only when write guard asked for it: the confirm_token from the preview, sent after the user approved. Leave empty otherwise.

Endpoint notes

cvcue_save_endpoint_note

Record a quirk you proved while calling a CV-CUE endpoint (a required parameter the spec doesn’t mark, a misleading field, an error and its fix) so cvcue_api_schema shows it next time. Save only facts you verified against the live API, never guesses, secrets or customer data. Limits: 10 notes per endpoint, 300 in total.

Parameter	Type	Default	Description
method	string	required	HTTP method of the endpoint
path	string	required	Path template exactly as in the spec, e.g. ‘/manageddevices/aps’
note	string	required	The quirk, 5-500 characters. No secrets or personal data.

cvcue_delete_endpoint_note

Delete one of your endpoint notes (for example, one that turned out to be wrong).

Parameter	Type	Default	Description
note_id	string	required	Note id, as shown by cvcue_api_schema