SevOne SDN Collector Solution Widgets for Data Insight Installation Guide

Edit online

About

Edit online

This document includes steps for deploying the widgets available with SevOne SDN Collector in SevOne Data Insight.

Prerequisites

Edit online

In order to deploy the SDN Solution widgets, you will need the following:

For SevOne NMS and SevOne Data Insight versions compatible with this release, please refer to Release Notes SevOne SDN Collector Monitoring Solution > section Compatibility Matrix.
sevone access to SevOne Data Insight machine
SevOne SDN Collector installed on your SevOne NMS appliance or cluster
SevOne SDN 6.7 widget pack provided to you by IBM SevOne Production or IBM SevOne Support.

Installation

Edit online

To install the SDN/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-latest-version-build.<###>.tgz. For example, signature-tools-2.0.1-build.1.tgz.
2. signature-tools-latest-version-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, sdn-6.7.
```
$ mkdir sdn-6.7
```
Go to folder sdn-6.7.
```
$ cd sdn-6.7
```
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/sdn-6.7 directory.
1. cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz
2. cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz.sha256.txt
Extract <sdn-6.7-widget-tar-package>.
```
$ tar xvf <sdn-6.7-widget-tar-package>
```

Run deploy.sh script.

$ ./deploy.sh /home/sevone/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.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/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.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-widget.sh <widget-in-question>.tgz --user <USERNAME> --password <PASSWORD> --tenant <TENANT>

Example: Manually install SDN Mapping widget

$ ./install-widget.sh cisco-aci-mapping-6.7.0.0.0(v6.7.0).tgz --user admin --password SevOne --tenant "DI Primary Tenant"

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.

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/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz --import-ootb-reports --datasource-name <DATASOURCE_NAME>

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.
- SDN Capacity (SDN widget)
- SDN Mapping (SDN widget)
- SDN Logical Topology (SDN widget)
- SDN Controller Status (SDN widget)
- SDN Fault Messages (SDN widget)

Upgrade

Edit online

To upgrade the existing SDN/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-latest-version-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, sdn-6.7.
```
$ mkdir sdn-6.7
```
Go to folder sdn-6.7.
```
$ cd sdn-6.7
```
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/sdn-6.7 directory.
1. cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz
2. cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz.sha256.txt
Extract <sdn-6.7-widget-tar-package> . For example, cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz .
```
$ tar xvf /home/sevone/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz
```

Run deploy.sh script.

$ ./deploy.sh /home/sevone/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.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/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.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 out-of-the-box (OOTB) reports, please execute the following command.

Execute this command to import OOTB reports

$ ./deploy.sh /home/sevone/sdn-6.7/cisco-aci-sdi-widgets-v6.7.0-build.2.tar.gz --force --import-ootb-reports --datasource-name <DATASOURCE_NAME>

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.
- SDN Capacity (SDN widget)
- SDN Mapping (SDN widget)
- SDN Logical Topology (SDN widget)
- SDN Controller Status (SDN widget)
- SDN Fault Messages (SDN 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.

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.
For SevOne Data Insight >= 3.7, the changes made in the previously installed SDN OOTB reports get overwritten when importing the new OOTB reports.
For SevOne Data Insight < 3.7, the new SDN OOTB reports will not be installed and it generates an error saying you already have the same reports in your system. Please either delete or rename the existing reports to import the new ones.

Post-Deployment

Edit online

Log in to SevOne Data Insight. If you're 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 SDN widgets:
- SDN Capacity (SDN widget)
- SDN Mapping (SDN widget)
- SDN Logical Topology (SDN widget)
- SDN Controller Status (SDN widget)
- SDN Fault Messages (SDN widget)
Click the info icon available for the SDN widgets in the Select a Widget section. You will notice that the version of widgets is now changed to 6.7.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/cisco-aci-mapping/widget.json | jq .version
```