| Page | Tabs |
|---|
| System | Dashboard | Notifications | Configuration | Statistics | Report | Software Update | Clients| Map | Mesh Peers |
|---|
| Site | Dashboard | Notifications | Configuration | Statistics | Report | Floor Plan | APs | Clients | WIDS | Mesh Peers System status The UI header has the following System status icons. Table 13: System status icons |
|---|
| Icon | Name Description |
|---|
| Active Software | The number of devices in the onboarding queue that are registered to the |
|---|
| Upgrade Jobs | account but which need to be manually accepted prior to completing their onboarding. |
|---|
| Announcements | If cnMaestro Cloud is synced with the On-Premises announcement notifies the latest Device Software images, Package, or OVA to upload from Cloud. |
|---|
| Cloud Connectivity | It notifies that cnMaestro Cloud is Synced or not with the On-Premises. Status |
|---|
| Critical Alarms | The count of critical alarms currently raised in the system (if no critical alarms are raised, then the major alarm count will be displayed). |
|---|
| Devices Waiting for | The count of jobs in the queue. It includes both running and pending jobs. |
|---|
| Major Alarms | The count of major alarms currently raised in the system. |
|---|
| Out-of-Sync | The number of Wi-Fi devices with unsynchronized configuration (which |
|---|
| Devices | can occur when automatic synchronization is disabled in the AP Group, or the configuration is changed directly on the device). Clicking the icons directs the user to the relevant management page. Logout Log out of cnMaestro by clicking on the user icon in the upper-right corner and selecting Logout. Overview The diagram below presents a simplified view of the cnMaestro architecture. Both devices a |
|---|
| l | 60 GHz cnWave (External Controller) 1.0.1 |
|---|
| Ports | IP Type Details 22 TCP Data Replication 8300 TCP Distributed Synchronization 8301 TCP, UDP Distributed Synchronization Cambium Networks recommends backing up virtual machines prior to starting HA. To take daily automated backups of cnMaestro configuration, navigate to Administration > Server > System Backup and Restore. For larger installations, and to backup statistics, refer section on backing u |
|---|
| Traffic Type | Interface Details |
|---|
| Management/Cluster | eth0 User interface, Cluster, API, outbound traffic to Internet |
|---|
| Device/Control | eth1 Device control traffic A high-level overview of the separation is below: Add eth1 Network Adapter To add eth1, the virtual machine needs to be stopped, and a second Network Adapter added manually. Adding multiple adapters to a virtual machine leads to issues with PCI ordering, which determines how eth0 and eth1 are mapped to the running VM: the PCI ordering does not necessarily follow the ord |
|---|
| Field | Description |
|---|
| Bootstrap | Convert into a standalone HA Cluster. |
|---|
| Join | Join a standalone HA Cluster to create a replication Cluster. |
|---|
| 重設 | Reset HA infrastructure to default. This option is provided as a failsafe. This menu is available after a successful Bootstrap. |
|---|
| Accept | Join requests from the peer nodes. |
|---|
| Log | Log entries of High Availability. |
|---|
| Status | Overall status for the Cluster. New Cluster An HA Cluster requires the eth0 interface be configured with a static IP address. Once the Cluster is created, the IP address cannot be changed without dissolving the Cluster. During the bootstrap process, a shared IP address is configured in the same subnet as eth0. This address floats between the active cnMaestro system, and it should be used for cnMae |
|---|
| Delete | Delete a node from the Cluster. |
|---|
| Failover | Failover to the current Standby node. This is not visible while standalone. |
|---|
| Force/Reset | Forcibly Reset HA configuration. This causes a non-graceful reset of the current node, and it does not delete the node from the Peer. This operation should only be used if the Leave operation fails. |
|---|
| Leave | Leave the Cluster. This deletes all HA configuration and puts the device into a default state. |
|---|
| Configuration | Status of configuration replication. |
|---|
| Files | Status of file system replication (including floor maps, etc.). |
|---|
| Statistics | Status of statistics data replication (this tends to take the longest). |
|---|
| Wi-Fi Sessions | Status of Wi-Fi session replication. NOTE: There may be discrepancy in the Primary and Secondary lag values it may display the results in bytes or seconds. Delete from Cluster Deleting removes the peer node from the cluster. Navigate to Operations > HA, select Delete and click OK. Use the space bar to select the Node and select Delete and click Enter. Deleting a Node Resets the HA configuration of |
|---|
| Feature | Observations |
|---|
| Device | If the fail over happens when Device Approval is In-Progress, then the Device Approval will |
|---|
| Approval from | get struck. You have to re-initiate the Approval All Onboarding Queue If the fail over happens when the Software Update job is In-Progress, then the devices software update will be Timeout after fail over. |
|---|
| Software | Software Update break up Impact after failover Update Jobs |
|---|
| Software update to 50 | 10 devices which were in parallel updated will get impacted. |
|---|
| devices with Devices to | After failover job will get timed out after 5 minutes. You have |
|---|
| update in parallel set as 10 | to retrigger software update for these 10 devices |
|---|
| update in parallel set as 50 | retrigger software update for 50 these devices. If the fail over happens when the Configuration Update is In-Progress, then the configuration update will be Timeout. Configuration |
|---|
| push jobs in | Configuration update to 50 10 devices which were in parallel update will get impacted. |
|---|
| running state | devices with Devices to After fail over job will get Time out after 5 minutes. You have to |
|---|
| update in parallel set to 10 | retrigger Config update for these 10 devices. |
|---|
| Configuration update to 50 | 50 devices which were in parallel update will get impacted. |
|---|
| update in parallel set to 50 | retrigger Config update for these 50 devices. If failover happens when the OVA upgrade is in progress, then you have to re-intiate OVA upgrade |
|---|
| OVA upgrade | Impact after failover |
|---|
| OVA Upgrade | Failover happens during File upload is canceled. You have to retrigger it OVA file upload |
|---|
| Failover happens during 10% | OVA upgrade is canceled You have to retrigger it to 100% OVA upgrade |
|---|
| Failover happens after 100% | File upload is canceled. You have to retrigger it of OVA upgrade and before Apply |
|---|
| 類型 | Description |
|---|
| Alarms | Alarms have state and persist as long as the problematic activity continues; they reflect the current health of the devices in the network. NOTE: After every server reboot or restart, alarm displays as shown below: |
|---|
| Alarm History | Expired Alarms are added to the Alarm History. The Alarm History displays historical active alarm counts. |
|---|
| Events | Events are stateless, transient messages that occur in response to an input or action, such as the CPU exceeds a threshold or a device association fails. Events are fire-and- forget; they are stored in an Event Table and provide a history of device activity. Event/Alarm Source Identity of the source device for the event or alarm. Aggregation Notifications are visible at every level of the device t |
|---|
| Severity | Definition |
|---|
| Critical | Catastrophic problem that makes the product/feature unusable. |
|---|
| Major | Issue that greatly degrades the product/feature, but it is still usable. |
|---|
| Minor | Limited issue that alters product functionality in a targeted way. |
|---|
| Notify | Message used primarily for notification which includes type of reboot of cnPilot Wi-Fi devices. Event Export The event data in a table can be exported in a CSV or PDF file format. Support for System Events The source type can be System, Device, or Client. Events generated by the application will be filtered using the source type System. Figure 19 System Events The following table describes the dif |
|---|
| Event Category | Description |
|---|
| Infrastructure | Events related to infrastructure management – such as HA state, System resources (e.g CPU, Disk, Memory), etc. Source: cnMaestro |
|---|
| Network | Events related to networking issues, such as link up/down. Source: Device |
|---|
| Operations | Events related to system-level processes, such as pushing configuration, installing images, etc. Source: Device |
|---|
| Other | Events unrelated to the above categories. Source: Device |
|---|
| Registration | Events related to managing/unmanaging devices. Source: Device |
|---|
| 安全 | Events related to logging into the devices and establishing secure links. Source: cnMaestro, Device and Client |
|---|
| Services | Events related to additional services added to the product. Source: cnMaestro and Device |
|---|
| Wireless | Events related to issues/notifications with the PTP/PMP radio connectivity, Wi-Fi Clients, etc. Source: Device and Client Alarms Alarm Life Cycle The basic alarm life cycle has the following states: Table 17: Alarm Life Cycle |
|---|
| State | Description |
|---|
| Acknowledged | Active alarms can be acknowledged, which signifies they are known and being handled. Acknowledgment alarms are not included in the total alarm count. |
|---|
| Active | The alarm remains active until the combination of inputs that generated it are cleared. |
|---|
| Expired | Expired Alarms are placed in the Alarm History. |
|---|
| Inactive | Inactive alarms remain visible in the active alarm table for 10 minutes, then they are moved to alarm history. An alarm becomes inactive when the inputs that generated it are no longer present. An Inactive alarm can be pulled back to Active/Acknowledged states if a new event reactivates the alarm. |
|---|
| Raised | The creation of the alarm. Alarm Severity Alarms have a severity that determines how they are handled. Table 18: Alarm Severity |
|---|
| Alarm Type | Definition |
|---|
| DFS State | Tracks issues related to DFS operational status. |
|---|
| GPS State | Tracks issues related to GPS synchronization. |
|---|
| Link State | Tracks issues related to the status of device interfaces. |
|---|
| 升級方式 | Tracks issues encountered during device software upgrade. Alarm Acknowledgment Active alarms can be acknowledged in the alarm table. Acknowledgment makes the alarm less visible in the table, and the administrator can further add a note describing how the alarm is being resolved. Acknowledging an alarm will also remove it from the alarm counts. Figure 20 Alarm Acknowledge Alarm History Expired alar |
|---|
| Device Statistics | Fields 60 GHz cnWave General |
|---|
| Nodes | l Device |
|---|
| cnMatrix | General |
|---|
| cnPilot Home | General |
|---|
| cnRanger BBU | General |
|---|
| cnRanger SM | General |
|---|
| cnReach | General |
|---|
| cnReach XIO | General |
|---|
| cnVision Client | General |
|---|
| cnVision Hub | General |
|---|
| Enterprise WiFi | General |
|---|
| ePMP AP | General |
|---|
| ePMP SM | General |
|---|
| Machfu | Cell |
|---|
| PMP AP | General |
|---|
| PMP SM | General |
|---|
| PTP | General |
|---|
| cnWave | l EIRP (Links) l RSSI |
|---|
| cnRanger | Displays the following graphs: |
|---|
| BBU | l Available Memory |
|---|
| RRH | l Ambient Temperature |
|---|
| cnVision | Displays the following graphs: |
|---|
| 客戶端 | l CPU |
|---|
| Enterprise | Displays the following graphs: |
|---|
| WiFi | l Airtime (2.4 GHz) |
|---|
| PTP and | Displays the following graphs: HCMP |
|---|
| Masters | l Aux Throughput |
|---|
| Action | Description |
|---|
| Double-Click | Double-Click on the following items on the Map, the UI will auto-navigate to the Dashboard of that item: |
|---|
| Hover | Hovering over a tower or device will pop-up a tool tip that provides basic status information. Hovering over an RF link will display status on the link. |
|---|
| Click | Click the following items on the Map, auto-select the same item in the Tree: |
|---|
| Standard Components | In the upper-left corner are generic map navigation components that allow one to zoom in and out. User can also use the mouse to drag and reposition the view as well as turn on satellite display. Mode The map can be placed in a number of different modes for the devices of PMP/ePMP SMs only, which define how the device status is presented. |
|---|
| Mode | Details |
|---|
| Alarm Status | Highlights devices based upon alarm count (Critical, Major, Minor). |
|---|
| Average MCS (ePMP | Displays the Uplink or Downlink average MCS per device. only) |
|---|
| Device Status | Displays whether a device is Up (Green) or Down (Red). |
|---|
| Frequency | Displays the sector frequency. |
|---|
| Link Quality Indicator | Displays the Uplink or Downlink average indicator per device. (PMP only) |
|---|
| Reregistration Count | Displays the nodes based upon the number of reregistrations in the last 24 hours. The more reregistration, the larger the node is displayed. |
|---|
| Retransmission | Displays the percentage of packets retransmitted between ePMP SM and AP on the |
|---|
| Percentage (ePMP only) | wireless link. Embedded Maps Maps are embedded into some additional UI views (most notably, the Dashboard). These embedded maps do not provide the full features of the map view. Sector Visualization cnMaestro is able to present a basic sector View for ePMP and PMP fixed wireless devices. This requires configuration of Height, Azimuth, Elevation and Beam Width under ePMP/PMP AP configuration. This |
|---|
| Network Connectivity | Executes Ping, DNS, or Traceroute tests. |
|---|
| Remote CLI | Remote CLI mode is enabled for Super Administrator and Administrator only. But only Show commands can be executed by the Operator.The user can provide the CLI command in the Command text box. The output will be displayed in the output window. |
|---|
| Tools | Description |
|---|
| Debug | Displays the log details. |
|---|
| Packet Capture | Lists packet capture details. |
|---|
| Wi-Fi Analyzer | Displays radio traffic and signal. |
|---|
| Wi-Fi Performance | Wi-Fi performance measures the backhaul speed across devices with respect to cnMaestro. Figure 26 cnPilot Tools Enterprise WiFi cnRanger Tools cnRanger BBU In Status tab you can view the status of the device either Online or Offline, allows to download Tech Support File and can reboot the device. cnRanger SM In Status tab you can view the status of the device either Online or Offline, allows to do |
|---|
| Ping | Network ping to a hostname or IP address. |
|---|
| RF Ping | RF reachability test between local radios that provides details on signal quality. |
|---|
| RF Throughput | RF throughput test between local radios that provides details on throughput. Figure 28 cnReach Tools The Tools page for cnVision devices consolidates a number of operations into a single troubleshooting interface. The operations are listed below: Table 27: cnVision Tools |
|---|
| Subscriber | Displays the SM linked to the Hub and allows to reboot and download the tech support file. Modules |
|---|
| Link Test | The Link Capacity Test measures the throughput of the RF link between two cnVision modules. cnVision link test only utilizes the spare sector capacity for this test, therefore, sector traffic will not be disrupted. For the most accurate wireless link test results, it is best to run this test when there is no or very little customer data traffic being sent for the duration of the test. Displays the |
|---|
| Flash LEDs (Only for E | The LEDs of the device enables to identify and locate the device. Series Device) |
|---|
| Duration | Represents packet capture running duration in seconds versus maximum duration configured. |
|---|
| Expires In | Expiry time of packet capture. By default the packets captured expires in 24 hours. |
|---|
| Filter | Type of filter option opted by user. |
|---|
| 接口 | The following interfaces supports the packet capture: |
|---|
| Packets | Represents number of packets captured versus maximum limit of packet count configured. |
|---|
| Size | Current packet capture size versus maximum packet capture size configured. |
|---|
| Start Time | Start time of the capture. |
|---|
| eDetect | eDetect is supported on the ePMP AP or SM. It is also launched from the Tools tab. The eDetect tool (not available in ePMP Master/Slave mode) is used to measure the 802.11 interference at the ePMP radio or system when run from the AP or the SM, on the current operating channel. When the tool is run, the ePMP device processes all frames received from devices not connected to the ePMP system and col |
|---|
| Application Name | Name of the application. |
|---|
| Category | Category of the application. |
|---|
| Downlink | Downlink of application data. |
|---|
| Productive Index | Index label for each application to reflect the overall productivity of network users. |
|---|
| Risk Index | Index label for each application to reflect undesirable content onto network. |
|---|
| Total Bytes | Total number of application data in bytes. |
|---|
| Uplink | Uplink of application data. |
|---|
| Usage | Percentage of data usage by application. Performance The Performance tab displays a synchronized view of time-series data which includes parameters for client's connection health, application usage. |
|---|
| n | Type |
|---|
| Error | Description |
|---|
| Error1: | This error is displayed if the uploaded CSV file contains invalid MAC Address. Error: {Count of Devices} Device(s) with invalid MAC |
|---|
| Error2: | This error is displayed if the uploaded CSV file contains invalid Data or data not relevant |
|---|
| {Count of Devices} | for Latitude, Longitude, Azimuth, Height and Elevation. Device(s) skipped due to invalid data |
|---|
| Error3: | This error message is displayed if the devices were not found with supplied MAC address |
|---|
| Devices were not | in the CSV file. found for supplied MAC Address |
|---|
| Error4: | This error is displayed when the latitude and longitude values are tried to push on to |
|---|
| Info: 1 Devices(s) | ePMP AP or PMP AP which are under a Tower. accepted without latitude/longitude values This section provides details on how to schedule and generate different types of data reports in cnMaestro On- Premises. |
|---|
| Parameter | Description |
|---|
| Current Version | The version of the active software image running on the device. |
|---|
| Selected SMs | If the AP is selected, the corresponding SMs will also be selected. |
|---|
| i. | Enterprise Wi-Fi (XV-Series) |
|---|
| j. | ePMP (Sectors) k. Machfu |
|---|
| l. | PMP (Sectors) m. PTP 4. Select the software image to update from the Select Image Version drop-down list. 5. Select the devices to update by clicking the tick icon. 6. Set desired Job Options. 7. Click Add Software Job button. Software Update Parameters The Software Update Jobs table lists all currently running, queued, and completed jobs. The jobs can be triggered immediately or can be run later. |
|---|
| Created By | The user who has created this job. |
|---|
| Created On | Date and time on which the job is created. |
|---|
| Completed On | Date and time on which the job is |
|---|
| Details | Count of devices and date and time the upgrade process is initiated. |
|---|
| ID | Identification number of the active job. |
|---|
| Image Type | Displays the type of image selected for the device. |
|---|
| Occurrence | Displays the occurrence of the update like now, scheduled, etc. |
|---|
| Target | Target software version to upgrade. |
|---|
| Managed Account | Displays the Managed Account Name. The user can filter the jobs based on the running status. The user can also filter the devices in a particular job based on the parameters mentioned in the above table. Abort Software Job Abort operation will skip devices that are waiting for update to begin. Devices already being updated may continue, but cnMaestro will stop tracking their progress. Aborting a S |
|---|
| Click the | icon at the top right corner of the UI. This directs you to the Jobs page of the Software Update tab. For more information, see Software Update Parameters. cnReach Bulk Software Upgrade Distributing software to cnReach devices can take many hours, due to the relatively low RF bandwidth. In order to minimize wireless traffic, cnMaestro supports the cnReach mechanism by which a single AP coordinates |
|---|
| Network/Tower | The network and the tower on which the device is located. |
|---|
| Parallel | Number of device to start in parallel. |
|---|
| Stop on Error | Stop the job, if any device in middle finds any error. |
|---|
| Sector Priority | For ePMP/PMP, cnVision Client/Hub, the priority of AP/SM to start. |
|---|
| Message | The message displayed after the update. |
|---|
| Result | The upgrade status of the device. |
|---|
| User can click | on top bar to include additional fields in Ports General Detail view. 2. Navigates to Switch Groups > Switches > Port Configuration. 3. Enter the Tags and Description details. 4. Click Save. Physical Tab The Ports Physical details view displays following fields by default: |
|---|
| To view Dashboard of E2E Network click | next to E2E Network in the right pane as shown below. You will be directed to the 60 GHz cnWave Network Dashboard as shown below. |
|---|
| To view Dashboard of Site click | next to Site in the right panel as shown below. You will be directed to the 60 GHz cnWave Site Dashboard as shown below. |
|---|
| To view Dashboard of Device click | next to Device in the right pane as shown below. Tools In Tools page it allows the user to perform the following actions: |
|---|
| Select the Site click | select Add Node. To Add a Node, perform the following steps: 1. Navigate to the Network > Site > Nodes. Adding the Node allows the user to create the different Nodes as shown below: |
|---|
| Support | Details |
|---|
| Administrator | Each Managed Service has its own independent database of users who can be assigned |
|---|
| Database | to multiple Managed Accounts. |
|---|
| Custom Login URL | The path of the Login URL used by Managed Service Administration can be tailored to represent the Managed Service. The path must be unique across all cnMaestro. |
|---|
| Managed Account UI | The Managed Account UI is customized for the Managed Service through graphics, colors, and text. Managed Account UI The Managed Account UI can be customized to represent the brand. A sample Managed Account UI is shown below: Figure 123 Managed Account UI - Sample 1 Figure 124 Managed Account UI - Sample 2 Managed Service Provider (MSP) The MSP feature combines Managed Accounts with Managed Service |
|---|
| AAA Services | Add AAA services None None None (Global cnMaestro Administrator only) |
|---|
| Administration | Change global None None None |
|---|
| Settings | application configuration, (Global cnMaestro onboarding |
|---|
| Administrator only) | settings like password change |
|---|
| API Management | Create API Clients None None None (Global cnMaestro Administrator only) |
|---|
| Application | Networks, Tower, All All View |
|---|
| Operations 1 | and Site creation |
|---|
| Operations 2 | import/export server data, account type change (backhaul and Wi-Fi) |
|---|
| Association ACL | Configure MAC list All View None on the controller |
|---|
| Auto-Provisioning | Support for global None None None auto-provisioning (Global cnMaestro rules |
|---|
| Audit logs | Log administration All All All updates |
|---|
| Data Tunnel | Data Tunnel None None None configuration (Global cnMaestro Administrator only) |
|---|
| Device Operations | Reboot device, All All None Link Test, Connectivity Test |
|---|
| Device Override | Per-device All All View configuration changes |
|---|
| Global Configuration | Templates and AP All View View Groups; ability to apply configuration |
|---|
| Guest Portal | Guest Access All View View (Sessions) |
|---|
| Monitoring | Statistics data from All All View device |
|---|
| Notifications | Alarms and Events All All View |
|---|
| Onboarding | Device approval All All View |
|---|
| Reporting | Report generation All All All view |
|---|
| Software Images | Download device All None None software images (Global cnMaestro Administrator only) |
|---|
| System Operations | Reboot VM, change None None None log level, system |
|---|
| upgrade, system | (Except System (Except System (Except System |
|---|
| monitoring | Monitoring) Monitoring) Monitoring) |
|---|
| Software Upgrade | Upgrade device All All View |
|---|
| User Management | Manage users, All None None roles, sessions This section provides the following configuration details for Managed Services: |
|---|
| Name | Name of the service. This name is visible to Managed Account Administrators. A maximum of 64 characters are supported for the name. |
|---|
| Login Path | Managed Account Administrators log into cnMaestro using a standard URL with an additional Path that defines the Managed Service. For example: https:///msp/ Note: |
|---|
| Friendly Name | The Friendly Name will be sent in the invitation email. |
|---|
| Managed Service | The Managed Service used for Managed Account Administrator. |
|---|
| Email | The email address of the first Managed Account Administrator. You can add more Users after the account has been created. |
|---|
| Role | The role of the Managed Account Administrator (Administrator, Operator, Monitor). 4. Click Add. NOTE: Users are allowed to edit the existing name of the Managed Account before validating the account. Validate Managed Account Administrators Once a Managed Account is created, the Managed Account Administrator is sent an email invitation. The email provides directions on how to access the Managed Acc |
|---|
| Base Infrastructure | The object is only available for the Global account. |
|---|
| Shared | The object is shared among all Managed Accounts. It can be mapped to devices in the Managed Account, but it cannot be modified. To change the configuration, it needs to be copied into the Managed Account and then update. Once the scope has been configured on an object it cannot be changed. Device Management Devices are added at the global System level or within Managed Accounts. Devices added at t |
|---|
| invalid_request | Required parameter is missing from the request. |
|---|
| invalid_client | Client authentication failed. |
|---|
| unauthorized_client | The client is not authorized to use the grant type sent. |
|---|
| unsupported_grant_type | The grant type is not supported. An example error response is below: HTTP/1.1 400 Bad Request Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache "error": "invalid_request" Once the access_token is retrieved, API requests are sent to cnMaestro server using the format below. The access_ token is sent within the HTTP Authorization header. GET /api/v2/devices Accept: |
|---|
| Code | Description Use in cnMaestro 400 Bad Request Status field in request validation related errors. 502 Bad Gateway Internal server error that may require a reboot. 403 Forbidden An authenticated user tries to access a non-permitted resource. 500 Internal Server Error A server-side error happened during processing the request. 405 Method Not Allowed A method (GET, PUT, POST) is not supported for the r |
|---|
| Header | Details |
|---|
| Authorization | Used in every API request to send the Access Token. Example: Authorization: Bearer |
|---|
| Content-Type | Set to application/json REST Protocol Resource URLs The format for cnMaestro path and parameters are the following: Access a collection of resources: /api/{version}/{resource}?{parameter}={value}&{parameter}={value} Access a single resource: /api/{version}/{resource}/{resource_id}?{parameter}={value}&{parameter}={value} Access a sub-resource on a collection (this is also possible on single resourc |
|---|
| Context | Details |
|---|
| alarms | Current active alarms. |
|---|
| alarms/history | Historical alarms, including active alarms. |
|---|
| devices | Devices, including ePMP, PMP, and WiFi. |
|---|
| events | Historical events. |
|---|
| msp | MSP managed services. |
|---|
| networks | Configured networks. |
|---|
| sites | Configured WiFi sites. |
|---|
| towers | Configured Fixed Wireless towers. Sub-Resources Sub-Resources apply to top-level resources. They provide a different view of the resource data, or a filtered collection based upon the resource. They include: |
|---|
| clients | Wireless LAN clients mapped to the top-level resource. |
|---|
| mesh/peers | Wireless LAN mesh peers mapped to the top-level resource. |
|---|
| operations | Operations available to the top-level resource |
|---|
| performance | Performance data for the top-level resource. |
|---|
| statistics | Statistics for the top-level resource. Responses Successful Response In a successful HTTP 200 response, data is returned using the following structure. The actual payload is presented in JSON format. The request URL is: /api/v2/devices?fields=mac,type&limit=5 "paging": { "offset": 0, "limit": 5, "total": 540 "data": [ "mac": "C1:00:0C:00:00:21", "type": "wifi-home" "mac": "C1:00:0C:00:00:18", "typ |
|---|
| fields | Define exactly what fields should be returned in a request. The names are provided as a comma- separated list. Fields can limit which JSON parameters are returned. Example: To retrieve name, type and location information for all devices. Request: /api/v2/devices?fields=mac,type Response: "paging": { "total": 3, "limit": 100, "offset": 0 "data": [ "mac": "00:44:E6:34:89:48", "type": "wifi-enterpris |
|---|
| network | (Devices) Configured Network name. |
|---|
| severity | (Alarms, Events) Alarm or Event severity (critical, major, minor, notice). |
|---|
| site | (Devices) Configured Site name. |
|---|
| state | (Alarms) Alarm state (active, cleared). |
|---|
| status | (Devices) Device status [online, offline, onboarding] |
|---|
| tower | (Devices) Configured Tower name. |
|---|
| start_time | Inclusive start time of interval. |
|---|
| stop_time | Inclusive stop time of interval. Sorting Sorting is supported on a selected subset of fields within certain requests. sort is used to specify sorting columns. The sort order is ascending unless the path name is prefixed with a ‘-‘, in which case it would be descending. |
|---|
| sort | Used to get the records in the order of the given attribute. Example: To retrieve devices in sorted (ascending) order by name. Request: /api/v2/devices?sort=name Example: To retrieve devices in sorted (descending) order by mac. Request: /api/v2/devices?sort=-mac Pagination The limit and offset query parameters are used to paginate responses. |
|---|
| limit | Maximum number of records to be returned from the server. |
|---|
| offset | Starting index to retrieve the data. Request: /api/v2/devices?offset=3&limit=1 Response: "paging": { "total": 6, "limit": 1, "offset": 3 "data": [ "status": "online", "product": "cnPilot E400", "network": "Mumbai", "software_version": "3.3-b14", "registration_date": "2017-04-28T08:57:33+00:00", "site": "Central", "hardware_version": "Force 200", "status_time": "3498", "msn": "Z834275ABCDH", "mac": |
|---|
| total | Total number of records that can be retrieved. Access API Token (basic request) POST /api/v2/access/token The access API generates token using the Client ID and Client Password created in the cnMaestro UI. The token can be leveraged for API calls through the expiration time. Only one token is supported for each Client ID at any given time. Request Headers |
|---|
| Accept (optional) | application/json |
|---|
| access_token | Access token to return with each API request. |
|---|
| expires_in | Time in seconds that the API session will remain active. |
|---|
| token_type | This will always be bearer. "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"bearer", "expires_in":3600 Example Request curl https://10.110.134.12/api/v2/access/token \ -X POST -k \ -u 8YKCxq72qpjnYmXQ:pcX5BmdJ2f4QLM5RfgsS4jOtxAdTRF \ -d grant_type=client_credentials Response {"access_token":"d587538f445d30eb2d48e1b7f7a6c9657d32068e","token_type":" bearer","expires_in":86400} Token (alternat |
|---|
| Wi- | cnReac cnVisio cnMatri 60 GHz |
|---|
| Fi | h n x cnWave |
|---|
| ap_group | AP Group X |
|---|
| cbrs_state | CBRS state X |
|---|
| cbrs_status | CBRS status X |
|---|
| config.sync_ | Configuration X |
|---|
| reason | synchronization X X X X X X reason |
|---|
| config.variabl | Device is X |
|---|
| es | mapped to |
|---|
| X | X X X X X configuration variables |
|---|
| config.version | Current X |
|---|
| configuration | X X X X X X version |
|---|
| country | Country X X X X |
|---|
| country_code | Regulatory band |
|---|
| description | Description X X X X X X X X |
|---|
| hardware_ | Hardware X |
|---|
| version | version |
|---|
| inactive_ | Inactive X |
|---|
| software_ | software X X X X X X |
|---|
| ip | IP address X X X X X X X X |
|---|
| ipv6 | IPv6 X X X X |
|---|
| last_reboot_ | Reason for the X |
|---|
| link_ | Link symmetry symmetry |
|---|
| location | Location X X X X X X X X |
|---|
| mac | MAC address X X X X X X X X |
|---|
| managed_ | Managed X |
|---|
| account | account name |
|---|
| maximum_ | Maximum range X |
|---|
| range | (KM) |
|---|
| msn | Manufacturer X |
|---|
| name | Device name X X X X X X X X |
|---|
| product | Product name X X X X X X X X |
|---|
| registration_ | Registration X |
|---|
| date | date |
|---|
| role | X |
|---|
| site_id | Site unique |
|---|
| offline, | X X X X X X X onboarding) |
|---|
| status_time | Uptime/downti X |
|---|
| me time interval | X X X X X X X (sec) |
|---|
| enterprise, | X X X X X X X cnreach, ptp, cnmatrix, 60ghz-cnwave) Statistics API Response (v2 format) Statistics API Response v2 format are shown for the following devices: |
|---|
| cpu | CPU utilization All |
|---|
| last_sync | Last synchronization (UTC Unix time milliseconds) All |
|---|
| managed_account | Managed account name All |
|---|
| memory | Available memory All |
|---|
| mode | Device mode All |
|---|
| sync_mode | Radio Sync mode [RF, GPS, None] All |
|---|
| radios[].channel | Channel All |
|---|
| radios[].id | Radio Id All |
|---|
| radios[].mac | Radio MAC All |
|---|
| radios[].rx_bps | Receive bits/second All |
|---|
| radios[].tx_bps | Transmit bits/second All |
|---|
| radios[].sync_mode | Radio Sync mode [RF, GPS, None] All Ethernet Ports (Array format) |
|---|
| ethports[].port | Port name All |
|---|
| ethports[].rx_pkts | Received packets All |
|---|
| ethports[].tx_pkts | Transmitted packets All |
|---|
| ethports[].speed | Port speed and duplex All |
|---|
| config_version | Configuration version |
|---|
| connected_sms | Connected SM count All |
|---|
| radios[].device_id | Device ID Radios |
|---|
| radios[].linked_with | Linked with Radios |
|---|
| radios[].margin | Margin Radios |
|---|
| radios[].mode | Radio mode [ap, ep, rep] Radios |
|---|
| radios[].neighbors | Radio neighbors Radios |
|---|
| radios[].network_address | Network address Radios |
|---|
| radios[].noise | Average noise (dB) Radios |
|---|
| radios[].power | Transmit power Radios |
|---|
| radios[].rssi | RSSI value (dB) Radios |
|---|
| radios[].rx_bytes | Receive bytes Radios |
|---|
| radios[].software_version | Current software version Radios |
|---|
| radios[].temperature | Radio temperature Radios |
|---|
| radios[].type | Radio type [ptp, ptmp] Radios |
|---|
| radios[].tx_bytes | Transmit bytes Radios Fixed Wireless (ePMP and PMP) |
|---|
| ap_mac | AP MAC SM SM |
|---|
| distance | SM distance (KM) SM SM |
|---|
| gain | Antenna gain (dBi) AP/SM AP/SM |
|---|
| gps_sync_state | GPS synchronization state AP/SM |
|---|
| reboots | Reboot count AP/SM |
|---|
| temperature | Temperature AP/SM |
|---|
| vlan | VLAN AP/SM Networks |
|---|
| default_gateway | Default gateway AP/SM AP/SM |
|---|
| ip_dns | DNS AP/SM AP/SM |
|---|
| ip_dns_secondary | Secondary DNS AP/SM |
|---|
| ip_wan | WAN IP AP/SM |
|---|
| lan_mode_status | LAN mode status [no-data, half, full] AP/SM |
|---|
| lan_mtu | MTU size SM |
|---|
| lan_speed_status | LAN speed status AP/SM |
|---|
| lan_status | LAN status [down, up] AP/SM AP/SM |
|---|
| netmask | Network mask AP/SM AP/SM |
|---|
| radio.auth_mode | Authentication mode SM |
|---|
| radio.auth_type | Authentication type ePMP [open, wpa1, eap- ttls] AP/SM AP/SM PMP [disabled, enabled] |
|---|
| radio.channel_width | Channel width ePMP [5 MHz, 10 MHz, 20 MHz, 40 AP/SM AP/SM MHz] PMP […] |
|---|
| radio.color_code | Color code AP/SM |
|---|
| radio.dfs_status | DFS status ePMP: AP/SM AP/SM [not-applicable, channel- availability-check, in- service, radar- signal-detected, alternate- channel- monitoring, not-in- service] PMP: [Status String] |
|---|
| radio.dl_err_drop_pkts | Downlink error drop packets SM |
|---|
| radio.dl_err_drop_pkts_ | Downlink error drop packets percentage SM percentage |
|---|
| radio.dl_frame_utilization | Downlink frame utilization AP |
|---|
| radio.dl_lqi | Downlink Link Quality Indicator SM |
|---|
| radio.dl_mcs | Downlink MCS SM |
|---|
| radio.dl_modulation | Downlink Modulation SM |
|---|
| radio.dl_pkts | Downlink packet count AP/SM AP/SM |
|---|
| radio.dl_pkts_loss | Downlink packet loss AP/SM |
|---|
| radio.dl_retransmits | Downlink Retransmission AP/SM |
|---|
| radio.dl_retransmits_pct | Downlink Retransmission percentage AP/SM |
|---|
| radio.dl_rssi | Downlink RSSI SM SM |
|---|
| radio.dl_rssi_imbalance | Downlink RSSI imbalance AP |
|---|
| radio.dl_snr | Downlink SNR (dB) SM |
|---|
| radio.dl_snr_h | Downlink SNR (dB) horizontal SM |
|---|
| radio.dl_snr_v | Downlink SNR (dB) vertical SM |
|---|
| radio.dl_throughput | Downlink throughput AP/SM AP/SM |
|---|
| radio.frequency | RF frequency AP/SM AP/SM |
|---|
| radio.frame_period | Frame period AP |
|---|
| radio.mac | Wireless MAC AP/SM |
|---|
| radio.mode | Radio mode [eptp-master, eptp- slave, tdd, tdd-ptp, ap/sm] AP/SM |
|---|
| radio.sessions_dropped | Session drops AP AP/SM |
|---|
| radio.software_key_throughput | Software key – max throughput SM |
|---|
| radio.ssid | SSID AP/SM |
|---|
| radio.sync_source | Synchronization source AP |
|---|
| radio.sync_state | Synchronization state AP |
|---|
| radio.tdd_ratio | TDD ratio ePMP [75/25, 50/50, 30/70, flexible] AP AP PMP […] |
|---|
| radio.tx_capacity | SM transmit capacity SM |
|---|
| radio.tx_power | Radio transmit power AP/SM AP/SM |
|---|
| radio.tx_quality | SM transmit quality SM |
|---|
| radio.ul_err_drop_pkts | Uplink error drop packets SM |
|---|
| radio.ul_err_drop_pkts_ | Uplink error drop packets percentage SM percentage |
|---|
| radio.ul_frame_utilization | Uplink frame utilization AP |
|---|
| radio.ul_mcs | Uplink MCS AP/SM |
|---|
| radio.ul_modulation | Uplink Modulation example [2X MIMO-B)] SM |
|---|
| radio.ul_lqi | Uplink Link Quality Indicator SM |
|---|
| radio.ul_pkts | Uplink packet count AP/SM AP/SM |
|---|
| radio.ul_pkts_loss | Uplink packet loss AP/SM |
|---|
| radio.ul_retransmits | Uplink Retransmission SM |
|---|
| radio.ul_retransmits_pct | Uplink Retransmission percentage AP/SM |
|---|
| radio.ul_rssi | Uplink RSSI SM SM |
|---|
| radio.ul_snr | Uplink SNR (dB) SM |
|---|
| radio.ul_snr_h | Uplink SNR (dB) horizontal SM |
|---|
| radio.ul_snr_v | Uplink SNR (dB) vertical SM |
|---|
| radio.ul_throughput | Uplink throughput AP/SM AP/SM |
|---|
| radio.wlan_status | WLAN status [down, up] AP/SM PTP |
|---|
| ethports[].rx_frames | Ports receive frames oversize All |
|---|
| ethports[].rx_util | Ports receive bandwidth utiliization All |
|---|
| ethports[].tx_util | Ports transmit bandwidth utiliization All Radios |
|---|
| radio.byte_error_ratio | Byte Error Ratio All |
|---|
| radio.rx_frequency | Receive frequency All |
|---|
| radio.tx_frequency | Transmit frequency All |
|---|
| parent_mac | Parent MAC All |
|---|
| radios[].airtime | Airtime All |
|---|
| radios[].band | Radio band All |
|---|
| radios[].bssid | Radio mac Enterprise |
|---|
| radios[].multicast_rate | Multicast rate Enterprise |
|---|
| radios[].noise_floor | Noise floor Enterprise |
|---|
| radios[].num_clients | Number of clients All |
|---|
| radios[].num_wlans | Number of WLANs Enterprise |
|---|
| radios[].quality | RF Quality description Enterprise |
|---|
| radios[].radio_state | Radio state Enterprise |
|---|
| radios[].unicast_rates | Unicast rates Enterprise |
|---|
| radios[].utilization | Radio utilization Enterprise Performance API Response v2 Format are shown for following devices: |
|---|
| online_duration | Duration of device connection with server (seconds) All |
|---|
| timestamp | Timestamp All |
|---|
| uptime | Device online time (seconds) All Radios (Array format) |
|---|
| ethports[].max_rx | Ports maximum receive bytes All |
|---|
| ethports[].max_tx | Ports maximum transmit bytes All |
|---|
| ethports[].min_rx | Ports minimum receive bytes All |
|---|
| ethports[].min_tx | Ports minimum transmit bytes All |
|---|
| ethports[].rx | Ports receive bytes All |
|---|
| ethports[].tx | Ports transmit bytes All cnMatrix |
|---|
| switch.rx.broadcast_pkts | Receive broadcast packets |
|---|
| switch.dl_kbits | Downlink usage (in kbits on hour or minute basis) |
|---|
| switch.dl_throughput | Downlink throughput (Kbps) |
|---|
| switch.ul_kbits | Uplink (in Kbits on hour or minute basis) |
|---|
| switch.rx.multicast_pkts | Receive multicast packets |
|---|
| switch.ul_throughput | Uplink throughput (Kbps) |
|---|
| switch.rx.pkts_err | Receive Packet error |
|---|
| switch.rx.unicast_pkts | Receive unicast packets |
|---|
| switch.tx.broadcast_pkts | Transmit broadcast packets |
|---|
| switch.tx.multicast_pkts | Transmit multicast packets |
|---|
| switch.tx.pkts_err | Transmit packet error |
|---|
| switch.tx.unicast_pkts | Transmit unicast packets cnReach |
|---|
| sm_count | Connected SM count All |
|---|
| radios[].throughput | Total throughput Radios |
|---|
| sm_drops | Session drops AP/SM AP |
|---|
| radio.dl_kbits | Downlink usage (in Kbits on AP/SM hour or minute basis) |
|---|
| radio.ul.kbits | Uplink usage (in Kbits on hour AP/SM or minute basis) |
|---|
| ethports[].pkt_error | Ports packet error All |
|---|
| ethernet.link_loss | Link loss All |
|---|
| ethernet.pcb_ | PCB temperature All temperature |
|---|
| ethernet.rx_channel_util | Receive channel utilization All |
|---|
| ethernet.rx_capacity | Receive capacity All |
|---|
| ethernet.ssr | Signal strength ratio All |
|---|
| ethernet.rx_power | Receive power All |
|---|
| ethernet.sfp_interface.tx | SFP transmit bytes All |
|---|
| ethernet.rx_throughput | Receive throughput All |
|---|
| ethernet.tx_channel_util | Transmit channel utilization All |
|---|
| ethernet.tx_capacity | Transmit capacity All |
|---|
| ethernet.tx_power | Transmit power All |
|---|
| ethernet.tx_throughput | Transmit throughput All |
|---|
| ethernet.vector_error | Vector error All Wi-Fi |
|---|
| radios[].clients | Number of clients All |
|---|
| prefixQs | True: Add query strings to landing URL on success. False: Remove query strings from landing URL on success. prefixQs and action values are driven based on WLAN configuration. |
|---|
| action | 0: On success action redirects the user to AP onboard logout page. 1: On success redirects user to an external URL. 2: On success redirects user to its original URL. |
|---|
| msg | Message is based on RADIUS attribute reply message (18) in the RADIUS Access Accept or Reject message. |
|---|
| expiry | Displays the session time for the given guest session. |
|---|
| cmac | MAC address of the client. cnMaestro supports configuration overrides for 60 GHz cnWave E2E Network, E2E Controller, and Node(s) using the RESTful API. E2E Network To determine the configuration parameters available in an E2E Network, navigate to E2E Network > Configuration > Advanced. Search for the desired Field, and review its Description, allowed Values, and Override status. Use the RESTful AP |
|---|
| Add Whitelist | It contains options for configuring the IP address or the domain name. |
|---|
| Client Rate Limit | It contains options for configuring downlink and uplink parameters in kbps to limit the data transfer rate to or from the client. If a client rate limit parameter is blank, no limits are applied. |
|---|
| Client Quota Limit | The data quota limit feature has been added for RADIUS-based as well as for controller- based guest portals. For controller-based, it is either directional or total data quota limit. Once the client logins as a guest, the data quota limit is enforced and the values are sent to the accent point to which the client is connected. The access point keeps track of the data limits Access Point also sends |
|---|
| Renewable | Once the session duration for the client expires, the client needs to wait for the period |
|---|
| Session Duration | The duration for which the client is provided access. |
|---|
| Social Login | Consists of the following options: l Domain URL: The redirected URL in client when trying to access the Internet. l Google: Consists of ID and Secret options to configure, which admin can create from https://console.developers.google.com/iam-admin/projects l Facebook: Consists of ID and Secret options to configure, which admin can create from https://developers.facebook.com/apps/ l Twitter: Consis |
|---|
| SMS Authentication | SMS OTP supports Twilio, SMS Country, and SMS Gupshup SMS gateway providers. Any one of the gateway providers can be used to support the SMS OTP to be delivered to the cell phone of the end user. Once OTP is received the client can enter the OTP to get Internet access. NOTE: |
|---|
| General | l Plan Name: The name of the plan. |
|---|
| Design | l Color: There are options to modify colors for the title, message, code, and background. |
|---|
| Accept Terms Message | Text to appear as the accept terms message. |
|---|
| Advanced | Expand Advanced option. Browse and select the advanced fields. |
|---|
| Background | Browse and select the image that needs to be appear as the background. |
|---|
| Background Placement | Choose the option from the drop-down list for placing the background image in the splash page. |
|---|
| Custom Fields | Expand Custom Field option. The user can customize the fields in the Splash page by choosing the Custom Field option in the Guest Access Portal page and clicking Add New button. |
|---|
| Enter Voucher Code | Enter the text to appear in Voucher Code Message. Message |
|---|
| Free Label | Enter the text that should appear on the free label. |
|---|
| Footer | Enter the text to appear as the footer of the page. You can choose the font style and size for the footer. |
|---|
| Logo | Browse and select the logo the needs to be appear on the splash page. |
|---|
| Login Title | Text to appear for login. |
|---|
| Login Success Message | Message to appear after successful login. |
|---|
| Login Failure Message | Message to appear any error while login. |
|---|
| Login Button | Enter the text that should appear on the window to submit. |
|---|
| Opacity | The transparency of background image. |
|---|
| On Success Redirect to | Enter the URL to be redirected to the page like Google, Twitter, and Facebook, etc. URL |
|---|
| Page Title | Text to appear as the title of the page. You can choose the font style and size for the title. |
|---|
| Please wait Message | Text to appear in the waiting screen. |
|---|
| Repeat Background | Enable the check box if you want the background image to be repeated. |
|---|
| Server Error Message | Text to appear if there is an error while contacting server. |
|---|
| Select Plans Label | Enter the text to appear in the label to select plan. |
|---|
| Text Design | Choose the appropriate colors for the background, logo in the background, content area, and for the text. |
|---|
| Terms Agree Button | Text to appear in the terms agree button. |
|---|
| Terms Cancel Button | Text to appear in the terms cancel button. |
|---|
| Voucher Code | Enter the text to appear in Voucher Code, Voucher Label, Enter Voucher Code Message, and Voucher Code Error Message. |
|---|
| Voucher Label | Enter the text to appear in Voucher Label. |
|---|
| Voucher Code Error | Enter the text to appear in Voucher Code Error Message. Message |
|---|
| WIFI4EU | WiFi4EU provides free, high-quality Internet access only across the European Union. WIFI4EU WiFi4EU provides the free, high-quality Internet access across the European Union. Administrator can enable the WiFi4EU check box to provide access to the free Internet. Table 47: WiFi4EU Type Parameters |
|---|
| Access Point | MAC address of the Access Point. |
|---|
| Access Type | Access type as Free or Voucher. |
|---|
| Client MAC | MAC address of the client. |
|---|
| Disconnect | Displays if the client is disconnected from the network. |
|---|
| Remaining Time | The time left for the client to access the Internet. It depends upon the session duration configured in the Access Portal. |
|---|
| Voucher | Displays the valid applied voucher. |
|---|
| WLAN | SSID of the network. NOTE: For Free Access method, the client MAC address is displayed even after the free session duration expires. Delete the MAC address of the client after the Renewable Frequency completes. Mapping the Device to Guest Access Portal in cnMaestro The administrator needs to configure the name of the Guest Access Portal in the device which redirects the device to cnMaestro for cli |
|---|
| Pending Status | Sucess Status 1. Account Creation:Displays as Created once the account is enabled. Refer to Step f for entering contact information and enabling account. 2. Payment Method: Displays as Verified once the Payment Details are approved. Refer to Step g Payment Details. 3. SAS ID: Once the payment details are verified, the SAS ID is allocated automatically. NOTE It may take 1 day to get the SAS ID. 4. |
|---|
| Channel | Channel Bandwidth of AP or BHM in MHz. BandWidth (MHz) |
|---|
| Center | Center frequency of AP or BHM in MHz. Frequency (MHz) |
|---|
| Common | Device Name Name given to device on SAS Admin (max 120 characters. This is to identify device on SAS Admin: it does not get copied to the device via sync. |
|---|
| Device Type | Drop-down selection of supported devices. |
|---|
| MAC Address | MAC address of the device. |
|---|
| MSN | Serial number of device. |
|---|
| User ID | Unique identifier is assigned by the SAS. The User ID is part of the registration request message. The wrong User ID leads to REGISTRATION_ |
|---|
| Height | Device antenna height in meters. |
|---|
| Height Type | Should be AGL or AMSL as follows: |
|---|
| Location | l AMSL height is measured relative to the mean sea level. |
|---|
| Horizontal | A positive number in meters to indicate the accuracy of the device antenna |
|---|
| Accuracy | horizontal location. |
|---|
| Latitude | Latitude of the device antenna location in degrees. |
|---|
| Longitude | Longitude of the CBSD antenna location in degrees. |
|---|
| Vertical | A positive number in meters to indicate the accuracy of the device antenna |
|---|
| Co-Existence | Sector ID The default AP MAC address and allows editing the default MAC address. Related |
|---|
| Parameters | Spectrum The Spectrum Reuse ID defined in the network. Reuse ID |
|---|
| Merge User ID | Prefixes the User ID to the Sector ID and Spectrum reuse ID. |
|---|
| PLMN ID | Public and Mobile Network Identifier. ECGI Related |
|---|
| ECI | E-UTRAN Cell Identifier. It is a length of 28 bits and contains the eNodeB-ID. Parameters |
|---|
| ECGI | Enter the both PLMN ID and ECI parameters and it calculates displays in the ECGI field. |
|---|
| Azimuth | Boresight direction of the horizontal plane of the antenna in degrees with (degrees) respect to True North. |
|---|
| Antenna | Beamwidth 3-dB antenna beam width of the antenna in the horizontal-plane in degrees. |
|---|
| Downtilt | Antenna downtilt in degrees. (degrees) |
|---|
| External | Peak gain of external antenna connected to device in dBi. Antenna Gain (dBi) |
|---|
| Integrated | Peak gain of integrated antenna in dBi. Antenna Gain (dBi) |
|---|
| Certificate | CPI's (Certified Professional Installer) certificate. File |
|---|
| CPIR Name | CPI's registered name. |
|---|
| File Password | CPI's private password. Using a HTTP Proxy Server for CBRS Connectivity Proxy Suggestions for CBRS Connectivity We do not recommend against using cnMaestro On-Premises, as a HTTP Proxy for CBRS connectivity. Normally, upgrades to cnMaestro that result in a small amount of downtime do not impact network devices under management. In the case of CBRS even a brief outage of the proxy during upgrade wi |
|---|
| #acl localnet src 10.0.0.0/8 | # RFC1918 possible internal network #acl localnet src 172.16.0.0/12 # RFC1918 possible internal network #acl localnet src 192.168.0.0/16 # RFC1918 possible internal network |
|---|
| #acl localnet src fc00::/7 | # RFC 4193 local private network range |
|---|
| #acl localnet src fe80::/10 | # RFC 4291 link-local (directly plugged) machines ## This cbrs ACL limits connections to sas.cbrs.cambiumnetworks.com only. acl cbrs dstdomain sas.cbrs.cambiumnetworks.com ## Updates require access to destinations under cloud.cambiumnetworks.com ## This is a separate ACL for readability, but can be combined with the cbrs ACL if preferred. acl cloud dstdomain .cloud.cambiumnetworks.com ## This grou |
|---|
| Name at Installation | Name given to the device when installed. |
|---|
| Date and Time | Date and time of installation. |
|---|
| Installation Duration | Duration of installation. |
|---|
| Added By | Name of the user adding the device. |
|---|
| Comments | Comments about the installation. |
|---|
| SM Name | Name of the device. |
|---|
| Product | Device model and type . |
|---|
| Software Version | Software version of device. |
|---|
| RSSI | Receiver Signal Strength Indicator (RSSI) of SM. |
|---|
| SSR | Signal Strength Ratio (SSR). |
|---|
| External Antenna | Peak gain of external antenna connected to the device. |
|---|
| Start Timestamp | Start time of the summary. |
|---|
| End Timestamp | End time of the summary. |
|---|
| Comment | Comments about the installation process. Configuration Table 51: Configuration fields in cnArcher Installation |
|---|
| IP Address/Setting | IP settings such as for DHCP or Static IP allocation. |
|---|
| Subnet | Subnet mask of the device. |
|---|
| Gateway | IP address of the gateway. |
|---|
| DNS | Name of the DNS server. |
|---|
| Management VLAN | Configured Management VLAN. |
|---|
| Data VLAN | Configured Data VLAN. |
|---|
| PSK | Type of PSK (Pre-Shared Key): WPA or WPA2. |
|---|
| Software Update | Software version provided to upgrade. |
|---|
| Template | Name of the configuration template to apply. |
|---|
| Onboarding Details | Onboarding details related to SM. Photos and Location Photos and Location displays the photos taken during installation. You can view a maximum of four photos at a time. Link Test Result Link Test Result displays the link related test results with respect to throughput. |
|---|
| Modulation Uplink/Downlink | Uplink and Downlink Modulation. |
|---|
| Time | Time at which the link test was performed. |
|---|
| Throughput Uplink/Downlink | Uplink and Downlink Throughput. AP Scan Result AP Scan Result displays a list of scanned APs. Table 53: Fields in AP Scan Result |
|---|
| AP MAC | MAC address of the AP. |
|---|
| AP Bandwidth | Bandwidth of the AP. |
|---|
| AP Frequency | Frequency of the AP. |
|---|
| Registered | Details of the registered SM. 4. Click Delete icon to delete single or multiple entries from the cnArcher Installation Summary page. 5. Click Yes to proceed to delete. 6. A confirmation message is displayed on a successful delete. NOTE cnArcher uploads Installation Summary with cnMaestro when Internet connection is available to users mobile device. This feature is support only in Android. This sec |
|---|
| Authentication Services | Create and configure Authentication servers. |
|---|
| Application Operations | Application level operations such as to create, update and delete operations for Networks, Towers/Sites. Bulk device configuration. |
|---|
| Application Settings | Change global application configuration and onboarding key. |
|---|
| Configuration/Software Update and | Manage configuration/software update and scheduled report |
|---|
| Scheduled Report Jobs | related jobs |
|---|
| Device Overrides | Per-device configuration, including updating AP Group and applying configuration. |
|---|
| Managed Service Provider (MSP) | MSP operations such as modification of branded service, managed account and user invitations. |
|---|
| Session Management | Capability to view and logout other users sessions. |
|---|
| SNMP Configuration | SNMPv2c configuration parameters. |
|---|
| Authentication Server | Global name of the server Name |
|---|
| IP Address/Host | Enter the FQDN (Fully Qualified Domain Name) of the server or the IP address of the |
|---|
| Port | TCP port of the server. (Default value is 49) |
|---|
| Shared Secret | Shared secret key for communicating with the server. |
|---|
| Service Name | Name defined in the service configuration table configured by TACACS+ server administrator. This is used to configure service and corresponding user groups. |
|---|
| Role Mappings | TACACS+ user groups should be mapped to one or more cnMaestro Roles. Refer Role-Based Access section to view the supported Roles on cnMaestro. Enter the role strings that are configured in the TACACS+ server. Atleast one mapping must be completed for this feature to work correctly. NOTE: TACACS+ server administrator should setup the service name and corresponding user group as per the configuratio |
|---|
| IP Address/Hostname | Enter the FQDN (Fully Qualified Domain Name) of the server or the IP address of the server. |
|---|
| BASE DN | Distinguished Name for Active Directory. |
|---|
| IP Address | IP address of the server. |
|---|
| SSL/TLS | Select this check box if Active Directory connection should be secured over SSL/ TLS as LDAPS. Browse and select the Root certificate of the Active Directory server in .PEM format. |
|---|
| Base DN | Base DN is generally the Admin DN used to log in to LDAP server. For example: cn=admin,dc=xyz,dc=com. |
|---|
| LDAP Password | LDAP Password is the admin password used by Admin DN to log in. |
|---|
| Suffix | Suffix is the DNS name. For example: dc= xyz, dc=com. |
|---|
| SSL/TSL Security | Select this check box LDAP connection should be secured over SSL/ TLS as LDAPS. Browse and select the Root certificate of the Active Directory server in .PEM format. Note: |
|---|
| DNS Lookup | Lists the DNS records for a domain in priority order. |
|---|
| Traceroute | Lists the hosts or IP addresses showing the route of the test packets starting from the selected monitoring location to the destination Domain or IP. Figure 175 Network Tools SSL Certificate cnMaestro On-Premises generates a self-signed certificate when it boots the first time. Because the root CA is not present in standard browsers, cnMaestro users (administrators or Captive Portal customers) rec |
|---|
| Common Name | Enter FQDN name of the cnMaestro server. This is either the Domain Name or the IP Address. |
|---|
| Organization (O) | Enter the name of the organization. |
|---|
| Organization Unit (OU) | Enter the name of the organization unit. |
|---|
| City/Locality (L) | Enter the name of the city. |
|---|
| State/Province (ST) | Enter the name of the state. |
|---|
| Subject Alternative | Enter DNS or IP Address. Name (SAN) |
|---|
| Country (C) | Select the name of the country from the drop-down list. 4. Click Generate CSR., the user is prompted to save a cnMaestro .csr file to their hard drive. The CSR can then be sent to a Certificate Authority and signed. Import a Certificate Once the CSR has been transferred to the Certificate Authority to create a certificate, it can be imported back into cnMaestro. cnMaestro will validate the certifi |
|---|
| Benefit | Details |
|---|
| Cloud Friendly | Webhooks are a standard mechanism for Cloud alerts and inter- service asynchronous communication. |
|---|
| Firewall Friendly | HTTPS is generally amenable for outgoing and incoming firewall connections. |
|---|
| Real-Time | Alarms to be sent to third-party services in real-time. |
|---|
| TCP | Webhooks use TCP instead of UDP, so they can alert when the external system is down, or the event was not received. |
|---|
| Third-Party Support | Many Cloud and On-Premises services support Webhooks. Integrations Webhooks enable integration with external Cloud services, such as Slack, Twilio, Zapier, Datadog, PagerDuty, etc. They can also be supported using a local HTTPS server and custom applications. Once configured, cnMaestro streams alarms to these services over HTTPS to the configured URL. Some example services are provided below: Figu |
|---|
| Basic | Optionally add HTTPS Basic Authentication to the Webhook POST request. By enabling |
|---|
| Authentication | Basic Authentication, you can configure the username and password associated with your endpoint. The Basic Authentication parameters are Base64 encoded and included in the header of HTTP request. Note 1: The username and password for Basic Authentication are different from cnMaestro user credentials. These credentials are used at your endpoint, few external integrations like Slack only require Web |
|---|
| Filters | You can filter the alarms based on severity such as Minor, Major, or Critical. You can also select multiple severities. Device type allows to select the particular device from the drop-down. |
|---|
| Managed | If cnMaestro is configured for MSP (Managed Service Provider), you can map the Webhooks |
|---|
| Account | to a Managed Account. Note A maximum of two Webhooks can be configured per Managed Account. |
|---|
| Name and URL | Webhooks label for display and filtering purposes. This will also be included in the default payload as Webhook_name. The URL defines the endpoint for the HTTPS POST request. Only HTTPS is supported. |
|---|
| Variable | Description |
|---|
| $ACKNOWLEDGED_BY | Alert acknowledged by |
|---|
| $ALARM_DURATION | Alarm duration (seconds) |
|---|
| $ALARM_ID | Alarm ID (e.g. 9bd4Gc313a4d1e8fie2482df7b77628) |
|---|
| $ALARM_MSG | Alarm message (e.g.: “GPS Sync state changed to Synchronized”) |
|---|
| $ALARM_NAME | Alarm name (e.g.: Configuration Sync) |
|---|
| $ALARM_SEVERITY | Alarm severity (e.g. critical, major, minor) |
|---|
| $ALARM_STATUS | Alarm status (e.g. active) |
|---|
| $ALARM_TIME_RAISED | Alarm raised time (ISO 8601 Date format: 'YYYY-MM-DDTHH:mm:ssZ') |
|---|
| $ALERT_CODE | Alert code (e.g. STATUS) |
|---|
| $DEVICE_MAC | Device MAC address (e.g: AA:BB:CC:DD:EE:FF) |
|---|
| $DEVICE_MODEL | Device Model (e.g: ePMP 1000, cnPilot r201) |
|---|
| $DEVICE_NAME | Device name |
|---|
| $DEVICE_IP | Device IP Address (e.g. 192.168.0.1) |
|---|
| $DEVICE_TYPE | Device type (e.g.Wi-Fi-enterprise) |
|---|
| $MANAGED_ACCOUNT | Managed account name (absent if not mapped to an account) |
|---|
| $NETWORK_NAME | Network name |
|---|
| $SITE_NAME | Site name (note: value will be blank if the device is not under a Site) |
|---|
| $TOWER_NAME | Tower name (note: 'value will be blank if the device is not under a Tower') |
|---|
| $WEBHOOK_NAME | Webhook name |
|---|
| $WEBHOOK_RETRY_COUNT | Retry count (note: only present if Webhook is retried; default is 0) |
|---|
| $WEBHOOK_TIMESTAMP | Webhook sent time (ISO 8601 Date format: 'YYYY-MM-DDTHH:mm:ssZ') cnMaestro expects an HTTP status code 2XX reply from the Webhooks URL to confirm the alarm notification sent via HTTPS POST that is successfully delivered. For any request, if status code 5XX is received, cnMaestro will keep retrying the same payload at the interval of 1, 2, 5, 10 and every 15 minutes thereafter until the request suc |
|---|
| Enable | Select Enable checkbox to enable the Webhook. |
|---|
| Last Status | Last status of Webhook |
|---|
| URL | The URL where HTTPS POST requests will be sent. |
|---|
| Description | Textual description of the task. |
|---|
| Export | Enable export as CSV or PDF. |
|---|
| Module | Module generating entry (AAA, administrator, alarm). |
|---|
| Source | Administrator or API client name. |
|---|
| Source Type | Entity making the update: administrator or API client. |
|---|
| Claim | Claim a device in the network operator. |
|---|
| Cloud-Connect | Provides the status of the On-Premises to Cloud account connection. |
|---|
| Create | Create an object in the network device. |
|---|
| Download | Download a file. |
|---|
| Edit | Edit an existing device detail. |
|---|
| Login | Login to a device. |
|---|
| Logout | Logout from a device. |
|---|
| Mail | Mail ID of a device. |
|---|
| Move | Move a device from the server. |
|---|
| Reboot | Reboot a device. |
|---|
| Upload | Upload a file on the server. Audit Modules Auditing activity is mapped to individual modules within cnMaestro. A breakdown of the available modules is listed below. |
|---|
| ACL | provisioning Adding Editing Removing the ACL Entries |
|---|
| 警報 | provisioning Alarms and Alarm History. |
|---|
| API | provisioning API Management: API Clients and Webhooks |
|---|
| Auditing | provisioning Auditing Infrastructure |
|---|
| Auto-Provision | provisioning Auto-Provisioning |
|---|
| CBRS | Services CBRS |
|---|
| Data-tunnel | provisioning Data Tunneling |
|---|
| Guest-Portal | provisioning Guest Portal |
|---|
| Jobs | provisioning Jobs Infrastructure operations |
|---|
| License | licensing Update license details |
|---|
| MSP | operations Operations covering Managed Services and Managed Account |
|---|
| Onboard | provisioning Onboarding Queue operations |
|---|
| Report | provisioning Data Reports operations |
|---|
| Software- | provisioning Software Upgrade: device image import/export, upgrade device Upgrade operations |
|---|
| SIM | provisioning SIM claim and delete |
|---|
| Webhooks | provisioning Webhooks configuration and management |
|---|
| Event Type | The type of event (Infrastructure, Network, Operation, Security and Wireless). You can select one or multiple events. |
|---|
| IP/Host | The IP address provided to the server. |
|---|
| New Facility | The type of program logging the message. The allowed facilities are local 0 to local |
|---|
| New Severity | The severity of the system log message. |
|---|
| Facility | Description |
|---|
| Local 0-Local 7 | It is the locally used facilities. 7. In the New Severity drop-down, select the type of Severity. Please refer to the below Severity table: |
|---|
| Value | Severity Description 0 Emergency System is unusable. 1 Alert Action must be taken immediately. 2 Critical Critical conditions of hard device errors. 3 Error Error conditions |
|---|
| Features | MSP, CBRS, Wi-Fi Performance, Auto-Provisioning, SNMP, etc. Anchor accounts also simplify CBRS provisioning and billing by aggregating multiple On-Premises instances. In future, Anchor accounts will be used to manage On-Premises cnMaestro X subscriptions. You must create an Anchor account before connecting the On-Premises instance, as shown below: 1. Navigate to https://cloud.cambiumnetworks.com. |
|---|
| radio.radio1.device_id | Device ID Radios |
|---|
| radio.radio1.linked_with | Linked with Radios |
|---|
| radio.radio1.mac | Radio MAC Radios |
|---|
| radio.radio1.margin | Margin Radios |
|---|
| radio.radio1.mode | Radio mode [ap, ep, rep] Radios |
|---|
| radio.radio1.neighbors | Radio neighbors Radios |
|---|
| radio.radio1.network_address | Network address Radios |
|---|
| radio.radio1.noise | Average noise (dB) Radios |
|---|
| radio.radio1.power | Transmit power Radios |
|---|
| radio.radio1.rssi | RSSI value (dB) Radios |
|---|
| radio.radio1.rx_bytes | Receive bytes Radios |
|---|
| radio.radio1.software_version | Current software version. Radios |
|---|
| radio.radio1.temperature | Radio temperature Radios |
|---|
| radio.radio1.tx_bytes | Transmit bytes Radios |
|---|
| radio.radio1.type | Radio type [ptp, ptmp] Radios |
|---|
| radio.radio2.device_id | Device ID Radios |
|---|
| radio.radio2.linked_with | Linked with Radios |
|---|
| radio.radio2.mac | Radio MAC Radios |
|---|
| radio.radio2.margin | Margin Radios |
|---|
| radio.radio2.mode | Radio mode [ap, ep, rep] Radios |
|---|
| radio.radio2.neighbors | Radio neighbors Radios |
|---|
| radio.radio2.network_address | Network address Radios |
|---|
| radio.radio2.noise | Average noise Radios |
|---|
| radio.radio2.power | Transmit power Radios |
|---|
| radio.radio2.rssi | RSSI value (dB) Radios |
|---|
| radio.radio2.rx_bytes | Receive bytes Radios |
|---|
| radio.radio2.software_version | Radio current software version. Radios |
|---|
| radio.radio2.temperature | Radio temperature Radios |
|---|
| radio.radio2.tx_bytes | Transmit bytes Radios |
|---|
| radio.radio2.type | Radio type [ptp, ptmp] Radios Fixed Wireless |
|---|
| ethernet.aux_ | Aux Rx Frames Oversize All interface.rx_frames |
|---|
| ethernet.main_psu_ | Main PSU Rx Frames Oversize All interface.rx_frames |
|---|
| ethernet.sfp_interface.rx_ | SFP Rx Frames Oversize All frames |
|---|
| ethernet.sfp_ | SFP speed and duplex All interface.speed |
|---|
| ethernet.sfp_interface.tx_ | SFP Tx Bandwidth Utiliization All util |
|---|
| radio.24ghz.airtime | Airtime All |
|---|
| radio.24ghz.bssid | Radio mac Enterprise |
|---|
| radio.24ghz.channel | Channel All |
|---|
| radio.24ghz.multicast_rate | Multicast rate All |
|---|
| radio.24ghz.noise_floor | Noise floor All |
|---|
| radio.24ghz.num_clients | Number of clients All |
|---|
| radio.24ghz.num_wlans | Number of WLANs Enterprise |
|---|
| radio.24ghz.power | Transmit power All |
|---|
| radio.24ghz.quality | RF Quality description Enterprise |
|---|
| radio.24ghz.radio_state | Radio state Enterprise |
|---|
| radio.24ghz.rx_bps | Receive bits/second Enterprise |
|---|
| radio.24ghz.rx_bytes | Receive bytes All |
|---|
| radio.24ghz.tx_bps | Transmit bits/second Enterprise |
|---|
| radio.24ghz.tx_bytes | Transmit bytes All |
|---|
| radio.24ghz.unicast_rates | Unicast rates All |
|---|
| radio.24ghz.utilization | Radio utilization Enterprise |
|---|
| radio.5ghz.airtime | Airtime All |
|---|
| radio.5ghz.bssid | Radio mac Enterprise |
|---|
| radio.5ghz.channel | Channel Enterprise |
|---|
| radio.5ghz.multicast_rate | Multicast rate All |
|---|
| radio.5ghz.noise_floor | Noise floor All |
|---|
| radio.5ghz.num_clients | Number of clients Enterprise |
|---|
| radio.5ghz.num_wlans | Number of WLANs Enterprise |
|---|
| radio.5ghz.power | Transmit power All |
|---|
| radio.5ghz.quality | RF quality description Enterprise |
|---|
| radio.5ghz.radio_state | Radio state Enterprise |
|---|
| radio.5ghz.rx_bps | Receive bits/second Enterprise |
|---|
| radio.5ghz.rx_bytes | Receive bytes All |
|---|
| radio.5ghz.tx_bps | Transmit bits/second Enterprise |
|---|
| radio.5ghz.tx_bytes | Transmit bytes All |
|---|
| radio.5ghz.unicast_rates | Unicast rates All |
|---|
| radio.5ghz.utilization | Radio utilization Enterprise Performance API Response (v1 Format) This section provides the performance API response v1 Format for the following devices: |
|---|
| radio.radio1.throughput | Total throughput Radios |
|---|
| radio.radio2.throughput | Total throughput Radios |
|---|
| ethernet.aux_interface.rx | AUX receive bytes All |
|---|
| ethernet.aux_interface.tx | AUX transmit bytes All |
|---|
| ethernet.sfp_interface.rx | SFP receive bytes All |
|---|
| radio.24ghz.clients | Number of clients All |
|---|
| radio.24ghz.throughput | Total throughput All |
|---|
| radio.5ghz.clients | Number of clients All |
|---|
| radio.5ghz.throughput | Total throughput All |
|---|
| Data Type | String (select the Array check box also) |
|---|
| cnPilot R200P | Cambium-cnPilot r200P |
|---|
| cnPilot R201P | Cambium-cnPilot R201P |
|---|
| cnPilot R190 | Cambium-cnPilot R190 |
|---|
| cnPilot Enterprise | Cambium-WiFi-AP |
|---|
| ePMP | Cambium |
|---|
| ePMP 1000 hotspot | Cambium-WiFi-AP Configuring the Policies at the SCOPE Level Once Options 43, 60, 15, and Vendor Classes are created, one needs to create policies at scope level. This allows the DHCP server to send the Option 43 and 60 to the Cambium Devices -- based on their VCI for that device. The policy will make sure these options are only sent if the VCI matches that provided by the device. 1. Select the sco |
|---|
| cnPilot E-Series | Vendor Class for Cambium option 43 and E400/E410/E425H/E500/E501S/E502S/E505/E600 60 selected and values specified |
|---|
| ePMP 1000 Hotspot | Vendor Class for Hotspot Cambium option 43 and 60 selected and values specified Citrix Hypervisor Installation Overview cnMaestro can be installed on Citrix Hypervisor (formerly known as XenServer). The OVA image can be downloaded from the Cambium Support Center https://support.cambiumnetworks.com/. Resources The following resources are required for deployment. Note: 1. If NBI APIs or Performance |
|---|
| Wireless Clients | Number of vCPUs RAM Size (GB) Hard Disk (GB) Devices 1 - 100 Up to 1500 2 4 120 101 – 1,000 Up to 15,000 4 4 120 1,001 - 4,000 Up to 60,000 4 8 150 4,001 - 10,000 Up to 150,000 8 16 250 Import using Citrix Hypervisor Perform the following steps to install the Citrix Hypervisor: 2. Click Import. 3. Click Next on the import wizard, browse to the downloaded OVA and click Next. 4. Review the Package V |
|---|
| 接口數量 | Port Type Purpose Number 1 443 TCP HTTPs Web Access and device communication 2 18301 TCP/UDP Wi-Fi Performance Test 3 161 UDP SNMP Communication 4 22 TCP Data Replication (High Availability) 5 8300 TCP Distribution Synchronization (High Availability) 6 8301 TCP/UDP Distribution Synchronization (High Availability) 7 3799 UDP RADIUS CoA for RADIUS Proxy feature Outbound Ports The following table pro |
|---|
| Support Website | http://www.cambiumnetworks.com/support |
|---|
| Main Website | http://www.cambiumnetworks.com |
|---|
| cambium Community | http://community.cambiumnetworks.com |
|---|
| Sales Enquiries | solutions@cambiumnetworks.com |
|---|
| Support Enquiries | https://www.cambiumnetworks.com/support/contact-support/ |
|---|
| Telephone Number List | http://www.cambiumnetworks.com/support/contact-support |
|---|
| Address | Cambium Networks Limited, 3800 Golf Road, Suite 360, Rolling Meadows, IL 60008 USA. |
|---|