List Vlans
netbox_list_vlansRetrieve and filter layer-2 VLANs from NetBox using criteria like VID, name, status, site, or group. Paginated results with fuzzy search.
Instructions
List layer-2 VLANs from NetBox.
Supports pagination and filtering. Common patterns:
Discovery: call with no filters to browse the first vlans.
Lookup by id: use netbox_get_vlan 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:
vid: Exact VLAN id (1-4094).
name:
name__ic: Name contains (case-insensitive).
status:
site_id:
group_id: VLAN group id.
role_id:
tenant_id:
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). | |
| vid | No | Exact VLAN id (1-4094). | |
| name | No | ||
| limit | No | Maximum number of items to return per page (1-1000, default 50). | |
| offset | No | Number of items to skip for pagination. Use next_offset from a previous response. | |
| status | No | ||
| role_id | No | ||
| site_id | No | ||
| group_id | No | VLAN group id. | |
| name__ic | No | Name contains (case-insensitive). | |
| tenant_id | No | ||
| created_after | No | ISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01). | |
| created_before | No | ISO-8601 date; only return objects created on or before this date. | |
| response_format | No | Output format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls. | markdown |