To add or edit subnets, go to the Admin page. Click Add Subnet to create a new subnet, or use the edit button to modify existing subnets. Subnets are associated with sites and can be organised by location.
To add a device, visit the Devices page and click Add Device.
To assign an IP address, you must first add a device. Then, from the Devices page, click on a device to view its details and use the Add IP option to assign an IP address from a subnet.
Click on any device in the Devices list to view or edit its details, including assigned IPs, device types and a description where necessary.
To add a new rack, go to the Racks page and click the Add Rack button. Fill in the details and submit the form.
After adding a device, you can assign it to a rack from the Rack details page. Click on a rack from the Racks page, then use the options to add or remove devices within the rack.
Racks can also contain non-networked devices (such as shelves, patch panels, or other equipment that does not require an IP address). To add a non-networked device, go to a rack details page and use the option to add a device by name without assigning an IP address. These devices will appear in the rack layout but will not be listed on the Devices page.
Tags help you organize and categorize your devices. Administrators can manage tags from the Tag Management page accessible from the Admin panel. Each tag has a name, customizable colour, and optional description.
Click Add Tag to create a new tag. Choose a descriptive name (e.g., "Production", "Development", "Critical") and select a colour to visually distinguish the tag. Tags can be used to group devices by environment, importance, location, or any other criteria.
From any device's detail page, you can assign multiple tags using the tag assignment dropdown. Each device can have unlimited tags, and removing a tag is as simple as clicking the × button next to the tag name.
On the Devices page, use the tag filter dropdown to view only devices with a specific tag. This makes it easy to focus on devices in a particular environment or category.
Tags appear as coloured badges throughout the interface. Use consistent colour schemes (e.g., red for production, blue for development) to create visual patterns that help users quickly identify device categories.
Tag management respects role-based permissions. Users need appropriate permissions to view, create, edit, delete tags, or assign/remove tags from devices. View-only users can see tags but cannot modify them.
Administrators can manage users and roles from the Users page. This includes creating users, assigning roles, and managing custom roles with specific permission sets. Only users with the appropriate permissions can access this page.
The system uses role-based access control to manage what users can do. There are three default roles:
Administrators can create custom roles with specific permission sets. Go to the Users page and click the "Roles & Permissions" tab to create and manage roles.
Permissions are very granular, allowing fine-grained control over what each role can do. Permissions are organised into categories like View, Device Management, Network Management, Rack Management, and Administration.
All changes are logged and can be reviewed on the Audit page for accountability and troubleshooting. The audit log shows who made changes, what was changed, and when.
Each user has a unique API key that can be used to authenticate API requests. API keys can be viewed and regenerated from the Users page. Keep your API key secure and never share it publicly.