> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/using-netmap/vlans.md).

# VLANs And Groups

Groups organize topology and can carry VLAN-related metadata such as VLAN ID, IP range, gateway, DHCP range, and DNS servers.

API equivalents:

* `GET /api/v1/topology/groups`
* `POST /api/v1/topology/groups`
* `PATCH /api/v1/topology/groups/{group_id}`
* `DELETE /api/v1/topology/groups/{group_id}`
* `POST /api/v1/topology/groups/reset-device-assignments`

Write actions require `topology_write`.

## When To Use Groups

Use groups when devices belong to a logical network segment, VLAN, department, site zone, or other topology grouping.

Useful metadata includes:

* display name;
* VLAN ID;
* IP range;
* gateway;
* DHCP start/end;
* DNS servers;
* description.

## Relationship With IPAM

VLAN/group metadata can be imported into IPAM as subnet suggestions. Group edits can also sync metadata to a canonical matching IPAM subnet according to the application logic.

## Workflow

1. Open VLANs.
2. Create or edit a group.
3. Add VLAN/subnet metadata.
4. Assign devices to the group from Inventory or Topology.
5. Open IPAM to import or review subnet suggestions.

## Common Problems

| Symptom                  | Likely cause               | Fix                                     |
| ------------------------ | -------------------------- | --------------------------------------- |
| cannot save group        | missing `topology_write`   | update role permissions                 |
| IPAM suggestion missing  | group lacks valid IP range | add or correct CIDR/range metadata      |
| device appears ungrouped | device not assigned        | edit device or use topology bulk update |

## Related Pages

* [IPAM](/using-netmap/ipam.md)
* [Topology](/using-netmap/topology.md)
* [Inventory](/using-netmap/inventory.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/using-netmap/vlans.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.