Wireless LAN Controller (WLC) Solutions Widgets for Data Insight Installation Guide

SevOne Documentation

All documentation is available from the IBM SevOne Support customer portal.

All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of IBM and its respective licensors. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of IBM.

IN NO EVENT SHALL IBM, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IBM DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

IBM, the IBM logo, and SevOne are trademarks or registered trademarks of International Business Machines Corporation, in the United States and/or other countries. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on ibm.com/trademark.

About
Prerequisites
Extract and Deploy
Post-Deployment

About

This document includes steps for deploying the widgets available with the Wireless LAN Controller (WLC) collector in Data Insight.

Prerequisites

In order to deploy the Wireless LAN Controller (WLC) widgets, you will need to have the following:

For SevOne NMS and SevOne Data Insight versions compatible with this release, please refer to Release Notes Wireless LAN Controller (WLC) Collector > section Compatibility Matrix.
sevone access to the Data Insight machine.
Wireless LAN Controller (WLC) collector installed on your SevOne NMS appliance or cluster.
Wireless LAN Collector (WLC) 6.6 widget pack provided to you by IBM SevOne Production or IBM SevOne Support.

Extract and Deploy

Perform the following steps to extract and deploy the Wireless LAN Controller widgets in SevOne Data Insight.

After downloading the widget tar and <CHECKSUM_FILE_NAME>.sha256.txt files provided to you by IBM SevOne Production or IBM SevOne Support, perform the steps below to install the widgets on SevOne Data Insight using CLI (Command Line Interface).

Installation
Upgrade
Import OOTB Reports on SevOne Data Insight

Installation

To install the WLC/Generic widgets on SevOne Data Insight, execute the following commands.

ssh to your SevOne Data Insight machine as sevone user.

$ ssh sevone@<SevOne Data Insight IP address or hostname>

Go to /home/sevone folder.
```
$ cd /home/sevone
```
Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone/ directory.
1. signature-tools- -build.<###>.tgz
  For example, signature-tools-2.0.1-build.1.tgz
2. signature-tools- -build.<###>.tgz.sha256.txt
  For example, signature-tools-2.0.1-build.1.tgz.sha256.txt

Execute the following commands to verify the checksum of the code signing tool before extracting it.

$ (cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
  tail -n 1) | sha256sum --check)

$ sudo tar xvfz $(ls -Art signature-tools-*.tgz | \
  tail -n 1) -C /

Make a directory. For example, wifi-6.6.
```
$ mkdir wifi-6.6
```
Go to folder wifi-6.6.
```
$ cd wifi-6.6
```
Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone/wifi-6.6 directory.
1. wifi-sdi-widgets-v6.6.0-build.17.tar.gz
2. wifi-sdi-widgets-v6.6.0-build.17.tar.gz.sha256.txt

Extract <wifi-6.6-widget-tar-package>.

$ tar xvf <wifi-6.6-widget-tar-package>

Run deploy.sh script.
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz
```
If your password contains any special characters, please run the deployment script using the following command. You must enclose the password in double quotes.

Example
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz --password "abc#$def"
```
To know more options that are available for deploy.sh script, you may use the --help or -h option.
```
$ ./deploy.sh --help

deploy.sh -- A one click widget packet installer

Usage:
  ./deploy.sh <YOUR_WIDGET_PACKAGE_FILE.tar> [--force] [--user <DI_USERNAME>] [--password <DI_PASSWORD>] [--tenant <DI_TENANT_NAME>] [--host <DI_HOST_NAME>] [--import-ootb-reports] [--datasource-name <DATASOURCE_NAME>]
```
Alternate Method: Commands to install each widget individually
Install only one widget
```
$ ./install-widget.sh <widget-in-question>.tgz --user <USERNAME> --password <PASSWORD> --tenant <TENANT> --host <DI-HOST>
```
Example: Manually install AP Audit Table widget
```
$ ./install-widget.sh ap-audit-table-6.6.0.tgz --user admin --password SevOne --tenant "DI Primary Tenant" --host example.di.sevone.com
```
- Replace widget-in-question with the .tgz file name.
- Replace USERNAME, PASSWORD, TENANT with the credentials you would normally use to log into SevOne Data Insight.
- Replace DI-HOST with the URL that you use to access SevOne Data Insight from your browser.
Insert the correct values at the prompts.

To import out-of-the-box (OOTB) reports, please execute the following command.

