API Reference

SuzieQ

Bases: _SuzieQBase, AddressMixin, ArpndMixin, BgpMixin, DeviceMixin, DevconfigMixin, EvpnVniMixin, FsMixin, InterfaceMixin, InventoryMixin, LldpMixin, MacMixin, MlagMixin, NamespaceMixin, NetworkMixin, OspfMixin, PathMixin, RouteMixin, SqPollerMixin, TablesMixin, TopologyMixin, VlanMixin

Thin Python wrapper for the SuzieQ REST API (v2).

All responses are returned as parsed Python objects (lists of dicts or column-oriented dicts for summarize). Failed HTTP requests raise :class:~suzieq_api_wrapper.SuzieQHTTPError (or a specific subclass such as :class:~suzieq_api_wrapper.AuthenticationError).

Usage::

import suzieq_api_wrapper as suzieq

client = suzieq.SuzieQ(
    url="https://127.0.0.1:8000",
    api_key="your-api-key-here",
)

# Show all BGP peers
peers = client.show_bgp()

# Show only established peers in a specific namespace
peers = client.show_bgp(namespace=["datacenter1"], state="Established")

# Assert all BGP sessions pass
results = client.assert_bgp(result="fail")

# Longest-prefix match for an address
match = client.lpm_route(address="10.0.0.1")

# Find where a MAC address lives in the network
location = client.find_network(address=["aa:bb:cc:dd:ee:ff"])

# Show interfaces that are down
down = client.show_interface(state="down")

Parameters:

Name	Type	Description	Default
url	str	Base URL of the SuzieQ REST server, e.g. "https://127.0.0.1:8000".	required
api_key	str	SuzieQ API key, configured via the SuzieQ web UI or as rest.API_KEY in ~/.suzieq/suzieq.cfg.	required
verify_ssl	bool	Whether to verify SSL certificates. Set to False for self-signed certs in dev/test environments (not recommended in production). Defaults to True.	True
timeout	int	Socket timeout in seconds for all HTTP requests. Defaults to 30. Pass None to disable.	30
retries	int	Number of retries on connection errors and HTTP 500/502/503/504 with exponential backoff (0.5 s factor). Defaults to 3. Pass 0 to disable.	3

assert_bgp(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, peer=None, state=None, vrf=None, asn=None, afiSafi=None, result=None)

Run BGP assertions and return pass/fail results.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
peer		Filter by peer address(es) or name(s).	None
state		Peer state filter.	None
vrf		Filter by VRF(s).	None
asn		Filter by AS number(s).	None
afiSafi		Address family filter.	None
result		Assertion result filter — "pass", "fail", or "all" (default).	None

Returns:

Type	Description
	List of BGP assertion result dicts.

assert_evpnvni(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vni=None, priVtepIp=None, result=None)

Run EVPN VNI assertions and return pass/fail results.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
vni		Filter by VNI number(s).	None
priVtepIp		Filter by primary VTEP IP(s).	None
result		Assertion result filter — "pass", "fail", or "all" (default).	None

Returns:

Type	Description
	List of EVPN VNI assertion result dicts.

assert_interface(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, type=None, mtu=None, master=None, vrf=None, value=None, what=None, result=None, ignore_missing_peer=None)

Run interface assertions and return pass/fail results.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		Interface state filter.	None
type		Filter by interface type(s).	None
mtu		Filter by MTU with a comparison operator.	None
master		Filter by master/parent interface(s).	None
vrf		Filter by VRF(s).	None
value		Threshold value(s) for the assertion check.	None
what		What to assert (e.g. "mtu", "speed").	None
result		Assertion result filter — "pass", "fail", or "all" (default).	None
ignore_missing_peer		If True, skip failures for interfaces with no matching peer.	None

Returns:

Type	Description
	List of interface assertion result dicts.

assert_ospf(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, area=None, vrf=None, result=None)

Run OSPF assertions and return pass/fail results.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		OSPF state filter.	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None
result		Assertion result filter — "pass", "fail", or "all" (default).	None

Returns:

