USER GUIDE

Edge Controller
 Copyright

© 2022 Cambium Networks Limited. All rights reserved.

This document, Cambium products, and 3rd Party software products described in this document may include or
describe copyrighted Cambium and other 3rd Party supplied computer programs stored in semiconductor
memories or other media. Laws in the United States and other countries preserve for Cambium, its licensors,
and other 3rd Party supplied software certain exclusive rights for copyrighted material, including the exclusive
right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material.
Accordingly, any copyrighted material of Cambium, its licensors, or the 3rd Party software supplied material
contained in the Cambium products described in this document may not be copied, reproduced, reverse
engineered, distributed, merged or modified in any manner without the express written permission of Cambium.
Furthermore, the purchase of Cambium products shall not be deemed to grant either directly or by implication,
estoppel, or otherwise, any license under the copyrights, patents or patent applications of Cambium or other
3rd Party supplied software, except for the normal non-exclusive, royalty free license to use that arises by
operation of law in the sale of a product.

Restrictions

Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No
part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval
system, or translated into any language or computer language, in any form or by any means, without prior
written permission of Cambium.

License Agreements

The software described in this document is the property of Cambium and its licensors. It is furnished by express
license agreement only and may be used only in accordance with the terms of such an agreement.

2| Edge Controller | User Guide

 Contents

Contents 3
Edge Controller 4
Overview 4
Network Management Architecture 4
Prerequisites 4
Edge Controller Installation 5
Edge Controller CLI Operations 7
Managing Edge Controller 13
Edge Controller Management 14
Dashboard 14
Configuration 15
Tools 21
Monitoring 24
Cambium Networks 25

3 | Contents Edge Controller | User Guide

 Edge Controller
Overview
Edge Controller is an application hosted in a customer’s data center behind their firewall. It provides a generic
framework for running edge services that interact directly with cnMaestro Cloud or On-Premises. The Edge
Controller application supports SNMP device management for PTP 820/850.

Network Management Architecture

The Edge Controller architecture is represented in Figure 1.

Figure 1 The Edge Controller Architecture

Prerequisites
Supported OS
The supported OSs for installing Edge Controller are as follows:

l Ubuntu 18.04, 20.04, and 22.04

Support Container Platform

Edge Controller supports only the below-mentioned container service:

l Docker
l Docker Compose

NOTE:
l Uninstall if any alternate container products installed in VM before installation.
l Installer script will automatically install docker and required softwares.

Hardware Requirements
Edge Controller must meet the following hardware specifications:

l 2 (v)CPU x86_64 or AMD 64

4 | Edge Controller Edge Controller | User Guide

 l 4 GB RAM
l 40 GB free space on /var/lib/docker
Table 1: Hardware Requirements for PTP 820/850 devices

Number of Devices Number of vCPUs RAM Size (GB) SSD Disk (GB)

1-500 2 4 40 (/var/lib/docker)

500-1000 4 8 50 (/var/lib/docker)

cnMaestro Requirement
cnMaestro must be running 3.2.0 or higher to onboard and manage Edge Controller.

Inbound TCP Port Requirements

Port Requirements

21, 2222 Used by PTP 820 devices to download software images from Edge Controller.

Edge Controller Installation

Execute the following command to deploy the Edge Controller services for the supported OS:

curl -sSL https://registry.cloud.cambiumnetworks.com/bootstrap-ec | sudo bash

NOTE:
l Cambium ID is optional for cnMaestro On-Premises.
l Internet access is required for installation and software update.

In the launched application, enter the cnMaestro URL or IP Address, Cambium ID, and Onboarding Key when
prompted as shown in Figure 2.

NOTE:
l Cambium ID is optional for cnMaestro On-Premises.
l Internet access is required for installation and software update.

5 | Edge Controller Edge Controller | User Guide

 Figure 2 Edge Controller Installation

When the deployment is successful, the connection status with the default Edge Controller name displays as
shown in Figure 3.

Figure 3 Edge Controller Connection Status

If the connection is successful, you must approve the Edge Controller from cnMaestro's Onboarding page.

To onboard the Edge Controller in cnMaestro, perform the following steps:

1. Navigate to cnMaestro > Onboard > Edge Controller > Controllers.