Execute this command to import OOTB reports
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz --import-ootb-reports
```
- OOTB reports will be imported to your SevOne Data Insight only when the --import-ootb-reports flag is enabled.
- To import OOTB reports on SevOne Data Insight, please refer to section Import OOTB Reports on SevOne Data Insight.
Once the script has been successfully executed, the following widgets are installed.
- AP Audit Table (WLC widget)
- AP Details (WLC widget)
- Cisco AP Inspector (WLC widget)
- WLC Inspector (WLC Widget)
- Wifi Signal Quality (WLC widget)
- Wifi Station Details (WLC widget)
- Wifi Station Summary (WLC widget)
- TopN Heatmap (Generic widget)

Upgrade

To upgrade the existing WLC/Generic widgets on SevOne Data Insight, execute the following commands.

ssh to your SevOne Data Insight machine as sevone user.

$ ssh sevone@<SevOne Data Insight IP address or hostname>

Go to /home/sevone folder.
```
$ cd /home/sevone
```
Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone directory.
1. signature-tools- -build.<###>.tgz
  For example, signature-tools-2.0.1-build.1.tgz
2. signature-tools- -build.<###>.tgz.sha256.txt
  For example, signature-tools-2.0.1-build.1.tgz.sha256.txt

Execute the following commands to verify the checksum of the code signing tool before extracting it.

$ (cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
  tail -n 1) | sha256sum --check)

$ sudo tar xvfz $(ls -Art signature-tools-*.tgz | \
  tail -n 1) -C /

Make a directory. For example, wifi-6.6.
```
$ mkdir wifi-6.6
```
Go to folder wifi-6.6.
```
$ cd wifi-6.6
```
Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone/wifi-6.6 directory.
1. wifi-sdi-widgets-v6.6.0-build.17.tar.gz
2. wifi-sdi-widgets-v6.6.0-build.17.tar.gz.sha256.txt
Extract <wifi-6.6-widget-tar-package>. For example, wifi-sdi-widgets-v6.6.0-build.17.tar.gz.
```
$ tar xvf /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz
```
Run deploy.sh script.
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz --force
```
If your password contains any special characters, please run the deployment script using the following command. You must enclose the password in double quotes.

Example
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz --force --password "abc#$def"
```
To know more options that are available for deploy.sh script, you may use the --help or -h option.
```
$ ./deploy.sh --help

deploy.sh -- A one click widget packet installer

Usage:
  ./deploy.sh <YOUR_WIDGET_PACKAGE_FILE.tar> [--force] [--user <DI_USERNAME>] [--password <DI_PASSWORD>] [--tenant <DI_TENANT_NAME>] [--host <DI_HOST_NAME>] [--import-ootb-reports] [--datasource-name <DATASOURCE_NAME>]
```
Insert the correct values at the prompts.

To import OOTB reports, please execute the following command.

Execute this command to import OOTB reports
```
$ ./deploy.sh /home/sevone/wifi-6.6/wifi-sdi-widgets-v6.6.0-build.17.tar.gz --force --import-ootb-reports
```
- OOTB reports will be imported to your SevOne Data Insight only when the --import-ootb-reports flag is enabled.
- To import OOTB reports on SevOne Data Insight, please refer to section Import OOTB Reports on SevOne Data Insight.
Once the script has been successfully executed, the following widgets are installed.
- AP Audit Table (WLC widget)
- AP Details (WLC widget)
- Cisco AP Inspector (WLC widget)
- WLC Inspector (WLC Widget)
- Wifi Signal Quality (WLC widget)
- Wifi Station Details (WLC widget)
- Wifi Station Summary (WLC widget)
- TopN Heatmap (Generic widget)

Import OOTB Reports on SevOne Data Insight

To import OOTB reports independent of installation/upgradation of widgets, please execute the following command.

for SevOne Data Insight >= 3.5 to 3.9

$ bash /opt/SevOne/upgrade/utilities/toolbox-*/ootb-reports <REPORTS-TAR-FILE-PATH>

for SevOne Data Insight >= 3.10

$ sevone-cli sdi reports load <REPORTS-TAR-FILE-PATH>

This command needs to be run on SevOne Data Insight machine, where you want to import the OOTB reports.

Post-Deployment

Log in to SevOne Data Insight. If you are already logged in, refresh the page. It may take a couple minutes for the page to reload.
In the left navigation bar, click Create to access the list of widget types to create a report from. Or, if you select Reports, you can click Create Report in the upper-right corner to access the list of widget types to create a report from.
In the right panel, Select a Widget section now includes the following Wifi/WLC widget(s):
- AP Audit Table (WLC widget)
- AP Details (WLC widget)
- Cisco AP Inspector (WLC widget)
- WLC Inspector (WLC Widget)
- Wifi Signal Quality (WLC widget)
- Wifi Station Details (WLC widget)
- Wifi Station Summary (WLC widget)
- TopN Heatmap (Generic widget)
Click the info icon available for the Wifi widgets in the Select a Widget section. You will notice that the version of widgets is now changed to 6.6.0 . To check the version of individual widgets, execute the following command on your SevOne Data Insight machine.

Example
```
$ sevone-cli exec wdkserver -- cat /opt/widget-server/data/wuploads/wifi-signal-quality/widget.json | jq .version
```