Académique Documents
Professionnel Documents
Culture Documents
Services Server
Quick Start Guide
Product Overview
Client/Server
Requirements
Installation
Discovery
Upgrading Device
Software
Configuration
Monitoring Devices
CAMBIUM NETWORKS
TABLE OF CONTENTS
2
CAMBIUM NETWORKS
Overview ............................................................................................................................................ 39
Positioning Devices in the Maps View ............................................................................................. 42
Manual Location .............................................................................................................................. 43
CSV Import ...................................................................................................................................... 45
Clearing Events ................................................................................................................................. 49
Importing Cambium Networks Device Support Files ............................................................................................ 52
User Manual ............................................................................................................................................................... 55
3
CAMBIUM NETWORKS
General information
22B Version information
Issue Date of issue Remarks
Feedback
We appreciate feedback from the users of our documents. This includes feedback on the structure, content,
accuracy, or completeness of our documents. Send feedback to cnsserverteam@cambiumnetworks.com.
4
CAMBIUM NETWORKS
Product Description
The Cambium Networks Services (CNS) Server is a network management application provided by Cambium
Networks to manage ePMP devices.
Release 1.3.1 of the CNS Server introduces the following features and enhancements:
Install CNS 1.3.1 on different path: CNS Sever supports 64-bit installations. User can select different
installation path for CNS Server1.3.1.
o Note if users of CNS Server 1.3.1 choose to retain existing data (i.e. discovered devices, historical
performance, etc.) it provides the feature of automatic migration of this database.
o Note if CNS Server 1.3 already running on different path and user select different path (directory
path different than the CNS Server 1.3), in that case data of CNS Server 1.3 won’t be migrated
automatically. User of CNS Server 1.3.1 has to do it manually.
o Note you can’t keep both the version of CNS running on your system. It is recommended to
uninstall previous version or use the same path of previous version.
o Starting with the CNS Server 1.3.1 (official release), 32-bit installations will no longer be
supported.
ePMP 2.6 Support: Full support for the 2.6 firmware. Firmware greater than 2.6 will also be supported, but
new features introduced after 2.0 will not be available.
This document provides a brief introduction and walkthrough of the following CNS Server capabilities:
Each of these sections should be reviewed prior to installing and using the CNS Server. For additional details
please refer to the CNS Server User Manual available from the Documentation link at the bottom of the CNS Server
user interface after installation.
5
CAMBIUM NETWORKS
Client/Server Requirements
Server Hardware
The CNS Server has been run on several different hardware platforms ranging from laptops to multi core servers.
To achieve the scalability levels referenced in the Scalability section below. The following hardware configuration is
recommended:
For the 1.3 release only 64 bit operating systems are supported.
Important: For Linux systems it is necessary to have the dos2unix utility installed prior to installation.
In addition, the host file must be configured properly otherwise the CNS Server will fail to start properly. In
particular, the IP address of the server needs to be present in the host file.
An example of a valid host file is show below:
127.0.0.1 localhost
::1 localhost
10.120.143.1 usil01cnssit01.camnwk.com usil01cnssit01
Firewall/Required Ports
The CNS Server needs the following ports/connections to be available by default. Alternative ports for some of the
items below can be configured during or post installation. Insure that if a firewall is enabled that the configuration is
such that the connections below cab pass traffic in the indicated direction.
80 TCP (HTTP) Both Used for interactions between the user interface and the
server. Also used for some interactions between the server
and devices.
Note that an outbound internet connection is required for the
Maps view to work properly.
161 UDP (SNMP) Outbound Used by the server when communicating with the devices via
SNMP.
6
CAMBIUM NETWORKS
162 UDP (SNMP) Inbound Used when receiving traps from the devices.
443 TCP (HTTPs) Both Used for client/server interactions when HTTPs has been
enabled.
514 UDP Inbound Used when receiving syslog messages from the devices.
(SYSLOG)
Client
The CNS Server user interface runs entirely in a web browser. Development has verified client operations for PCs
on Linux, Windows, and Macintosh operating systems using the following browsers:
At this time, smartphone and tablet based browsers are not fully supported.
Important: Be sure to configure the browser’s security settings to trust the server on which the CNS Server
is running otherwise the user interface will not operate properly.
Scalability
With the hardware specifications above, each CNS Server instance can reliably manage 1000 devices with 5
concurrent users. Additional devices and clients can be supported, however the user interfaces will begin to get
"sluggish" and other degradations may occur. This is also true if the server does not meet the minimum specs
outlined above.
Additional recommendations for scalability:
The "Events Limit" specified in Admin/Monitor may need to be increased to prevent events from getting
automatically deleted. The default is 25000 events.
In cases where greater than 1000 devices are being managed it is strongly recommended to deploy
multiple CNS Server instances.
Security Recommendations
Due to potential security vulnerabilities, if the web interface will be accessible outside of a closed network, it is
recommended that a secure VPN connection be used or that the firewall is configured to only allow only trusted
users to access the server.
The steps below can be used to further configure the CNS Server webserver to “whitelist” or only allow particular IP
addresses access. <server root> refers to the location at which the CNS Server has been installed on the server.
1. Make a backup copy of <server root>/stack/apache2/conf/httpd.conf.
2. Open <server root>/stack/apache2/conf/httpd.conf in a text editor.
7
CAMBIUM NETWORKS
DHCP Support
The CNS Server does not support systems that change the IP addresses of devices dynamically. If a DHCP server
is being used it must be configured such that the same IP address is given to the device (static mapping).
Client Configuration
In order for the client to run properly in certain web browsers it is necessary to add the server on which the CNS
Server is running to the “Trusted Sites List”.
Installation
Installing the Server
Important: the CNS Server must be installed using a login with either Administrator or root level (logged in
as root or run with sudo) permissions.
Once CNS Server 1.3.1 installation executable has been obtained, double click on the installer to launch it. This will
launch a standard installer wizard. Follow the prompts to complete the installation. For Linux systems, the
dos2unix script must be installed otherwise the installation will be unsuccessful. In addition, be sure that the
hostname has been properly configured in the hosts file otherwise some operations will fail to work properly.
The installation typically takes around 5 minutes to complete. Note that it is not unusual for the screens to appear
to be “paused” during the installation process as scripts are being run and services are being configured.
Screenshots of a typical installation are shown below. Note that a console only installation is also available. To run
the console on
8
CAMBIUM NETWORKS
9
CAMBIUM NETWORKS
10
CAMBIUM NETWORKS
11
CAMBIUM NETWORKS
12
CAMBIUM NETWORKS
13
CAMBIUM NETWORKS
14
CAMBIUM NETWORKS
15
CAMBIUM NETWORKS
Backend Startup
During installation three services are installed; an Apache webserver, a Postgres database, and the CNS Server
backend services. These are installed as services in Windows and Linux and can be managed with the command
line services utilities. The installation automatically starts the services after they have been installed.
To confirm the services are running, open a command prompt and type the following commands:
On Linux:
On Windows:
sc query cnsapache
sc query cnspostgresql
sc query cnsserver
If the service is not running it can be started by typing the following commands:
On Linux:
On Windows:
sc start cnsapache
sc start cnspostgresql
sc start cnsserver
16
CAMBIUM NETWORKS
17
CAMBIUM NETWORKS
Figure 17: Admin general page showing Network Facing interface and Device Accessible IP
Address.
18
CAMBIUM NETWORKS
Discovery
At this point, all front and backend services will be initialized and the device discovery process can begin. To do so,
perform the following steps:
1. Start a web browser and enter in the URL of the server to get the login page. For example, if you are on
the server you can type https://localhost (or https://localhost:<port number> if the port is different than 443).
2. Login to the server. The default admin credentials are admin/admin.
3. Select the Discover Service (in green on the application bar), then select Discover Devices (eye icon) from
the left side navigation bar to display the discovery configuration table.
4. Right click on the table and select Add Entry from the right click menu. Enter the IP Address Ranges and
SNMP/Login credentials for the devices to discover. Items in orange have not been saved to the database
yet. Once the save button/right click menu is selected, the items will turn green.
5. Select the rows you wish to discover and then select the start discovery button/right click menu.
Once these steps have been completed, the selected ranges will be probed for devices. A progress bar and
various status results will be displayed on the Discover Devices view. Once discovery is complete, the Inventory
and Discovery Events views should be reviewed to verify that the expected devices were discovered, and to review
any issues found during discovery.
Screenshots for the steps above are shown below.
19
CAMBIUM NETWORKS
20
CAMBIUM NETWORKS
21
CAMBIUM NETWORKS
22
CAMBIUM NETWORKS
23
CAMBIUM NETWORKS
Figure 27: Review discovery related events and address any issues found.
Note that when selecting packages to use with the CNS Server, only the files ending in tar.gz should be used. Files
ending in pkg3 are to be used only for the CNUT application.
Screenshots for the steps above are shown below.
24
CAMBIUM NETWORKS
25
CAMBIUM NETWORKS
Figure 30: Upload packages (packages are downloaded from the Cambium Support website.
26
CAMBIUM NETWORKS
After Apply has been selected, the status of the software upgrade will be shown in the inventory view of the
Upgrade application. Devices will be notified of the upgrade and then they will upload and apply the upgrade, and
then automatically reboot the device. The inventory view will update periodically with the status of the upgrade.
The process of upgrading the devices typically takes a few minutes to complete. When the update is complete all
devices will either be in a “Success (No Software Upgrade Pending)” or “Fail” state.
If failures are seen, review the Upgrade events view for more details on the failure. Also be sure to go back to the
Inventory view and refresh the software versions in case the CNS Server has reported a “false failure”.
27
CAMBIUM NETWORKS
28
CAMBIUM NETWORKS
29
CAMBIUM NETWORKS
Configuring Devices
Overview
When devices are discovered in the CNS server, the current configuration is read and stored on the CNS server.
The configuration can be refreshed at any time by selecting a device (or devices) and clicking “Refresh
Configuration”.
The CNS server supports two ways to ways to configure a device – either directly or through the use of
configuration templates. Configuration templates are used to define a subset of configuration parameters as well as
their values and save them as a template. These configuration templates can then be applied later to either a
single device, or multiple devices of the same type.
The status of any configuration operation can be viewed from the inventory view.
After Apply has been selected, the status of the configuration operation will be shown in the inventory view of the
Configuration application. The device will be notified of the update and will upload and apply the new configuration.
Note that only checked values will be updated. The process of updating the configuration on a device can take a
few minutes to complete. Note that the device will always reboot in response to a configuration operation. When
the update is complete the device will either be in an “Success” or “Failed” state.
If failures are seen, review the Configuration events view for more details on the failure.
Screenshots for the steps above are shown below.
30
CAMBIUM NETWORKS
Figure 37: Select configure and then select the inventory view.
31
CAMBIUM NETWORKS
32
CAMBIUM NETWORKS
Creating Templates
It is important to note that templates are associated with a given device type. It is not possible to create a template
for one device type and apply it to another.
To create and apply a template, perform the following steps.
Templates can also be modified by selecting a template from the table, right clicking, and selecting edit.
Screenshots for the steps above are shown below.
33
CAMBIUM NETWORKS
34
CAMBIUM NETWORKS
35
CAMBIUM NETWORKS
Applying Templates
To apply a previously created template, perform the following steps.
1. From the template view, select the desired template, right click, and select “Apply Template”.
2. A dialog will be shown with a list of applicable devices. Select the desired devices and click apply.
After Apply has been selected, the status of the configuration operation will be shown in the inventory view as it is
with configuring an individual device.
Note that templates can also be applied after selecting a device or multiple devices of the same type in the
inventory view. In this case, after right clicking and selecting “Apply Template” a list of applicable templates will be
shown. After selecting a template and clicking ok, the status will be show in the inventory view.
If failures are seen, review the Configuration events view for more details on the failure.
Screenshots for the steps above are shown below.
36
CAMBIUM NETWORKS
Figure 47: Select a template, right click, and then select Apply Template.
37
CAMBIUM NETWORKS
38
CAMBIUM NETWORKS
Monitoring Devices
Overview
Once devices have been discovered, the CNS Server will begin monitoring the devices. The CNS Server will begin
to periodically check the devices for reachability, download statistics and other important information, and update
various views that display the status of the devices. In addition, if the devices are configured to send traps and
syslog messages to the CNS Server, the CNS Server will interpret these messages and update the status of the
devices accordingly.
The main Monitor views provide system level views of the network. In addition, double clicking rows in the inventory
and events views, as well as clicking on device in the map view, will display a device page. The device page
provides a consolidated view of various performance and status attributes.
Note that in order for the CNS Server to receive traps and syslog messages from the devices, it is necessary to
configure the device to send traps and syslog messages to the CNS server.
Several screenshots of the various views available are shown below.
39
CAMBIUM NETWORKS
40
CAMBIUM NETWORKS
41
CAMBIUM NETWORKS
42
CAMBIUM NETWORKS
MANUAL LOCATION
To manually move devices on the map perform the following steps:
43
CAMBIUM NETWORKS
Figure 60: Select a device, right click, and select Set Location.
44
CAMBIUM NETWORKS
Figure 61: Drag and drop or enter the new latitude/longitude directly.
CSV IMPORT
45
CAMBIUM NETWORKS
To simplify moving devices, the CNS Server can import a CSV file of device IDs, latitudes, and longitudes, It is
important that the device IDs match the EXACT format and case as is shown for the device in the inventory view. In
addition, decimal degrees (WGS84) coordinate format must be used for latitude and longitude.
An example of a CSV file is shown below.
0a:00:3e:a0:00:84,41.9303,-88.1555
0a:00:3e:a0:00:93,41.9292,-88.16
0a:00:3e:a0:01:15,41.9338,-88.1624
0a:00:3e:a0:04:38,41.9338,-88.1624
0a:00:3e:3f:ff:54,41.9515,-88.165
0a:00:3e:3f:fe:ac,41.9509,-88.1709
0a:00:3e:3f:fe:b9,41.9483,-88.1639
To import a CSV file perform the following steps:
46
CAMBIUM NETWORKS
Figure 64: Select Import Latitude/Longitude CSV file and select the file to be imported.
47
CAMBIUM NETWORKS
48
CAMBIUM NETWORKS
Clearing Events
The CNS Server does not automatically clear device alarms. Instead it is necessary to manually clear the alarms.
The CNS Server maintains two views of the events – a currently active events view, and a historic events view. The
historic events view shows all events including inactive or cleared events. To switch between the views select the
desired view from the pull down list at the top right side of the event table.
In some cases newly discovered devices will display in a Minor alarm state in the Monitor views after discovery is
completed. This can typically happen if the CNS Server is unable to discover the latitude and longitude of a device
or if the write community string couldn’t be determined. The events view of the Monitor application should be
reviewed and actions taken to correct the issue.
After the issues have been corrected, the alarms can be cleared by performing the following steps:
49
CAMBIUM NETWORKS
Figure 69: Select events to be cleared, right click, and select Clear Events.
50
CAMBIUM NETWORKS
Figure 71: Minor events no longer in the Current Active Events View.
51
CAMBIUM NETWORKS
Figure 72: Minor events still viewable in the All Events view.
1. Download the CNS file from the Cambium Networks support site.
2. Select the Device Compiler admin screen and then select View Device Definitions.
3. Select the device type to be updated, right click, and then select Delete Device Definition(s) from the menu.
4. Right click and select Import Device Definition from the menu.
5. In the CND File Upload window, select the new CND file and then select Upload CND file.
6. Restart the CNS Server to apply the new settings.
52
CAMBIUM NETWORKS
53
CAMBIUM NETWORKS
Figure 75: Select the device types that will be updated and then delete the definitions. Then,
select Import Device Definitions
Figure 76: Select the new CND file and then select Upload CND File.
54
CAMBIUM NETWORKS
User Manual
The CNS Server contains an online user manual accessible by clicking the Documentation link on the bottom of the
main application page. The user manual is a type of wiki. Clicking on links and entries in the table of contents pane
on the left side will open up the selected item.
A screenshot of the documentation is shown below.
55