2. The Onboard page displays the new Edge Controller.
3. Click Approve.
4. In the Update Edge Controller window, edit the name of the Edge Controller as shown in Figure 4.

6 | Edge Controller Edge Controller | User Guide

 Figure 4 Onboard Edge Controller

5. Click Approve.

Edge Controller CLI Operations

NOTE:
To view the Edge Controller CLI options, you must have root access.

Use the following commands to execute operations from the Edge Controller CLI:

sudo /usr/local/bin/edge-controller

The available CLI options are as shown in Figure 5.

Figure 5 Options

Option 1: Update Configuration

Update cnMaestro URL, Cambium ID and Onboarding Key as shown in Figure 6.

7 | Edge Controller Edge Controller | User Guide

 Figure 6 Update Configuration option

Option 2: Verify Connection status

Verify cnMaestro's connectivity status as shown in Figure 7.

Figure 7 Connection Status

8 | Edge Controller Edge Controller | User Guide

 Option 3: Techdump
Generate technical support dump to share with Cambium Networks Support as shown in Figure 8.

Figure 8 Techdump

Option 4: Software Update

Update the Edge Controller services with the latest available packages as shown in Figure 9.

Figure 9 Service Update

9 | Edge Controller Edge Controller | User Guide

 Option 5: Services Status
Verify the status and usage of Edge Controller services as shown in Figure 10.

Figure 10 Service Status

Option 6: Service Logs

View the logs of different services running in Edge Controller as shown in Figure 11.

Figure 11 Service Logs

Option 7: SFTP Service

View parameters and enable or disable SFTP or FTP service as shown in Figure 12.

10 | Edge Controller Edge Controller | User Guide

 Figure 12 SFTP Service

Option 8: Restart Service(s)

Restart Edge Controller service(s) as shown in Figure 13.

Figure 13 Restart Services

Option 9: Uninstall
Uninstall or remove the Edge Controller services and configuration as shown in Figure 14.

11 | Edge Controller Edge Controller | User Guide

 Warning:

Uninstall or Remove Edge Controller option cannot be undone.

Figure 14 Uninstall Edge Controller

12 | Edge Controller Edge Controller | User Guide

 Managing Edge Controller
This chapter provides details about how Edge Controllers are configured to discover PTP 820/850 devices in a
network using the SNMP protocol. To view the onboarded Edge Controllers in cnMaestro, perform the following
steps:

1. Navigate to Network Services > Edge Controller in the cnMaestro UI.

A list of onboarded Edge Controllers is displayed in a tabular format, as shown in Figure 15.

Figure 15 Edge Controllers

The following parameters are available: Name, IP Address, Status, Version, Duration, and Topology Sync Status.
You can perform the following actions in the Edge Controller page.

l Topology Sync
l Edit
l Delete

Topology Sync
Topology Sync action synchronizes data between cnMaestro and Edge Controller, including discovery rule
configuration and discovered devices.

Click on the TopologySync ( ) icon to run topology synchronization for the selected Edge Controller.

Edit
1. Click Edit ( ) icon, in Edge Controller page.

The Edit name window appears, edit the name of the Edge Controller.

2. Click Save.

Delete
1. Click Delete ( ) icon, in Edge Controller page.

The Please confirm message appears.

13 | Managing Edge Controller Edge Controller | User Guide

 2. Click Yes to delete the Edge Controller.

Edge Controller Management

After selecting an Edge Controller name, you can navigate to the following tabs:

l Dashboard
l Configuration
l Tools
l Monitoring

You will be initially directed to the Edge Controller Dashboard page as shown in Figure 16.

Figure 16 The Edge Controller Dashboard

Dashboard
The Dashboard page displays status of managed and unmanaged PTP 820/850 devices, details of Edge
Controller health, disk space availability, and network settings as shown in Table 2.

Figure 17 Edge Controller and PTP 820/850 devices status

14 | Managing Edge Controller Edge Controller | User Guide

 Table 2: Fields in the Edge Controller Dashboard
Field Description

Host name Name of the host.

Virtualization Type of virtualization such as VMware or Oracle.

Distribution Type of distribution such as Ubuntu versions.

Architecture CPU and Operating System installed.

Number of CPUs Total number of CPUs utilized.

