NAME¶

nbox-search - Search devices, sites, racks, rack groups, IPs, prefixes, VLANs, circuits, virtual circuits, aggregates, ASNs, IP ranges, tenants, contacts, providers, VMs, VM types, clusters, VRFs, and route targets

SYNOPSIS¶

nbox search [-l|--limit] [--status] [--site] [--region] [--site-group] [--location] [--tenant] [--role] [--tag] [--owner] [--owner-group] [--vrf] [--cols] [--partial] [-h|--help] <QUERY>

DESCRIPTION¶

Search devices, sites, racks, rack groups, IPs, prefixes, VLANs, circuits, virtual circuits, aggregates, ASNs, IP ranges, tenants, contacts, providers, VMs, VM types, clusters, VRFs, and route targets

OPTIONS¶

-l, --limit <LIMIT> [default: 25]

Maximum number of results

--status <STATUS>

Filter by status (e.g. `active`)

--site <SITE>

Filter by site (slug, name, or id). Scoped prefixes/clusters match exact site scope. Mutually exclusive with --region/--site-group/ --location

--region <REGION>

Filter by region (slug, name, or id). Scoped prefixes/clusters include descendants through NetBox's region_id filter. Mutually exclusive with --site/--site-group/--location

--site-group <SITE_GROUP>

Filter by site group (slug, name, or id). Scoped prefixes/clusters include descendants through NetBox's site_group_id filter. Mutually exclusive with --site/--region/--location

--location <LOCATION>

Filter by location (slug, name, or id). Scoped prefixes/clusters include descendants through NetBox's location_id filter. Mutually exclusive with --site/--region/--site-group

--tenant <TENANT>

Filter by tenant slug

--role <ROLE>

Filter by role slug

--tag <TAG>

Filter by tag slug

--owner <OWNER>

Filter by owner (NetBox 4.5+) — a user, by name (username). Requires a 4.5+ NetBox; on older releases the filter is silently ignored (those releases carry no owner data)

--owner-group <OWNER_GROUP>

Filter by owner group (NetBox 4.5+) — by name. See `--owner`

--vrf <VRF>

Filter by VRF (id, RD, or name). Applies to IP and prefix results; other object kinds carry no VRF and are unaffected

--cols <COLS>

Columns to include in CSV output (comma-separated, e.g. kind,display,url)

--partial

Accept partial results if some endpoints fail (default: fail closed)

-h, --help

Print help

<QUERY>

Free-text query