cnMaestro 1.2.1 On-Premises Beta Guide

Program Name: cnMaestro

DOC NO: Version 1.1

1 Table of Contents

1 Table of Contents ........................................................................................................................... 2 2 Overview ......................................................................................................................................... 3

2.1 Introduction ............................................................................................................................ 3 2.2 Where to Get Help ................................................................................................................. 3 2.3 Device Software ..................................................................................................................... 3

3 Installing cnMaestro On-Premises ................................................................................................. 4 3.1 Overview ................................................................................................................................ 4 3.2 Installing cnMaestro On-Premises ......................................................................................... 4 3.3 Installing cnMaestro 1.2.1 ...................................................................................................... 4

3.3.1 Download the cnMaestro 1.2.1 Software .......................................................................... 4 3.3.2 Navigate to Manage > Server > Operations ...................................................................... 4

4 PMP Support .................................................................................................................................. 5 4.1 Overview ................................................................................................................................ 5 4.2 Supported Features ............................................................................................................... 5 4.3 PMP Device Access .............................................................................................................. 6

4.3.1 Static URL ......................................................................................................................... 6 4.3.2 DHCP Options (Linux) ....................................................................................................... 7

5 Wi-Fi Features ................................................................................................................................ 8 5.1 WiFi Device Support .............................................................................................................. 8 5.2 Profile-Based Configuration ................................................................................................... 8

5.2.1 Configure Wi-Fi using cnMaestro ...................................................................................... 8 5.2.2 Advanced Settings .......................................................................................................... 12 5.2.3 Sync Configuration .......................................................................................................... 12 5.2.4 Override Existing Profile Parameters .............................................................................. 13 5.2.5 Configuration Job Status ................................................................................................. 13

5.3 Site Dashboard .................................................................................................................... 14 5.3.1 Wi-Fi Devices Availability (Total & Offline) ..................................................................... 14 5.3.2 Wireless Clients ............................................................................................................... 14 5.3.3 Throughput ...................................................................................................................... 15 5.3.4 Top 5 AP (Clients / Throughput / Offline APs) ................................................................ 15 5.3.5 Channel Distribution ........................................................................................................ 15 5.3.6 Wireless Clients Graph .................................................................................................... 16 5.3.7 Throughput Graph ........................................................................................................... 16 5.3.8 Wi-Fi Access Points ........................................................................................................ 16 5.3.9 Wireless Clients ............................................................................................................... 17 5.3.10 Floor Plan .................................................................................................................... 18 5.3.11 Accessing the Site Dashboard .................................................................................... 18 5.3.12 Creating the Site Dashboard ....................................................................................... 18

5.4 Guest Access ………………………………………………………………………………………19 5.4.1 Design Guest access using cnMaestro…………………………………………………….19 5.4.2 Free Policy Configuration…………………………………………………………………….19 5.4.3 Voucher Based Configuration……………………………………………………………… 20 5.4.4 Voucher Export………………………………………………………………………………. 21 5.4.5 Splash Page Design…………………………………………………………………………. 21 5.4.6 Client Session Management…………………………………………………………………21 5.4.7 AP Configuration………………………………………………………………………………22 6 Frequently Asked Questions ...................................................................................................... 223

2 Overview

2.1 Introduction

Welcome to cnMaestro 1.2.1 On-Premises Beta! This document provides a brief overview of the new PMP product support and Wi-Fi features. It should be used in tandem with the cnMaestro On-Premises Quick Start Guide to get up-and-running quickly.

2.2 Where to Get Help

If you run into issues, there are a number of ways to get help:

1. Cambium Community: The cnMaestro Beta Forum provides the best place to ask questions and get up-to-date information.

2. cnMaestro On-Premises Quick Start Guide: The Quick Start Guide provides step-by-step instructions to get your On-Premises installation working quickly.

3. cnMaestro On-Premises User Guide: The User Guide provides comprehensive details on all cnMaestro features. It is embedded into the cnMaestro OVA image and can be accessed on the Home Page of the UI.

4. Cambium Support: The Cambium Support team is available 24x7 to answer questions and resolve issues.

2.3 Device Software

cnMaestro On-Premises only works with the latest Cambium device software. You should make sure your Cambium devices support the versions below or later.

