run_suzieq_show
Execute network observability queries using SuzieQ REST API. Specify a table (e.g., 'device', 'bgp') and optional filters (e.g., hostname, state) to retrieve structured network data in JSON format.
Instructions
Runs a SuzieQ 'show' query via its REST API.
Args:
table: The name of the SuzieQ table to query (e.g., 'device', 'bgp', 'interface', 'route').
filters: An optional dictionary of filter parameters for the SuzieQ query
(e.g., {"hostname": "leaf01", "vrf": "default", "state": "Established"}).
Keys should match SuzieQ filter names. Values can be strings or lists of strings.
If no filters are needed, this can be None, null, or an empty dictionary.
Returns:
A JSON string representing the result from the SuzieQ API, or a JSON string with an error message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | ||
| table | Yes |
Input Schema (JSON Schema)
{
"properties": {
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Filters"
},
"table": {
"title": "Table",
"type": "string"
}
},
"required": [
"table"
],
"title": "run_suzieq_showArguments",
"type": "object"
}