CPU Model Type of CPU model.

Memory Available memory.

Timezone Current time zone.

Date & Time Current date and time.

System Clock Sync Configuration of System Clock Synchronization.

Topology Sync Status of the last topology sync and sync status.

Version Edge Controller version.

Disk Current Disk Space usage.

Status Status of Network Interface Online or Offline.

Name Name of the Network Interface.

IPv4 Address Configured IPv4 Address.

IPv4 Gateway Configured IPv4 Gateway.

IPv6 Address Configured IPv6 Address.

IPv6 Gateway Configured IPv6 Gateway.

MTU Maximum Transmission Unit of network interface of Edge Controller.

License Failures Displays MAC, IP Address, and Failure Reason. The reasons for license
failure are as follows:

l When the discovery exceeds the slot availability.

l When the individual devices are already onboarded in other Cloud
account.

Configuration
In the Configuration page, you need to configure SNMP rules to discover and onboard PTP 820/850 devices.
The SNMP tab in the Configuration page displays Configuration Status. The Configuration Status displays when
the Edge Controller is In Sync or Not Sync with cnMaestro. The synchronization status is shown in days, hours
and minutes. Next discovery and Previous discovery run times are displayed in minutes as shown in Figure 18.

15 | Managing Edge Controller Edge Controller | User Guide

 Figure 18 Configuration Status

Rules
You can create the new SNMP Discovery Rule in two possible ways by clicking Add New or Import.

Add New
To add a new SNMP Discovery Rule, perform the following steps:

1. Click Add New.

The Add New Network Discovery Rule window appears.

2. Type Subnet range in CIDR format (for example, 10.204.88.0/24) to discover PTP 820/850 devices.
The range of IP addresses in the Network Address Range field is displayed.
3. Type Port number.
4. Choose SNMP Version:
For SNMP Version v2c, perform the following:
a. Enter preferred community string when you create an SNMP Discovery Rule.

16 | Managing Edge Controller Edge Controller | User Guide

 b. Click Add.

NOTE:
Default community string is private.

For SNMP Version v3, perform the following:

a. Choosing SNMP v3 version allows you to enter the parameters as shown in the following figure.

b. Enter the following fields:

l Username.
l Context Name field is optional.
c. Choose the Authentication Protocol.
l None
l SHA
l MD5
d. Choose the Privacy Protocol.

17 | Managing Edge Controller Edge Controller | User Guide

 l None
l AES128
l DES
e. Type Privacy Password.
f. Click Add.

SNMP Rules are listed in the Rules table as shown in the following figure.

5. Click Rerun Discovery to start SNMP discovery or select a specific Subnet/Range in the table and manually
run Rerun Discovery ( ) icon.

Import
To import SNMP Discovery Rules, perform the following steps:

1. Click Import.
2. Browse to Select File or Download Sample Template to change or configure SNMP as per the requirements
in Downloaded Sample Template.

3. Click Import.

Export
To export SNMP Rules, perform the following steps:

1. Select one or more SNMP Rules to export.

2. Click Export.

3. It exports .csv file format as shown in the following figure.

18 | Managing Edge Controller Edge Controller | User Guide

 NOTE:
By default all SNMP Rules are exported if no rules are selected from the table.

Delete
To delete SNMP Rules in the table, perform the following steps:

1. Select one or more SNMP Rules in the table.

2. Click Delete to delete one or more entries in the table, or click Delete ( ) icon to delete a specific rule.

Edit
To edit SNMP Rules, perform the following steps:
1. Click Edit ( ) icon to edit SNMP Rule.

Edit the required field values.

2. Click Save.

Blacklist
To blacklist PTP 820/850 devices, perform the following steps:

1. Click Add New.

2. Type IP Address.

19 | Managing Edge Controller Edge Controller | User Guide

 3. Click Save.

Blacklisted IP Addresses are displayed in the table.

4. Select one or more Blacklisted IP Addresses.

5. Click Delete to delete one or more entries in the table, or click Delete ( ) icon to delete specific blacklist
entry in the table.

Advanced Settings
In the Advanced Settings section, configure the following parameters:

NOTE:
l By default, Auto Discovery option is disabled.
l By default, Auto Discovery Interval option is for 24 hours and the fields are auto-filled
when Auto Discovery is enabled.

