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

Edit online

ABOUT

Edit online

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

PREREQUISITES

Edit online

In order to deploy the WLC solutions widgets, you will need the following:

  • For SevOne Data Insight versions compatible with this release, please refer to the Compatibility Matrix section in Release Notes Wireless LAN Controller (WLC) Collector 7.2.0.
  • sevone access to the SevOne Data Insight machine.
  • SevOne Wireless LAN Controller (WLC) Collector installed on your SevOne NMS appliance or cluster.
  • The signature tools and widget tar file can be downloaded 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 Production or IBM SevOne Support for the latest files. You must place the signature tools files in /home/sevone directory and the widget tar file in /home/sevone/wifi-7.2 directory.

INSTALLATION

Edit online

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

  1. ssh to your SevOne Data Insight machine as sevone user.
    ssh sevone@<SevOne Data Insight IP address or hostname>
  2. Go to /home/sevone folder. 
    cd /home/sevone
  3. Ensure that you have the following latest files downloaded from IBM Passport Advantage and placed in the /home/sevone directory.
    • signature-tools-latest-version-build.<latest>.tgz.
    • signature-tools-latest-version-build.<latest>.tgz.sha256.txt.
  4. 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 /
  5. Make a directory. For example, wifi-7.2. 
    mkdir wifi-7.2
  6. Go to folder wifi-7.2.
    cd wifi-7.2
  7. Ensure that you have the following latest files downloaded from IBM Passport Advantage and placed in the /home/sevone/wifi-7.2 directory.
    • wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz
    • wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz.sha256.txt
  8. Extract <wifi-7.2-widget-tar-package>.
    tar xvf <wifi-7.2-widget-tar-package>
  9. Run deploy.sh script. 
    ./deploy.sh /home/sevone/wifi-7.2/wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz

    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-7.2.0.tgz --user admin --password SevOne --tenant "DI Primary Tenant" --host example.di.sevone.com
    Note:
    • 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.
    Note: 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-7.2/wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz --import-ootb-reports
    Important:
    • 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.
  10. 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)

➤   Upgrade

Edit online

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

  1. ssh to your SevOne Data Insight machine as sevone user.
    ssh sevone@<SevOne Data Insight IP address or hostname>
  2. Go to /home/sevone folder.
    cd /home/sevone
  3. Ensure that you have the following latest files downloaded from IBM Passport Advantage and placed in the /home/sevone directory.
    • signature-tools-latest-version-build.<latest>.tgz.
    • signature-tools-latest-version-build.<latest>.tgz.sha256.txt.
  4. 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 /
  5. Make a directory. For example, wifi-7.2.
    mkdir wifi-7.2
  6. Go to folder wifi-7.2.
    cd wifi-7.2
  7. Ensure that you have the following latest files downloaded from IBM Passport Advantage and placed in the /home/sevone/wifi-7.2 directory.
    • wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz
    • wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz.sha256.txt
  8. Extract <wifi-7.2-widget-tar-package>. For example, wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz.
    tar xvf /home/sevone/wifi-7.2/wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz
  9. Run deploy.sh script.
    ./deploy.sh /home/sevone/wifi-7.2/wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz --force

    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>]
    Note: 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-7.2/wifi-sdi-widgets-v7.2.0-build.<###>.tar.gz --force --import-ootb-reports
    Important:
    • 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.
  10. 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)

➤   Import OOTB Reports on SevOne Data Insight

Edit online

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

sevone-cli sdi reports load <REPORTS-TAR-FILE-PATH>
Important: This command needs to be run on SevOne Data Insight machine, where you want to import the OOTB reports.

POST-DEPLOYMENT

Edit online
  1. 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.
  2. 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.
  3. 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)
  4. 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 7.2.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/widgets/uploads/wifi-signal-quality/widget.json | jq .version