List Prefixes
netbox_list_prefixesList IP prefixes (subnets) from NetBox with pagination and filtering by CIDR, status, site, VRF, and more. Supports fuzzy search and containment queries.
Instructions
List IP prefixes (subnets) from NetBox.
Supports pagination and filtering. Common patterns:
Discovery: call with no filters to browse the first prefixes.
Lookup by id: use netbox_get_prefix instead when you already have an id.
Narrow scan: combine 'q' (fuzzy text) with resource-specific filters below.
Pagination:
'limit' (max 1000, default 50) and 'offset'. Response includes 'has_more' and 'next_offset'.
Large list responses auto-truncate to keep under the character limit; keep calling with next_offset to continue.
Resource-specific filters:
prefix: Exact CIDR match, e.g. '10.0.0.0/24'.
within: Return prefixes strictly contained within this CIDR (e.g. '10.0.0.0/8').
within_include: Like 'within' but also includes the parent prefix.
contains: Return prefixes that contain this CIDR or IP.
family: 4 or 6.
status:
role_id:
site_id:
vrf_id: Numeric VRF id; 'null' also matches global.
tenant_id:
mask_length: Exact prefix length.
is_pool:
mark_utilized:
Universal filters:
q (string) Fuzzy text search across searchable fields.
tag (string[]) AND-filter by tag slugs.
created_after (date) ISO-8601 lower bound on 'created'.
created_before (date) ISO-8601 upper bound on 'created'.
Returns: Markdown summary (default) or JSON with shape: { total, count, offset, limit, items: [...], has_more, next_offset? }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Fuzzy full-text search across the object's searchable fields (name, description, etc.). | |
| tag | No | Filter to objects that have ALL of these tag slugs. Repeat for multiple tags (AND semantics in NetBox). | |
| limit | No | Maximum number of items to return per page (1-1000, default 50). | |
| family | No | 4 or 6. | |
| offset | No | Number of items to skip for pagination. Use next_offset from a previous response. | |
| prefix | No | Exact CIDR match, e.g. '10.0.0.0/24'. | |
| status | No | ||
| vrf_id | No | Numeric VRF id; 'null' also matches global. | |
| within | No | Return prefixes strictly contained within this CIDR (e.g. '10.0.0.0/8'). | |
| is_pool | No | ||
| role_id | No | ||
| site_id | No | ||
| contains | No | Return prefixes that contain this CIDR or IP. | |
| tenant_id | No | ||
| mask_length | No | Exact prefix length. | |
| created_after | No | ISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01). | |
| mark_utilized | No | ||
| created_before | No | ISO-8601 date; only return objects created on or before this date. | |
| within_include | No | Like 'within' but also includes the parent prefix. | |
| response_format | No | Output format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls. | markdown |