Enable Auto Discovery if you want to run SNMP discovery rules periodically and perform the following steps:

1. Select Auto Discovery Interval option from the drop-down.

2. Enter Timeout in seconds between 5 to 60 seconds.
3. Enter Retries values between 0 and 3.

4. Click Save.

20 | Managing Edge Controller Edge Controller | User Guide

 Tools
The Tools page allows you to perform the following actions:

l Diagnostics
l Operations
l Services

Diagnostics
The Diagnostics page allows you to generate a technical support dump which can be downloaded and sent to
Cambium Networks support team.

Technical Support Dump

The Technical Support Dump gathers important runtime and configuration information from the Edge
Controller. It can be sent to Cambium Support to aid in resolving issues.

1. Navigate to Edge Controller > Tools > Diagnostics.

2. Click Download under Technical Support Dump.

Figure 19 Diagnostics

Logging Severity
The Logging Severity level of Edge Controller can be used to diagnose issues on the running system. The
logging severity should be set to the default (Information), and it should only be changed under the guidance of
the technical support team.

1. Navigate to Edge Controller > Tools > Diagnostics.

2. In Logging Severity section, select one of the log levels from Log Level drop-down.
l Error
l Information
l Debug

3. Click Save.
4. Click Reset to revert to the previous Log Level option.

21 | Managing Edge Controller Edge Controller | User Guide

 Service Logs
Service Logs allow you to diagnose issues in the services running in the Edge Controller.

1. Select Service and Duration from the drop-down.The duration can be configured for 5 minutes, 15 minutes,
30 minutes, and the last 1 hour.

The following list of service are available from the drop-down:

l Edge Agent
l Core Command
l Core Metadata
l Device SNMP
l MariaDB
l RabbitMQ
l SFTP
2. Click Show Logs.

The output for the selected criteria appears as shown:

3. Click the download ( ) icon to download the generated output.

4. Click the clear ( ) icon to clear the output.

Operations
In the Operations page, you can view the current software version of the Edge Controller. You can also view the
history of the last five software updates.

1. Navigate to Tools > Operations.

2. Click Check for new software update, to determine if update software is available.

22 | Managing Edge Controller Edge Controller | User Guide

 If update is available, the updated version displays.
3. Click Update.
Please confirm window pops up.

4. Click Yes to initiate the update.

If the update is successful, Success window pops up and the History table displays the latest updates.

23 | Managing Edge Controller Edge Controller | User Guide

 Services
In the Services page you can view the services running in the Edge Controller.

Figure 20 Services

Monitoring
In the Monitor page, you can view details of CPU utilization, CPU Load, Process Activity, Memory Usage, Swap
Usage, and File System.

24 | Managing Edge Controller Edge Controller | User Guide

 Cambium Networks
Cambium Networks delivers wireless communications that work for businesses, communities, and cities
worldwide. Millions of our radios are deployed to connect people, places and things with a unified wireless
fabric that spans multiple standards and frequencies of fixed wireless and Wi-Fi, all managed centrally via the
cloud. Our multi-gigabit wireless fabric offers a compelling value proposition over traditional fiber and
alternative wireless solutions. We work with our Cambium certified ConnectedPartners to deliver purpose-built
networks for service provider, enterprise, industrial, and government connectivity solutions in urban, suburban,
and rural environments, with wireless that just works.

User Guides http://www.cambiumnetworks.com/guides

Technical training https://learning.cambiumnetworks.com/learn

Support website (enquiries) https://support.cambiumnetworks.com

Main website http://www.cambiumnetworks.com

Sales enquiries [email protected]

Warranty https://www.cambiumnetworks.com/support/standard-warranty/

Telephone number list http://www.cambiumnetworks.com/contact-us/

Address Cambium Networks Limited,

Unit B2, Linhay Business Park,
Eastern Road,
Ashburton,
Devon, TQ13 7UP
United Kingdom

www.cambiumnetworks.com

Cambium Networks and the stylized circular logo are trademarks of Cambium Networks, Ltd. All other
trademarks are the property of their respective owners.

© Copyright 2022 Cambium Networks, Ltd. All rights reserved.

25 | Edge Controller | User Guide