{% include 'header.html' %}

Help & User Guide

Subnets & Devices

Managing Subnets

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.

Adding a Device

To add a device, visit the Devices page and click Add Device.

Assigning IP Addresses

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.

Viewing and Editing Devices

Click on any device in the Devices list to view or edit its details, including assigned IPs, device types and a description where necessary.

Racks

Adding a Rack

To add a new rack, go to the Racks page and click the Add Rack button. Fill in the details and submit the form.

Assigning Devices to Racks

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.

Non-Networked Devices

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.

User Management & Audit

User & Role Management

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.

Understanding Roles

The system uses role-based access control to manage what users can do. There are three default roles:

  • Admin: Full access to all features including user and role management
  • User: Can view and manage most features (devices, subnets, racks, etc.) but cannot manage users or roles
  • View Only: Read-only access to view pages but cannot make any changes

Custom 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.

Permission Granularity

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.

Audit & History

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.