Family Model Version

cnPilot

cnPilot R200 4.2.3-R4

cnPilot R200P

cnPilot R201 4.2.3-R4

cnPilot R201P

ePMP 1000 Hotspot ePMP 1000 Hotspot 2.5.2-r3

cnPilot cnPilot E400/E500 2.5.2-r3

ePMP ePMP 1000, Force 180/200 2.6.2

PMP PMP 450i, PMP 450, PMP 430 SM, PTP 450, and PTP 450i

14.2.1 (Build 9)

If you don’t have the minimum software versions, you can download them from Cambium Support Center (http://support.cambiumnetworks.com). Software images are also embedded within cnMaestro On-Premises and can be downloaded to your local computer. The software is located at: Operate > Software Update > Manage Images. Select your device type to display the available images, and

then click the download icon ( ).

Warning

The PMP software version required for this beta is not available on Support Center website. Instead it can be downloaded here:

Download Package for PMP 450i

Download Package for PMP 450

Warning

Device software is included with the virtual machine image; however, it is not updated automatically. New device software needs to be manually added. See the User Guide for more information.

3 Installing cnMaestro On-Premises

3.1 Overview

In order to participate in this beta, you need to install the 1.2.0 version of cnMaestro On-Premises and update it with the cnMaestro beta software. You can access the On-Premises OVA (Open Virtualization Archive) file and the Quick Start Guide in Support Center.

3.2 Installing cnMaestro On-Premises

1. Download cnMaestro 1.2.0 On-Premises Software Package from Support Center. 2. Download cnMaestro 1.2.0 On-Premises Quick Start Guide. 3. Follow the instructions in the Quick Start Guide to install the software on VMware or

VirtualBox.

3.3 Installing cnMaestro 1.2.1

Once you have a running version of cnMaestro 1.2.0, you should execute a package update in order to install the beta software. This can be done through the following steps:

3.3.1 Download the cnMaestro 1.2.1 Software

Download the cnMaestro 1.2.1 Update Package to your hard drive.

3.3.2 Navigate to Manage > Server > Operations

Launch the cnMaestro UI and navigate to the Server Operations page. Within the page, go to Apply cnMaestro Package section and select the package file just downloaded and Apply Update.

The virtual machine will restart in order to complete the update.

Note

It may take a few minutes before you can login to UI after an update.

4 PMP Support

4.1 Overview

Please refer to the cnMaestro On-Premises Quick Start Guide for full information on how to set up and manage cnMaestro On-Premises – including step-by-step instructions for installing the OVA image, launching the CLI, configuring networking, and managing device software.

4.2 Supported Features

PMP devices are fully managed along with the ePMP and Wi-Fi product lines. The features implemented include:

Feature Description

Hierarchical Dashboards Visualize your devices from tower to edge with customized dashboards for each device type.

Advanced Troubleshooting Display tower-to-edge status in a single graphic.

Notifications View immediate status with stateful alarms, and troubleshoot customer issues by filtering on alarm history and reviewing events.

Device Inventory Access your devices at the system level, or by network, tower, or sector. Device data can be exported in PDF or CSV formats.

Statistics and Trending View historical radio and network statistics.

Bulk Image Upgrade Upgrade the software images in a sector or across sectors in a single job. Queue upgrade jobs during the day, so they can be run in the evening, when the network is less utilized.

Template-Based Configuration Push configuration to single devices or to groups of devices across your network using templates.

Maps and Map Modes

Leverage Google Maps satellite view to position your devices and visualize their health and connectivity. Change the map mode to graphically display various wireless key performance indicators.

Zero Touch Onboarding Preconfigure supported Cambium devices so they will be automatically onboarded when provided with network connectivity.

Multiple Administrators Invite colleagues by email to manage devices in your organization’s cnMaestro account.

4.3 PMP Device Access

In order for PMP devices to access cnMaestro On-Premises, they must be configured with the cnMaestro URL. There are currently three ways to do this (listed in priority order):

1. Static URL configured on the device 2. DHCP Option 43 3. DHCP Option 15

4.3.1 Static URL

If a static URL is configured in the PMP UI, the device will always try to connect using it. 4.3.1.1 PMP 4.3.1.1.1 Setting static URL for cnMaestro

4.3.1.1.2 Checking cnMaestro Connection Status

4.3.2 DHCP Options (Linux)

A DHCP Server can be used to configure the IP Address, Gateway, and DNS servers for Cambium devices. If you administer the DHCP Server, you can also configure DHCP Options to instruct devices how to access the cnMaestro (so the URL doesn’t need to be set on each device). Cambium devices support DHCP Options 43 and 15 for setting the cnMaestro On-Premises URL. The priority order for determining the cnMaestro URL is the following:

1. Static URL manually set through the Device UI. 2. DHCP Option 43 3. DHCP Option 15 4. Default Cambium Cloud URL (cloud.cambiumnetworks.com)

4.3.2.1 Using DHCP Option 43 with PMP DHCP Option 43 returns the cnMaestro On-Premises URL as a Vendor-Specific Option. DHCP Option 43 is returned in tandem with DHCP Option 60 (the Vendor Class Identifier, or VCI). The VCI for the individual Cambium products is listed below.

Product VCI (DHCP Option 60)

PMP 450 AP Cambium PMP 450 AP

PMP 450 SM Cambium PMP 450 SM

PMP 450i AP Cambium PMP 450i AP

PMP 450i SM Cambium PMP 450i SM

PMP 430 SM Cambium PMP 430 SM

PTP 450 BHM Cambium PTP 450 BHM

PMP 450 BHS Cambium PTP 450 BHS

PMP 450i BHM Cambium PTP 450i BHM

PTP 450i BHS Cambium PTP 450i BHS

Typically, Option 43 will be the preferred mechanism to configure the cnMaestro URL. Example

configuration for the ISC DHCP Server is presented below (from the /etc/dhcp/dhcpd.conf file). option option-43 code 43 = string;

# PMP Devices

class "Cambium PMP 450 AP" {

match if option vendor-class-identifier = "Cambium PMP 450 AP";

# DHCP server MUST return the device’s Vendor Class back, in the offer.

option vendor-class-identifier "Cambium PMP 450 AP";

# cnMaestro On-Premises IP is 192.168.0.100

option option-43 "https://192.168.0.100";

}

4.3.2.2 Using DHCP Option 15 DHCP Option 15 allows the PMP device to derive the cnMaestro URL from the domain name. For example, if the domain name in DHCP Option 15 is “mycompany.com”, then the device will try to access the cnMaestro server at “cnmaestro.mycompany.com” (essentially the string “cnmaestro” is prepended to the domain). The domain itself, and the IP address of cnMaestro, must be configured in the DNS server for this to work correctly. Sample configuration for the ISC DHCP Server is presented below (from the

/etc/dhcp/dhcpd.conf file).

option domain-name "mycompany.com";

5 Wi-Fi Features

5.1 WiFi Device Support

cnMaestro On-Premises only works with the 3.0 beta version of cnPilot Enterprise AP device software. NOTE: cnPilot R series of access points (R200 and R201) will be supported in a future beta build of cnMaestro 1.2.1 On-Premises. You should make sure your Cambium devices support the versions below or later.

Family Model Version

CnPilot Enterprise AP ePMP1000 Hotspot, cnPilot E400, cnPilot E500

3.0-b20

5.2 Profile-Based Configuration

5.2.1 Configure Wi-Fi using cnMaestro

This section describes how to configure Wi-Fi using cnMaestro. The hierarchy of Wi-Fi device configuration can be represented in the below graphic.

The Wi-Fi device configuration can be done through the following three steps:

1. Create a WLAN and Management Policy

2. Create a Profile and select policies

3. Create a configuration job by selecting list of devices

Devices that supports this feature include: E400, E500, ePMP 1000 Hotspot, cnPilot R200/201 5.2.1.1 Create a WLAN Policy To create WLAN Policy, various parameters need to be updated, including: WLAN, RADIUS, Guest Access, Usage Limits, Scheduled Access, and Access parameters. For cnPilot R200/201 WLAN, the applicable parameters are SSID, Scheduled Access, Access (security related parameters). Steps to create a WLAN policy:

1. From homepage navigate to Configure > Click Policies > Add New WLAN Policy.

2. Add basic parameters to WLAN Policy and save.

5.2.1.2 Create a Management Policy

Management policy contains Access, SNMP, Time Settings, and Event Logging related parameters. Steps to create Management policy

1. Navigate to Configure > Click Policies > Management Tab > Add New Management Policy.

2. Add basic parameters to Management Policy and save.

5.2.1.3 Create a Profile and Select Policies A Profile has to be created in order to apply WLAN and Management policies. Policies are linked to a Profile. The Profile is what is pushed to the device.

1. To create a new Profile, go to Configure > Profiles > Add New Profiles.

2. Map the WLAN and Management policies to the Profile. Multiple WLAN policies can be mapped

for cnPilot E400/E500 and ePMP 1000 Hotspot profiles. Update all parameter related to apply

policies, Radio, Network (VLAN, Routes, Ethernet Ports, Firewall, DHCP) and Advanced

Settings.

Note

A maximum of 16 WLAN policies can be created for E400/E500 and 8 WLAN policies for ePMP 1000 Hotspot.

5.2.1.4 Create a Configuration Job Configuration Jobs can be created from Configure > Configure Wi-Fi; select the list of devices along with the Profile to be pushed. This can be done in three steps:

1. Select the Profile that needs to be pushed.

2. Select the list of Wi-Fi Devices.

3. Click on Apply Configuration.

5.2.2 Advanced Settings

Template settings entered below will be merged into or appended to the profiles. This allows updating configuration setting which are not supported by GUI.

This can be explained with the following example. Mesh configuration is not supported by GUI, if user wishes to configure device with mesh configuration, which can be achieved by passing configuration commands through advanced settings. This will override WLAN configuration that is present on profile.

5.2.3 Sync Configuration

Sync Configuration provides the ability for the user to resync any devices with a mapped profile that is out of sync with a single action rather than updating each device separately. This makes the configuration push a one click job. At any time, the user can go to Configuration Job page to check the sync status. The Sync Configuration page will only display devices that are currently out of sync with a mapped profile. Sync configuration will have following fields:

1. Device (Hostname)

2. Device Type

3. Status (Up/Down)

4. Network (Network in which device is present)

5. Site (Site under which device is present)

6. Profile (Profile to which device is mapped)

7. Sync Status (Sync status will tell whether job is completed or failed)

5.2.3.1 Steps to Perform Sync Configuration:

1. Click the sync configuration button in the top right of the Configure > Policies, Profiles or Configure Wi-Fi screens

2. Select devices you wish to resync 3. Click the Sync Now button on the bottom right of the screen

Note

Sync configuration can only be used if a profile is already mapped to the device.

5.2.4 Override Existing Profile Parameters

The user has the option to override existing parameters in profile for a particular device. Select the device in the Configure Wi-Fi section and choose/change different values from profile for overriding. The icon to the left of a field must be selected first to enable overriding that parameter. After specifying override parameters select Apply Configuration on the bottom right to save your changes to the server and create a job to push the new values to the device. This option is also applicable for Onboarding process queue.

5.2.5 Configuration Job Status

After applying configuration, user can verify the configuration job status by going to configuration job page (Active/Completed jobs). If a device is configured via Configure Wi-Fi page, a configuration job will be created. The Configuration is pushed from Sync configuration page; the configuration job will be created in the background. At any point, the user can view the configuration job status by going to Configuration Jobs. Active Jobs will show current active jobs. Completed Jobs will show Configuration status of jobs that have already executed.

Note

Configuration jobs will be skipped for devices which are offline.

5.3 Site Dashboard

This document discusses the Site Dashboard feature in cnMaestro. Site Dashboard is one stop location for monitoring all Wi-Fi devices in cnMaestro. Site Dashboard mainly focus on the following parameters:

5.3.1 Wi-Fi Devices Availability (Total & Offline)

Displays total number of access points in the Site and the devices that are offline.

5.3.2 Wireless Clients

Displays the total number of clients associated with AP.

5.3.3 Throughput

Displays aggregated throughput for all Clients.

5.3.4 Top 5 AP (Clients / Throughput / Offline APs)

Displays the top 5 AP’s by clients, throughput, offline APs.

5.3.5 Channel Distribution

Channel distribution displays usage of channels in 2.4 & 5 GHz. This helps users in planning and implementing WLAN within a high-density environment.

5.3.6 Wireless Clients Graph

Wireless clients graph displays clients that are connected in 2.4 & 5GHz for last week

5.3.7 Throughput Graph

Throughput graph displays client traffic for the last week

5.3.8 Wi-Fi Access Points

Wi-Fi Access points will focus on parameters like device type, Band, Channel, Transmit Power, Clients connected to AP, Throughput (Uplink & Downlink). User has the option to export Wi-Fi access points grid to PDF/CSV.

5.3.9 Wireless Clients

Wireless Clients will focus on parameters like Client name, IP address, MAC of client, Manufacturer, WLAN to which client is connected, AP to which client is connected. User has the option to export Wireless Clients grid to PDF/CSV.

5.3.10 Floor Plan

Floor Plan is used to locate all AP’s on the map, device status, connected clients, transmit power on the map. This can be done by uploading the map in Manage > Organize > Choose Network > Edit > Upload or floor map can be uploaded when site is created. Placing the AP’s on the floor map is done by clicking full-screen option and then click edit, place the AP’s on the map and save.

5.3.11 Accessing the Site Dashboard

To Access the Site Dashboard, navigate to Monitor > Dashboard > Network > Site Dashboard.

5.3.12 Creating the Site Dashboard

By default, in a network a default site is created. However, if user wish to create a new site, it can be done by navigating to Manage > Organize > Add Site

5.4 Guest Access Configuration

5.4.1 Configure Guest Access using cnMaestro

This section describes how to configure Guest access using cnMaestro. This feature allows creation of vouchers and voucher based access by clients.

This Guest Access feature has following major characteristics:

1. Create multiple plan with different session and expiry time.

2. Free Access for initial duration and then provision of Voucher based access.

3. Rate Limit created plans with Bandwidth parameters.

5.4.2 Free Access Configuration

To provide free access to customer, a free policy has to be enabled in Guest Access Portal. This has three parameters: 1. Session Validity: The Time which a user will get to browse after login. 2. Session Expiration: Total time for a user of session value with addition of inactivity time. 3. Rate Limit: Bandwidth limitation for Users.

Session Expiration is always a higher value than session time. difference of Session expiration and Session validity is the inactivity period for user.

5.4.3 Voucher Based Configuration

Now cnMaestro is capable to generate Vouchers based on user’s requirements and upon entering of this voucher code in redirected splash page, internet access will be given to user. 5.4.3.1 Session and Expiry configuration. Session and expiry of vouchers can be configured in minutes, hours and days.

5.4.3.2 Rate Limit Voucher Plan. When a Voucher gives internet access to user, we can restrict user on Bandwidth usages by these rate limit parameters:

5.4.3.3 Design of Vouchers. Vouchers can be designed with option of editing title, text, color and background image.

5.4.3.4 Generate Vouchers. To generate vouchers, select “Add Vouchers”.

5.4.4 Export Vouchers

Created and designed vouchers can be exported in pdf format and then a print of it will help In distribution of these vouchers among end users.

5.4.5 Splash page design

Splash page can be designed and has flexibility of uploading Logo, background image, text in page, Color selection options.

5.4.6 Session Management

Session management lets view all connected client and information about their session expiry. from this administrator can also disconnect clients forcefully to terminate ongoing sessions.

5.4.7 AP configuration

For Devices it is required that Guest access portal is configured as “cnMaestro” and on portal page Same portal is configured which was created and designed under cnMaestro.

6 Frequently Asked Questions

Question Answer

Can devices on a private subnet be managed?

Yes. Devices contact cnMaestro directly over HTTPS (this is the opposite of SNMP-based managers). This means that as long as the device has a route to cnMaestro, it can be managed.

Can I export my cloud configuration to on-premises?

Please contact Cambium Support if you are interested in exporting from Cloud to On-Premises. This is a manual process that requires coordination with the engineering team to limit management down time.

Can I add my own signed certificate to cnMaestro?

Not yet. We are working on allowing this for Comodo and Verisign certificates. Support for certificates from other vendors, including self-signed certificates, will be even further out.