Quick Overview

The Onboard List page in zWAN displays all Edge Controllers (CPE devices) that are pending onboarding to the Director. It shows relevant metadata such as Product ID, Product Name (if available), and Location (if configured). This interface allows administrators to search, onboard, or delete unregistered Edge Controllers from the Director environment.

How to Use This Feature in the UI

1. Navigate to the Onboard List section in the zWAN Director UI.
2. The list will show unregistered Edge Controllers using ProductId or ProductName and Location (or “N/A”).
3. To Search for a Device:
   • Use the Search bar at the top left of the table to locate a device by name or ProductId.
4. To Onboard an Edge Controller:
   • Hover over a row in the list until the Onboard icon appears.
   • Click the icon to open the Onboard Edge Controller dialog.
   • Select an Edge Controller from the dropdown list.
   • Optionally provide a Name and Description.
   • Add metadata as key-value pairs (e.g., location=Atlanta, latitude=33.7490).
   • The Management Tunnel Servers section is read-only here. To configure, visit the Tunnel Servers page.
   • Click Onboard to complete the process.
5. To Delete an Edge Controller:
   • Hover over a row until the Delete icon appears.
   • Click the icon to prompt a confirmation dialog:
     “Are you sure you want to delete the Edge Controller [Edge Controller Name]?”
   • Click Yes to remove the entry, or Cancel to abort the operation.

Concepts & Use Cases

• Device Lifecycle Management: Control which Edge Controllers are connected to the Director through an explicit onboarding process.
• Security by Default: Edge Controllers must be manually onboarded to prevent rogue devices from connecting automatically.
• Metadata-Driven Configuration: Use metadata to assign location, purpose, or device tags during onboarding for easier classification and reporting.
• Scalable Deployment: Streamline onboarding for multiple devices in bulk environments or MSP scenarios.

Troubleshooting & FAQs

• Why is a Product Name not showing?
  If the metadata doesn’t include a name, only the ProductId will be shown. Ensure your device firmware exports correct metadata.
• Can I change tunnel servers during onboarding?
  No. Tunnel server assignment is read-only in the onboarding dialog. Visit the Tunnel Servers page to configure servers.
• What happens if I delete an unregistered Edge Controller?
  It is removed from the onboarding list. You will need to re-discover or re-upload its details to onboard it again later.
• Can I onboard the same Edge Controller more than once?
  No. Once onboarded, it is removed from this list and shown under the Edge Controllers section instead.