Circuit Management
Learn how to register, configure, and manage your Lumen circuits. Circuits are the foundation of the NaaS Portal - they represent the physical network connections whose bandwidth you'll be automating.
Overview
A circuit in the Lumen NaaS Portal represents a Lumen network circuit that you want to manage programmatically. Each circuit requires:
- Circuit ID: Your unique Lumen circuit identifier
- API Token: Authentication token provided by Lumen for API access
- Friendly Name: (Optional) A human-readable label for easy identification
- Tags: (Optional) Labels for grouping and filtering circuits
Adding a Circuit
To register a new circuit:
Navigate to the Circuits page
Select Circuits from the sidebar navigation
Click the Add Circuit button
Located in the top-right corner of the page
Fill in the required fields
Add optional details
Include a friendly name and tags for better organization
Click Create Circuit
Your circuit will be validated and added to your account
When you register a circuit, the system validates your credentials with the Lumen API. If validation fails, check that your Circuit ID and API Token are correct.
Understanding the Circuit Card
Each registered circuit displays as a card showing:
Production Circuit
LUMEN-12345-ABC
Card Elements
- Name & ID: Friendly name (if set) and the Lumen Circuit ID
- Tags: Colored badges showing assigned tags
- Current Bandwidth: The current bandwidth setting, auto-refreshed every 5 seconds
- Last Checked: Timestamp of the last status refresh
- Action Buttons: Quick actions for managing the circuit
Circuit Actions
Manual Override
The manual override feature allows you to temporarily bypass all automations and set a fixed bandwidth. This is useful for maintenance windows, testing, or emergency situations.
Setting an Override
- 1. Click the lock icon on the circuit card
- 2. Enter the desired bandwidth speed
- 3. Select the unit (Kbps, Mbps, or Gbps)
- 4. Click Set Override
Clearing an Override
- 1. Click the lock icon (shows as unlocked)
- 2. Click Clear Override
- 3. Automations will resume control
While an override is active, no automations will modify the circuit's bandwidth. The override persists until manually cleared, even through system restarts.
Automation Priority
When multiple automations target the same circuit, priority determines which automation takes control. Lower priority numbers = higher precedence.
Priority Rules
To manage priority:
Click the list icon on the circuit card
Drag and drop automations to reorder them
Automations at the top have highest priority
Click Save Order to apply changes
Editing a Circuit
To modify a circuit's settings:
Click the edit icon on the circuit card
Update the desired fields (name, API token, tags)
Click Save Changes
Deleting a Circuit
Deleting a circuit removes it from your account and deletes all associated automations. This action cannot be undone.
Click the trash icon on the circuit card
Review the warning about associated automations being deleted
Click Delete to confirm
Deleting a circuit will permanently delete all automations that reference it. Consider disabling automations first if you may need them again.
Using Tags
Tags help you organize circuits and target multiple circuits in automations.
Tag Benefits
- Bulk Actions: Target all circuits with a specific tag in automations
- Organization: Group circuits by location, environment, or purpose
- Filtering: Quickly find circuits by their tags
Common Tag Patterns
Environment
Role
Location
Priority
Circuit States
A circuit can be in one of two states:
NORMAL
The default state. The circuit is at its baseline configuration and is not currently being controlled by any automation.
ALTERED
The circuit's bandwidth has been modified by an automation.
The controlling automation is tracked in lastAlteredBy.
Security Considerations
Security Features
API Token Protection
- - Encrypted at rest using AES-256
- - Never displayed in the UI after entry
- - Never included in API responses
- - Only used server-side for Lumen API calls
Access Control
- - Circuits are scoped to your account
- - All modifications require authentication
- - Every action is logged to the audit trail
- - API access requires valid API key
Best Practices
Use unique API tokens per circuit when possible
Regularly rotate your Lumen API tokens
Review the Events log for unexpected access patterns
Use descriptive names and tags for easy identification
Keep a secure backup of your Lumen API tokens outside the portal
Troubleshooting
Circuit shows "Error" status
This typically indicates a problem with your Lumen API credentials:
- Verify your Circuit ID is correct
- Check that your API token hasn't expired
- Ensure the token has permissions for this circuit
- Try editing the circuit and re-entering the API token
Bandwidth not updating
If the bandwidth display isn't changing:
- Check if a manual override is active (lock icon will be filled)
- Verify the automation is enabled (power icon should be green)
- Check the Events page for execution errors
- Ensure the automation's schedule or trigger conditions are met
Cannot delete circuit
Circuit deletion may fail if:
- There's a network error - try again
- You've lost authentication - refresh the page and log in again
- The circuit is currently being modified by an active automation