Type	Description
	List of OSPF assertion result dicts.

find_network(address, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vlan=None, vrf=None)

Search the network for an IP or MAC address.

Parameters:

Name	Type	Description	Default
address		IP or MAC address(es) to locate.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
vlan		VLAN context for the search.	None
vrf		VRF context for the search.	None

Returns:

Type	Description
	List of dicts describing where the address was found.

lpm_route(address, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vrf=None, ipvers=None)

Perform a longest-prefix match for an address in the routing table.

Parameters:

Name	Type	Description	Default
address		IP address to perform the LPM lookup on (required).	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		List of columns to return.	None
query_str		Pandas query string for post-filter.	None
vrf		VRF to search within.	None
ipvers		IP version, "4" or "6".	None

Returns:

Type	Description
	List of matching route record dicts (one per device).

show_address(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, address=None, prefix=None, ipvers=None, vrf=None, type=None, ifname=None)

Return IP address assignment records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter (e.g. "state == 'up').	None
address		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
ipvers		IP version, "4" or "6".	None
vrf		Filter by VRF(s).	None
type		Filter by address type(s).	None
ifname		Filter by interface name(s).	None

Returns:

Type	Description
	List of address record dicts.

show_arpnd(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ipAddress=None, prefix=None, macaddr=None, oif=None)

Return ARP/ND table records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
ipAddress		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
macaddr		Filter by MAC address(es).	None
oif		Filter by outgoing interface(s).	None

Returns:

Type	Description
	List of ARP/ND record dicts.

show_bgp(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, peer=None, state=None, vrf=None, asn=None, afiSafi=None)

Return BGP peer records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
peer		Filter by BGP peer address(es) or name(s).	None
state		Peer state filter, e.g. "Established", "NotEstd", or "!Established" to negate.	None
vrf		Filter by VRF(s).	None
asn		Filter by AS number(s).	None
afiSafi		Address family filter (e.g. "ipv4Unicast").	None

Returns:

Type	Description
	List of BGP peer record dicts.

show_devconfig(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, section=None)

Return raw device configuration records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
section		Config section to retrieve.	None

Returns:

Type	Description
	List of device configuration record dicts.

show_device(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, os=None, vendor=None, model=None, version=None, status=None, ignore_neverpoll=None, address=None)

Return device inventory records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
os		Filter by operating system(s).	None
vendor		Filter by vendor(s).	None
model		Filter by model(s).	None
version		Filter by OS version(s).	None
status		Device status filter — "alive", "dead", "neverpoll", or "!alive" to negate.	None
ignore_neverpoll		If True, exclude devices that have never been polled.	None
address		Filter by management IP address(es).	None

Returns:

Type	Description
	List of device record dicts.

show_evpnvni(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vni=None, priVtepIp=None)

Return EVPN VNI records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
vni		Filter by VNI number(s).	None
priVtepIp		Filter by primary VTEP IP(s).	None

Returns:

Type	Description
	List of EVPN VNI record dicts.

show_fs(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, mountPoint=None, usedPercent=None)

Return filesystem usage records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
mountPoint		Filter by mount point(s).	None
usedPercent		Filter by used percentage with a comparison operator, e.g. ">80".	None

Returns:

Type	Description
	List of filesystem record dicts.

show_interface(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, type=None, mtu=None, master=None, vrf=None, portmode=None, vlan=None, macaddr=None, bond=None, ifindex=None)

Return interface records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		Interface state filter — "up", "down", "errDisabled", "notConnected", or negations like "!down".	None
type		Filter by interface type(s).	None
mtu		Filter by MTU with a comparison operator, e.g. ">1500".	None
master		Filter by master/parent interface(s).	None
vrf		Filter by VRF(s).	None
portmode		Filter by port mode(s).	None
vlan		Filter by VLAN(s).	None
macaddr		Filter by MAC address(es).	None
bond		Filter by bond interface(s).	None
ifindex		Filter by interface index(es).	None

Returns:

Type	Description
	List of interface record dicts.

show_inventory(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, type=None, serial=None, model=None, vendor=None, status=None)

Return hardware inventory records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
type		Filter by component type(s).	None
serial		Filter by serial number(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None
status		Component status — "present" or "absent".	None

Returns:

Type	Description
	List of inventory record dicts.

show_lldp(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, peerMacaddr=None, peerHostname=None, use_bond=None)

Return LLDP neighbor records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by local interface name(s).	None
peerMacaddr		Filter by peer MAC address(es).	None
peerHostname		Filter by peer hostname(s).	None
use_bond		"True" or "False" to filter by bond usage.	None

Returns:

Type	Description
	List of LLDP neighbor record dicts.

show_mac(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, macaddr=None, vlan=None, remoteVtepIp=None, local=None, bd=None, moveCount=None)

Return MAC address table records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
macaddr		Filter by MAC address(es).	None
vlan		Filter by VLAN ID(s).	None
remoteVtepIp		Filter by remote VTEP IP(s) (EVPN).	None
local		Filter for local entries.	None
bd		Filter by bridge domain.	None
moveCount		Filter by MAC move count (e.g. ">5").	None

Returns:

Type	Description
	List of MAC address table record dicts.

show_mlag(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return MLAG status records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of MLAG record dicts.

show_namespace(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, version=None, os=None, model=None, vendor=None)

Return namespace summary records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
version		Filter by OS version.	None
os		Filter by operating system(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None

Returns:

Type	Description
	List of namespace record dicts.

show_network(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return network/namespace records.

.. deprecated:: This verb is deprecated on the SuzieQ server and redirects to the namespace table. Use :meth:show_namespace instead.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		List of columns to return.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of namespace record dicts.

show_ospf(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, area=None, vrf=None)

Return OSPF neighbor and interface records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		OSPF state filter — "full", "passive", "other", or negations like "!full".	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None

Returns:

Type	Description
	List of OSPF record dicts.

show_path(src, dest, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vrf=None)

Compute and return the Layer 3 path between two IP addresses.

Parameters:

Name	Type	Description	Default
src		Source IP address (required).	required
dest		Destination IP address (required).	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
vrf		VRF to use for path computation.	None

Returns:

Type	Description
	List of path hop record dicts describing each hop from
	src to dest.

show_route(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, prefix=None, vrf=None, protocol=None, prefixlen=None, ipvers=None, add_filter=None)

Return routing table records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
prefix		Filter by route prefix(es).	None
vrf		Filter by VRF(s).	None
protocol		Filter by routing protocol(s) (e.g. "bgp", "ospf", "static").	None
prefixlen		Filter by prefix length with a comparison operator, e.g. "<24" or ">=16".	None
ipvers		IP version, "4" or "6".	None
add_filter		Additional Pandas filter expression.	None

Returns:

Type	Description
	List of route record dicts.

show_sqpoller(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, service=None, status=None, pollExcdPeriodCount=None)

Return SuzieQ poller health records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
service		Filter by service/table name being polled.	None
status		Poller status — "pass", "fail", or "all".	None
pollExcdPeriodCount		Filter by number of times the poll period was exceeded (e.g. ">0").	None

Returns:

Type	Description
	List of poller health record dicts.

show_tables(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, table=None)

Return records listing available SuzieQ tables.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
table		Filter results to a specific table name.	None

Returns:

Type	Description
	List of table descriptor dicts.

show_topology(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, via=None, ifname=None, peerHostname=None, asn=None, area=None, vrf=None, afiSafi=None, polled=None)

Return network topology records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
via		Protocol(s) to include — "lldp", "bgp", "ospf", "arpnd".	None
ifname		Filter by interface name(s).	None
peerHostname		Filter by peer hostname(s).	None
asn		Filter by AS number(s).	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None
afiSafi		BGP address family filter.	None
polled		Filter to only polled links.	None

Returns:

Type	Description
	List of topology edge record dicts.

show_vlan(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vlan=None, state=None, vlanName=None)

Return VLAN table records.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window (ISO 8601 or relative).	None
end_time		End of time window.	None
view		One of "latest" (default), "all", or "changes".	None
columns		List of columns to return; use ["*"] for all.	None
query_str		Pandas query string for post-filter.	None
vlan		Filter by VLAN ID(s).	None
state		VLAN state — "active" or "suspended".	None
vlanName		Filter by VLAN name(s).	None

Returns:

Type	Description
	List of VLAN record dicts.

summarize_address(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, address=None, prefix=None, ipvers=None, vrf=None, type=None, ifname=None)

Return summary statistics for the address table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
address		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
ipvers		IP version, "4" or "6".	None
vrf		Filter by VRF(s).	None
type		Filter by address type(s).	None
ifname		Filter by interface name(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_arpnd(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ipAddress=None, prefix=None, macaddr=None, oif=None)

Return summary statistics for the arpnd table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
ipAddress		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
macaddr		Filter by MAC address(es).	None
oif		Filter by outgoing interface(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_bgp(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, peer=None, state=None, vrf=None, asn=None, afiSafi=None)

Return summary statistics for the bgp table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
peer		Filter by peer address(es) or name(s).	None
state		Peer state filter.	None
vrf		Filter by VRF(s).	None
asn		Filter by AS number(s).	None
afiSafi		Address family filter.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_devconfig(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, section=None)

Return summary statistics for the devconfig table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
section		Config section to retrieve.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_device(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, os=None, vendor=None, model=None, version=None, status=None, ignore_neverpoll=None, address=None)

Return summary statistics for the device table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
os		Filter by operating system(s).	None
vendor		Filter by vendor(s).	None
model		Filter by model(s).	None
version		Filter by OS version(s).	None
status		Device status filter.	None
ignore_neverpoll		If True, exclude never-polled devices.	None
address		Filter by management IP address(es).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_evpnvni(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vni=None, priVtepIp=None)

Return summary statistics for the evpnVni table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
vni		Filter by VNI number(s).	None
priVtepIp		Filter by primary VTEP IP(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_fs(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, mountPoint=None, usedPercent=None)

Return summary statistics for the fs table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
mountPoint		Filter by mount point(s).	None
usedPercent		Filter by used percentage (e.g. ">80").	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_interface(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, type=None, mtu=None, master=None, vrf=None, portmode=None, vlan=None, macaddr=None, bond=None, ifindex=None)

Return summary statistics for the interface table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		Interface state filter.	None
type		Filter by interface type(s).	None
mtu		Filter by MTU with a comparison operator.	None
master		Filter by master/parent interface(s).	None
vrf		Filter by VRF(s).	None
portmode		Filter by port mode(s).	None
vlan		Filter by VLAN(s).	None
macaddr		Filter by MAC address(es).	None
bond		Filter by bond interface(s).	None
ifindex		Filter by interface index(es).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_inventory(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, type=None, serial=None, model=None, vendor=None, status=None)

Return summary statistics for the inventory table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
type		Filter by component type(s).	None
serial		Filter by serial number(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None
status		Component status — "present" or "absent".	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_lldp(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, peerMacaddr=None, peerHostname=None, use_bond=None)

Return summary statistics for the lldp table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by local interface name(s).	None
peerMacaddr		Filter by peer MAC address(es).	None
peerHostname		Filter by peer hostname(s).	None
use_bond		"True" or "False" to filter by bond usage.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_mac(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, macaddr=None, vlan=None, remoteVtepIp=None, local=None, bd=None, moveCount=None)

Return summary statistics for the mac table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
macaddr		Filter by MAC address(es).	None
vlan		Filter by VLAN ID(s).	None
remoteVtepIp		Filter by remote VTEP IP(s).	None
local		Filter for local entries.	None
bd		Filter by bridge domain.	None
moveCount		Filter by MAC move count (e.g. ">5").	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_mlag(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return summary statistics for the mlag table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_namespace(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, version=None, os=None, model=None, vendor=None)

Return summary statistics for the namespace table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
version		Filter by OS version.	None
os		Filter by operating system(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_network(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return summary statistics for the network table.

.. deprecated:: This verb is deprecated on the SuzieQ server. Use :meth:summarize_namespace instead.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_ospf(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, area=None, vrf=None)

Return summary statistics for the ospf table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		OSPF state filter.	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_path(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, src=None, dest=None, vrf=None)

Return summary statistics for the path table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
src		Source IP address.	None
dest		Destination IP address.	None
vrf		VRF context.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_route(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, prefix=None, vrf=None, protocol=None, prefixlen=None, ipvers=None, add_filter=None)

Return summary statistics for the route table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
prefix		Filter by route prefix(es).	None
vrf		Filter by VRF(s).	None
protocol		Filter by routing protocol(s).	None
prefixlen		Filter by prefix length with a comparison operator.	None
ipvers		IP version, "4" or "6".	None
add_filter		Additional Pandas filter expression.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_sqpoller(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, service=None, status=None, pollExcdPeriodCount=None)

Return summary statistics for the sqPoller table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
service		Filter by service/table name.	None
status		Poller status — "pass", "fail", or "all".	None
pollExcdPeriodCount		Filter by poll period exceeded count.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_tables(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, table=None)

Return summary statistics for the table meta-table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
table		Filter to a specific table name.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_topology(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, via=None, ifname=None, peerHostname=None, asn=None, area=None, vrf=None, afiSafi=None, polled=None)

Return summary statistics for the topology table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
via		Protocol(s) to include.	None
ifname		Filter by interface name(s).	None
peerHostname		Filter by peer hostname(s).	None
asn		Filter by AS number(s).	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None
afiSafi		BGP address family filter.	None
polled		Filter to only polled links.	None

Returns:

Type	Description
	Column-oriented summary dict.

summarize_vlan(namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vlan=None, state=None, vlanName=None)

Return summary statistics for the vlan table.

Parameters:

Name	Type	Description	Default
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include in summary.	None
query_str		Pandas query string for post-filter.	None
vlan		Filter by VLAN ID(s).	None
state		VLAN state — "active" or "suspended".	None
vlanName		Filter by VLAN name(s).	None

Returns:

Type	Description
	Column-oriented summary dict.

top_address(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, address=None, prefix=None, ipvers=None, vrf=None, type=None, ifname=None)

Return the top N records sorted by a column in the address table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
address		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
ipvers		IP version, "4" or "6".	None
vrf		Filter by VRF(s).	None
type		Filter by address type(s).	None
ifname		Filter by interface name(s).	None

Returns:

Type	Description
	List of top-N address record dicts.

top_arpnd(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ipAddress=None, prefix=None, macaddr=None, oif=None)

Return the top N records sorted by a column in the arpnd table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ipAddress		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
macaddr		Filter by MAC address(es).	None
oif		Filter by outgoing interface(s).	None

Returns:

Type	Description
	List of top-N ARP/ND record dicts.

top_bgp(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, peer=None, state=None, vrf=None, asn=None, afiSafi=None)

Return the top N records sorted by a column in the bgp table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
peer		Filter by peer address(es) or name(s).	None
state		Peer state filter.	None
vrf		Filter by VRF(s).	None
asn		Filter by AS number(s).	None
afiSafi		Address family filter.	None

Returns:

Type	Description
	List of top-N BGP peer record dicts.

top_devconfig(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, section=None)

Return the top N records sorted by a column in the devconfig table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
section		Config section to retrieve.	None

Returns:

Type	Description
	List of top-N device configuration record dicts.

top_device(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, os=None, vendor=None, model=None, version=None, status=None, ignore_neverpoll=None, address=None)

Return the top N records sorted by a column in the device table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
os		Filter by operating system(s).	None
vendor		Filter by vendor(s).	None
model		Filter by model(s).	None
version		Filter by OS version(s).	None
status		Device status filter.	None
ignore_neverpoll		If True, exclude never-polled devices.	None
address		Filter by management IP address(es).	None

Returns:

Type	Description
	List of top-N device record dicts.

top_evpnvni(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vni=None, priVtepIp=None)

Return the top N records sorted by a column in the evpnVni table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
vni		Filter by VNI number(s).	None
priVtepIp		Filter by primary VTEP IP(s).	None

Returns:

Type	Description
	List of top-N EVPN VNI record dicts.

top_fs(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, mountPoint=None, usedPercent=None)

Return the top N records sorted by a column in the fs table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
mountPoint		Filter by mount point(s).	None
usedPercent		Filter by used percentage (e.g. ">80").	None

Returns:

Type	Description
	List of top-N filesystem record dicts.

top_interface(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, type=None, mtu=None, master=None, vrf=None, portmode=None, vlan=None, macaddr=None, bond=None, ifindex=None)

Return the top N records sorted by a column in the interface table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		Interface state filter.	None
type		Filter by interface type(s).	None
mtu		Filter by MTU with a comparison operator.	None
master		Filter by master/parent interface(s).	None
vrf		Filter by VRF(s).	None
portmode		Filter by port mode(s).	None
vlan		Filter by VLAN(s).	None
macaddr		Filter by MAC address(es).	None
bond		Filter by bond interface(s).	None
ifindex		Filter by interface index(es).	None

Returns:

Type	Description
	List of top-N interface record dicts.

top_inventory(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, type=None, serial=None, model=None, vendor=None, status=None)

Return the top N records sorted by a column in the inventory table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
type		Filter by component type(s).	None
serial		Filter by serial number(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None
status		Component status — "present" or "absent".	None

Returns:

Type	Description
	List of top-N inventory record dicts.

top_lldp(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, peerMacaddr=None, peerHostname=None, use_bond=None)

Return the top N records sorted by a column in the lldp table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by local interface name(s).	None
peerMacaddr		Filter by peer MAC address(es).	None
peerHostname		Filter by peer hostname(s).	None
use_bond		"True" or "False" to filter by bond usage.	None

Returns:

Type	Description
	List of top-N LLDP neighbor record dicts.

top_mac(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, macaddr=None, vlan=None, remoteVtepIp=None, local=None, bd=None, moveCount=None)

Return the top N records sorted by a column in the mac table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
macaddr		Filter by MAC address(es).	None
vlan		Filter by VLAN ID(s).	None
remoteVtepIp		Filter by remote VTEP IP(s).	None
local		Filter for local entries.	None
bd		Filter by bridge domain.	None
moveCount		Filter by MAC move count.	None

Returns:

Type	Description
	List of top-N MAC address table record dicts.

top_mlag(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return the top N records sorted by a column in the mlag table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of top-N MLAG record dicts.

top_namespace(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, version=None, os=None, model=None, vendor=None)

Return the top N records sorted by a column in the namespace table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
version		Filter by OS version.	None
os		Filter by operating system(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None

Returns:

Type	Description
	List of top-N namespace record dicts.

top_network(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return the top N records sorted by a column in the network table.

.. deprecated:: This verb is deprecated on the SuzieQ server. Use :meth:top_namespace instead.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of top-N namespace record dicts.

top_ospf(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, area=None, vrf=None)

Return the top N records sorted by a column in the ospf table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		OSPF state filter.	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None

Returns:

Type	Description
	List of top-N OSPF record dicts.

top_path(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, src=None, dest=None, vrf=None)

Return the top N records sorted by a column in the path table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
src		Source IP address.	None
dest		Destination IP address.	None
vrf		VRF context.	None

Returns:

Type	Description
	List of top-N path record dicts.

top_route(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, prefix=None, vrf=None, protocol=None, prefixlen=None, ipvers=None, add_filter=None)

Return the top N records sorted by a column in the route table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
prefix		Filter by route prefix(es).	None
vrf		Filter by VRF(s).	None
protocol		Filter by routing protocol(s).	None
prefixlen		Filter by prefix length with a comparison operator.	None
ipvers		IP version, "4" or "6".	None
add_filter		Additional Pandas filter expression.	None

Returns:

Type	Description
	List of top-N route record dicts.

top_sqpoller(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, service=None, status=None, pollExcdPeriodCount=None)

Return the top N records sorted by a column in the sqPoller table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
service		Filter by service/table name.	None
status		Poller status — "pass", "fail", or "all".	None
pollExcdPeriodCount		Filter by poll period exceeded count.	None

Returns:

Type	Description
	List of top-N poller health record dicts.

top_tables(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, table=None)

Return the top N records sorted by a column in the table meta-table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
table		Filter to a specific table name.	None

Returns:

Type	Description
	List of top-N table descriptor dicts.

top_topology(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, via=None, ifname=None, peerHostname=None, asn=None, area=None, vrf=None, afiSafi=None, polled=None)

Return the top N records sorted by a column in the topology table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
via		Protocol(s) to include.	None
ifname		Filter by interface name(s).	None
peerHostname		Filter by peer hostname(s).	None
asn		Filter by AS number(s).	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None
afiSafi		BGP address family filter.	None
polled		Filter to only polled links.	None

Returns:

Type	Description
	List of top-N topology edge record dicts.

top_vlan(what, count=None, reverse=None, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vlan=None, state=None, vlanName=None)

Return the top N records sorted by a column in the vlan table.

Parameters:

Name	Type	Description	Default
what		Column name to sort by.	required
count		Number of rows to return.	None
reverse		If truthy, reverse the sort order.	None
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
vlan		Filter by VLAN ID(s).	None
state		VLAN state — "active" or "suspended".	None
vlanName		Filter by VLAN name(s).	None

Returns:

Type	Description
	List of top-N VLAN record dicts.

unique_address(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, address=None, prefix=None, ipvers=None, vrf=None, type=None, ifname=None)

Return unique values and counts for a column in the address table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
address		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
ipvers		IP version, "4" or "6".	None
vrf		Filter by VRF(s).	None
type		Filter by address type(s).	None
ifname		Filter by interface name(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_arpnd(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ipAddress=None, prefix=None, macaddr=None, oif=None)

Return unique values and counts for a column in the arpnd table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ipAddress		Filter by IP address(es).	None
prefix		Filter by prefix(es).	None
macaddr		Filter by MAC address(es).	None
oif		Filter by outgoing interface(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_bgp(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, peer=None, state=None, vrf=None, asn=None, afiSafi=None)

Return unique values and counts for a column in the bgp table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
peer		Filter by peer address(es) or name(s).	None
state		Peer state filter.	None
vrf		Filter by VRF(s).	None
asn		Filter by AS number(s).	None
afiSafi		Address family filter.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_device(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, os=None, vendor=None, model=None, version=None, status=None, ignore_neverpoll=None, address=None)

Return unique values and counts for a column in the device table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
os		Filter by operating system(s).	None
vendor		Filter by vendor(s).	None
model		Filter by model(s).	None
version		Filter by OS version(s).	None
status		Device status filter.	None
ignore_neverpoll		If True, exclude never-polled devices.	None
address		Filter by management IP address(es).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_evpnvni(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vni=None, priVtepIp=None)

Return unique values and counts for a column in the evpnVni table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
vni		Filter by VNI number(s).	None
priVtepIp		Filter by primary VTEP IP(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_fs(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, mountPoint=None, usedPercent=None)

Return unique values and counts for a column in the fs table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
mountPoint		Filter by mount point(s).	None
usedPercent		Filter by used percentage (e.g. ">80").	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_interface(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, type=None, mtu=None, master=None, vrf=None, portmode=None, vlan=None, macaddr=None, bond=None, ifindex=None)

Return unique values and counts for a column in the interface table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		Interface state filter.	None
type		Filter by interface type(s).	None
mtu		Filter by MTU with a comparison operator.	None
master		Filter by master/parent interface(s).	None
vrf		Filter by VRF(s).	None
portmode		Filter by port mode(s).	None
vlan		Filter by VLAN(s).	None
macaddr		Filter by MAC address(es).	None
bond		Filter by bond interface(s).	None
ifindex		Filter by interface index(es).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_inventory(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, type=None, serial=None, model=None, vendor=None, status=None)

Return unique values and counts for a column in the inventory table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
type		Filter by component type(s).	None
serial		Filter by serial number(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None
status		Component status — "present" or "absent".	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_lldp(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, peerMacaddr=None, peerHostname=None, use_bond=None)

Return unique values and counts for a column in the lldp table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by local interface name(s).	None
peerMacaddr		Filter by peer MAC address(es).	None
peerHostname		Filter by peer hostname(s).	None
use_bond		"True" or "False" to filter by bond usage.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_mac(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, macaddr=None, vlan=None, remoteVtepIp=None, local=None, bd=None, moveCount=None)

Return unique values and counts for a column in the mac table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
macaddr		Filter by MAC address(es).	None
vlan		Filter by VLAN ID(s).	None
remoteVtepIp		Filter by remote VTEP IP(s).	None
local		Filter for local entries.	None
bd		Filter by bridge domain.	None
moveCount		Filter by MAC move count.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_mlag(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return unique values and counts for a column in the mlag table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_namespace(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, version=None, os=None, model=None, vendor=None)

Return unique values and counts for a column in the namespace table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
version		Filter by OS version.	None
os		Filter by operating system(s).	None
model		Filter by model(s).	None
vendor		Filter by vendor(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_network(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None)

Return unique values and counts for a column in the network table.

.. deprecated:: This verb is deprecated on the SuzieQ server. Use :meth:unique_namespace instead.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_ospf(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, ifname=None, state=None, area=None, vrf=None)

Return unique values and counts for a column in the ospf table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
ifname		Filter by interface name(s).	None
state		OSPF state filter.	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_path(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, src=None, dest=None, vrf=None)

Return unique values and counts for a column in the path table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
src		Source IP address.	None
dest		Destination IP address.	None
vrf		VRF context.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_route(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, prefix=None, vrf=None, protocol=None, prefixlen=None, ipvers=None, add_filter=None)

Return unique values and counts for a column in the route table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
prefix		Filter by route prefix(es).	None
vrf		Filter by VRF(s).	None
protocol		Filter by routing protocol(s).	None
prefixlen		Filter by prefix length with a comparison operator.	None
ipvers		IP version, "4" or "6".	None
add_filter		Additional Pandas filter expression.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_sqpoller(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, service=None, status=None, pollExcdPeriodCount=None)

Return unique values and counts for a column in the sqPoller table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
service		Filter by service/table name.	None
status		Poller status — "pass", "fail", or "all".	None
pollExcdPeriodCount		Filter by poll period exceeded count.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_tables(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, table=None)

Return unique values and counts for a column in the table meta-table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
table		Filter to a specific table name.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_topology(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, via=None, ifname=None, peerHostname=None, asn=None, area=None, vrf=None, afiSafi=None, polled=None)

Return unique values and counts for a column in the topology table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
via		Protocol(s) to include.	None
ifname		Filter by interface name(s).	None
peerHostname		Filter by peer hostname(s).	None
asn		Filter by AS number(s).	None
area		Filter by OSPF area(s).	None
vrf		Filter by VRF(s).	None
afiSafi		BGP address family filter.	None
polled		Filter to only polled links.	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.

unique_vlan(what, namespace=None, hostname=None, start_time=None, end_time=None, view=None, columns=None, query_str=None, vlan=None, state=None, vlanName=None)

Return unique values and counts for a column in the vlan table.

Parameters:

Name	Type	Description	Default
what		Column name to compute unique values for.	required
namespace		Filter by namespace(s).	None
hostname		Filter by device hostname(s).	None
start_time		Start of time window.	None
end_time		End of time window.	None
view		One of "latest", "all", or "changes".	None
columns		Columns to include.	None
query_str		Pandas query string for post-filter.	None
vlan		Filter by VLAN ID(s).	None
state		VLAN state — "active" or "suspended".	None
vlanName		Filter by VLAN name(s).	None

Returns:

Type	Description
	List of dicts with "entry" and "count" keys.