Cnmaestro On-Premises User Guide 3.0.3
Total Page:16
File Type:pdf, Size:1020Kb
USER GUIDE cnMaestro On-Premises Accuracy While reasonable efforts have been made to assure the accuracy of this document, Cambium Networks assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. Cambium reserves the right to make changes to any products described herein to improve reliability, function, or design, and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Cambium does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others. It is possible that this publication may contain references to, or information about Cambium products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Cambium intends to announce such Cambium products, programming, or services in your country. Copyrights 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. High Risk Materials Cambium and its supplier(s) specifically disclaim any express or implied warranty of fitness for any high-risk activities or uses of its products including, but not limited to, the operation of nuclear facilities, aircraft navigation or aircraft communication systems, air traffic control, life support, or weapons systems (“High Risk Use”). This product is not restricted in the EU. Any High Risk is unauthorized, is made at your own risk and you shall be responsible for any and all losses, damage or claims arising out of any High-Risk Use. © 2021 Cambium Networks Limited. All Rights Reserved Contents Contents 3 Introduction 13 Overview 13 Supported Browsers 15 Supported Virtualization Infrastructures 16 Device Software 17 Software Download 20 Differences with cnMaestro Cloud 20 Quick Start 22 Installation 22 Virtualization 22 Desktop Virtualization 22 Bare Metal Hypervisor 22 cnMaestro Deployment 22 Device Software 32 PMP Configuration Prerequisites 39 DHCP Options (Linux) 40 UI Navigation 44 Basic 44 Account View 44 Access and Backhaul Account 45 Enterprise Account 45 Industrial Internet Account 46 Home Page 46 Page Structure 46 Page Navigation 47 Menu 47 Header 47 Access and Backhaul Account 47 Overview 47 Device Tree Navigation 47 Enterprise Account 53 Overview 53 System 53 Devices 53 AP Groups and WLANs 54 Sites 54 Side Menu 55 Section Tabs 55 System Status 56 Logout 56 Architecture 58 Overview 58 Networking 58 Device Onboarding 60 Overview 60 60 GHz cnWave Onboarding 60 Pre-Configuration and Approval of Devices (Optional) 64 Device/Agent Authentication (Optional) 64 Claiming the Wi-Fi Devices from AP Group 65 Claiming the Wi-Fi Devices from Site Dashboard 66 High Availability (HA) 68 Overview 68 Primary vs Secondary 68 Shared (Floating) IP Address 68 Network Ports 68 Recommendations 69 Dual Interfaces 69 Add eth1 Network Adapter 69 HA Cluster Setup 71 Bootstrap (Primary) 71 Accept (Primary) 71 Join (Secondary) 71 Basic HA Cluster Creation Flow 72 Secondary Server 74 HA Menus 75 High Availability Cluster Menu (pre-Bootstrap) 75 High Availability Menu (post-Bootstrap) 75 New Cluster 76 Accept Join Requests 76 Join Existing Cluster 77 Validate SSH Fingerprints 77 HA Cluster Status 77 Delete Node 79 Leave Cluster 80 Information 80 Behaviour of cnMaestro features When HA is Enabled 80 Monitoring 82 Network Monitoring 82 Dashboard 82 KPI (Key Performance Indicators) 82 Device Health 83 Connection Health 83 Charts and Graphs 84 Notifications 84 Overview 84 Events 85 Alarms 87 Statistics and Details 88 Performance 96 Maps 108 Map Navigation 109 Mode 110 Tools 112 60 GHz cnWave Tools 112 cnMatrix Tools 112 cnPilot Home Tools 114 cnRanger Tools 115 cnReach Tools 116 cnVision Tools 117 Enterprise Wi-Fi Tools 119 ePMP Tools 122 Machfu 125 PMP Tools 126 Tower-to-Edge View 128 WIDS 129 Detecting Rogue APs 129 cnPilot Dashboards 133 Device Dashboard 133 Overview 133 Clients 133 Network Info 136 Mesh Peers 138 Neighbors 138 Site Dashboard 139 Wi-Fi Devices Availability (Total and Offline) 139 Wireless 140 Throughput 140 RF Quality 140 AP Types 140 Top Wi-Fi APs 140 Channel Distribution by Band 141 Radio/WLAN Distribution by Band 141 Clients by SNR 141 Clients by Performance 142 Clients Graph 142 Throughput Graph 142 Statistics 143 Wireless Clients 143 Floor Plan 144 Inventory 145 Inventory Export 145 Bulk Delete 145 Bulk Reboot 146 Schedule Reboot 147 CSV Configuration Import 147 Sample Configuration File 148 Sample Configuration File (60 GHz cnWave) 148 Uploading a Configuration File 149 Reports 152 Generating Reports 152 Device Report 152 Performance Report 157 Active Alarms Report 162 Alarms History Report 162 Events Report 163 Clients Report 163 Mesh Peers Report 164 Remote Upload 165 Report Jobs 166 Provisioning 167 Software Update 167 Software Update Overview 167 Create Software Update Job 168 Software Update 170 Viewing Running Jobs in Header 174 cnReach Bulk Software Upgrade 174 Fixed Wireless Configuration 177 Overview 177 Configuration Templates 177 Configuration Variables 178 Macros 178 Variable Caching 179 Device Type-Specific Configurations 179 Variable Validation 179 Sample Templates 179 Template File Creation 179 Template 179 Configuration Update 181 Device Selection 181 Device Type 181 Device Table 181 Configuration Update Steps 183 Configuration Backup 183 Jobs 187 Configuration Update 187 Wireless LAN Configuration 188 cnPilot Home and Enterprise Wi-Fi 188 Configure cnPilot using cnMaestro 188 Create an AP Group 194 Pre-Defined Overrides 199 User-Defined Overrides (Advanced) 199 User-Defined Variables (Advanced) 199 Synchronize (Sync) Configuration 200 Configuration Job Status 201 Factory Reset 201 Association ACL 203 Overview 203 Configuring Association ACL 203 cnMatrix Switches 204 Switch Groups Configuration 204 Synchronize (Sync) Configuration 210 Policy Based Automation(PBA) 211 Switches 214 Switch Ports 219 Device Details 226 60 GHz cnWave Network Configuration 230 Managing E2E Network 230 Site Configuration 260 Node Configuration 263 PoP Node 271 DN/CN Node 287 Auto-Provisioning 295 Creating Auto-Provisioning Rule 295 Services 297 Managed Service Provider (MSP) 297 Overview 297 Managed Accounts 297 Managed Service 298 Managed Service Provider (MSP) 299 Managed Service Users (Administrators) 300 Configuring Managed Services 301 Enable Managed Service Provider (MSP) 302 Create Managed Services 303 Create Managed Account 305 Validate Managed Account Administrators 306 Managed Services Administration 308 Overview 308 System Dashboard 309 Managed Account Administration 310 Device Management 311 Disabling Managed Service Provider Feature 313 API Client 314 Overview 314 API Clients 314 RESTful API Specification 315 Authentication 315 Swagger API 316 Introduction 316 Sample Swagger UI Screenshot 317 Client ID and Client Secret Generation 317 cnMaestro User Interface 317 API Session 318 Introduction 318 Retrieve Access Token 318 Access Resources 320 API Details 320 HTTP Protocol 320 REST Protocol 321 Parameters 323 Access API 328 Token (basic request) 328 Token (alternate request) 329 Validate Token 330 Selected APIs 331 Overview 331 cnMaestro v2 API 331 Devices API Response (v2 Format) 332 Statistics API Response (v2 Format) 334 Performance API Response (v2 Format) 346 cnPilot Guest Access 354 Configuration 354 Create the Guest Access Portal in cnMaestro 354 Mapping the Device to Guest Access Portal in cnMaestro 364 Access Types 366 Guest Access using Social Login 366 SMS Authentication 377 Generic SMS Gateway Configuration 377 cnPilot GRE Tunnels 384 Overview 384 Typical Deployment Model (Two Port Solution) 384