Skip to content

Usage

First Login

  1. Access the web interface at http://your-server:5000
  2. Log in with the default credentials:
  3. Email: [email protected]
  4. Password: password
  5. Change the default password immediately via the Users page

Managing Subnets

  1. Navigate to "Admin" from the main menu
  2. Click "Add Subnet" and fill in:
  3. Name: Friendly name for the subnet (e.g., "Office LAN")
  4. CIDR: Subnet in CIDR notation (e.g., 192.168.1.0/24)
  5. Site: Site/location identifier
  6. The system automatically generates all IP addresses in the subnet

Adding Devices

  1. Navigate to "Devices" from the main menu
  2. Click "Add Device"
  3. Enter device name and select device type
  4. Click "Create Device"

Assigning IP Addresses to Devices

  1. Open a device from the Devices page
  2. Select a subnet and available IP address
  3. Click "Assign IP" - the hostname is automatically updated

Configuring DHCP Pools

  1. Open a subnet view
  2. Click "Configure DHCP Pool"
  3. Set the start and end IP addresses
  4. Optionally specify excluded IPs (comma-separated)
  5. IPs within the pool range are automatically marked as "DHCP"

Managing Racks

  1. Navigate to "Racks" from the main menu
  2. Click "Add Rack" and specify:
  3. Name: Rack identifier
  4. Site: Site location
  5. Height: Rack height in U units
  6. Open a rack to assign devices to specific U positions (front or back)

Device Tagging

  1. Managing Tags (Admin only):
  2. Navigate to "Admin" > "Tag Management"
  3. Click "Add Tag" to create new tags with custom colors and descriptions

  4. Edit or delete existing tags as needed

  5. Assigning Tags to Devices:

  6. Open any device from the Devices page
  7. Use the tag assignment dropdown to add multiple tags

  8. Remove tags by clicking the × button next to the tag name

  9. Filtering by Tags:

  10. Use the tag filter dropdown on the Devices page to view devices with specific tags
  11. Tags appear as colored badges throughout the interface for easy identification

Audit Log

View all changes and actions in the "Audit Log" section, with filtering by user, subnet, action type, or device name.

Exporting Data

  • Subnet CSV: Click "Export CSV" on any subnet page to download IP addresses with hostnames
  • Rack CSV: Click "Export CSV" on any rack page to download rack layout information

Role-Based Access Control

The system uses a granular role-based access control (RBAC) system to manage user permissions:

  1. Default Roles:
  2. Admin: Full access to all features including user and role management
  3. User: Can view and manage most features (devices, subnets, racks, etc.) but cannot manage users or roles

  4. View Only: Read-only access to view pages but cannot make any changes

  5. Custom Roles: Administrators can create custom roles with specific permission sets from the Users page

  6. Permission Granularity: Permissions are organized into categories:

  7. View permissions (access to pages)
  8. Device Management (add, edit, delete devices)
  9. Network Management (subnet operations)
  10. Rack Management (rack operations)
  11. DHCP Configuration

  12. Administration (user and role management)

  13. User Management: Navigate to the Users page to:

  14. Create and manage users
  15. Assign roles to users
  16. Create custom roles with specific permissions
  17. View and regenerate API keys

REST API

The application includes a comprehensive REST API for programmatic access:

  1. Authentication: All API requests require an API key, which can be provided via:
  2. X-API-Key header
  3. Authorization: Bearer <api_key> header

  4. ?api_key=<api_key> query parameter

  5. Base URL: All API endpoints are prefixed with /api/v1

  6. Available Endpoints:

  7. Devices: GET, POST, PUT, DELETE /api/v1/devices
  8. Device Tags: GET /api/v1/devices/by-tag/{tag} (filter devices by tag)
  9. Tags: GET, POST, PUT, DELETE /api/v1/tags (with ?format=simple option)
  10. Tag Assignment: GET, POST /api/v1/devices/{id}/tags, DELETE /api/v1/devices/{id}/tags/{tag_id}
  11. Subnets: GET, POST, PUT, DELETE /api/v1/subnets
  12. Racks: GET, POST, DELETE /api/v1/racks
  13. Device Types: GET /api/v1/device-types
  14. DHCP: GET, POST /api/v1/subnets/{id}/dhcp
  15. Audit Log: GET /api/v1/audit

  16. Users & Roles: GET /api/v1/users, GET /api/v1/roles (admin only)

  17. API Keys: Each user has a unique API key that can be viewed and regenerated from the Users page. API keys respect the same role-based permissions as the web interface.

  18. Documentation: Full API documentation is available in the Help page of the web interface.

Example API Requests: 

# List all devices
curl -H "X-API-Key: your_api_key" \
     https://your-server:5000/api/v1/devices

# Get devices with a specific tag
curl -H "X-API-Key: your_api_key" \
     https://your-server:5000/api/v1/devices/by-tag/production

# List all tags in simple format
curl -H "X-API-Key: your_api_key" \
     https://your-server:5000/api/v1/tags?format=simple