IBM SevOne Network Performance Management

https://www.ibm.com/docs/en/sevone-npm/8.1.0
Admin
IBM SevOne Network Performance Management (NPM) is an application-centric network observability...
Tokens:536,327
Snippets:5,033
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Create Widget Installation Directory

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide

Create a new directory, for example, 'sdwan-8.1', to store the SD-WAN widget files. This organizes the installation process.

```bash
mkdir sdwan-8.1
```

--------------------------------

### Start SevOne GUI Installer Service

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guide-faqs

This command starts the SevOne GUI installer service. It is typically used when the installer fails to resume to the next stage. Ensure you are logged in as root or have sudo privileges before executing.

```bash
sudo su -
systemctl start sevone-gui-installer
```

--------------------------------

### Initialize SevOne GUI Installer

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=deployment-sd-wan-versa-collector-upgrade-process-guide

Executes the SevOne-validate-image script to configure the GUI installer. It uses the latest available tarball and checksum files from the upgrade directory.

```bash
SevOne-validate-image \
-i $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz | tail -n 1) \
-s $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_versa-*.tgz.sha256.txt | tail -n 1) \
--installer solutions-gui
```

--------------------------------

### GET /api/v3/devices/{deviceId}/objects

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

Retrieves a collection of all objects associated with a specific device.

```APIDOC
## GET /api/devices/{deviceId}/objects

### Description
Lists a collection of all objects associated with the device identified by the provided deviceId.

### Method
GET

### Endpoint
/api/devices/{deviceId}/objects

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

### Response
#### Success Response (200)
- **objects** (array) - A list of objects belonging to the specified device.
```

--------------------------------

### Initialize Configuration File

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=deployment-sd-wan-versa-collector-configuration-guide

Copies the default example configuration file to the custom configuration path used by the helm chart. This file serves as the base for all SD-WAN Versa collector settings.

```bash
cp /opt/SevOne/upgrade/utilities/example-solutions-sdwan-versa_config.yaml /opt/SevOne/chartconfs/solutions-sdwan-versa_custom_guii.yaml
```

--------------------------------

### Initialize Configuration Files

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=deployment-sd-wan-viptela-collector-pre-guide

Copies example configuration files for Chrony and SNMP to their respective system directories to enable customization.

```bash
sudo cp /etc/chrony.example.conf /etc/chrony.conf
sudo cp /etc/snmp/snmpd.example.conf /etc/snmp/snmpd.conf
```

--------------------------------

### GET /api/v3/alerts/{id}

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

Retrieves details for a specific alert instance by its unique identifier.

```APIDOC
## GET /api/v3/alerts/{id}

### Description
Retrieves the alert with the specified unique identifier.

### Method
GET

### Endpoint
/api/v3/alerts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the alert.

### Response
#### Success Response (200)
- **alert** (object) - The alert object details.
```

--------------------------------

### API Response Structure

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

An example of the JSON response body returned by the alerts endpoint, showing the structure of the alerts array and the associated metadata.

```json
{
  "alerts": [
    {
      "alertType": "TRAP",
      "id": "1",
      "messageText": "Trap received from 127.0.0.1: SNMPv2-MIB::coldStart..."
    },
    {
      "alertType": "TRAP",
      "id": "2",
      "messageText": "Trap received from 127.0.0.1: IF-MIB::linkUp..."
    },
    {
      "alertType": "TRAP",
      "id": "3",
      "messageText": "Trap received from 127.0.0.1: IF-MIB::linkDown..."
    }
  ],
  "endTime": "1708097859",
  "startTime": "1691618263"
}
```

--------------------------------

### Example: Run Agent On-Demand with Deployment and Agent

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=troubleshooting-sd-wan-viptela-collector-use-cases-guide

This example shows how to run an agent on-demand by providing the deployment name and agent name, omitting the log level. The system will default to an 'info' log level for this execution.

```bash
sevone-cli solutions run_agent --deployment_name solutions-sdwan-viptela-1 \
--agent_name InstallerAgent
```

--------------------------------

### Install Individual Widget using install.sh

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide

Install a single widget using the 'install.sh' script. This method requires specifying the widget tar file and SevOne Data Insight connection details.

```bash
./install.sh <widget-tar-file-name>.tgz --user <DI_USERNAME> \
--password <DI_PASSWORD> --tenant <DI_TENANT> \
--host <DI_HOST (without http/https) or localhost>
```

--------------------------------

### GET /api/v3/plugins/filter?queryType=FULL

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

Retrieves a list of available plugins. The `queryType=FULL` parameter returns all plugins. This endpoint is used for reading resource information.

```APIDOC
## GET /api/v3/plugins/filter?queryType=FULL

### Description
Retrieves a comprehensive list of all available plugins. This endpoint is used for informational purposes and does not modify any data.

### Method
GET

### Endpoint
/api/v3/plugins/filter

### Parameters
#### Path Parameters
None

#### Query Parameters
- **queryType** (string) - Required - Specifies the type of query. Use 'FULL' to retrieve all plugins.

#### Request Body
None

### Request Example
```
http://10.12.206.104/api/v3/plugins/filter?queryType=FULL
```

### Response
#### Success Response (200)
- **workingPlugins** (object) - Contains details about the plugins.
  - **plugins** (array) - An array of plugin objects.
    - **pluginId** (string) - The unique identifier for the plugin.
    - **pluginName** (string) - The name of the plugin.
    - **deviceCount** (string) - The number of devices associated with the plugin.
  - **pluginCount** (string) - The total number of plugins available.

#### Response Example
```json
{
  "workingPlugins": {
    "plugins": [
      {
        "pluginId": "1",
        "pluginName": "SNMP Poller",
        "deviceCount": "14"
      },
      {
        "pluginId": "2",
        "pluginName": "ICMP Poller",
        "deviceCount": "7"
      }
    ],
    "pluginCount": "22"
  }
}
```
```

--------------------------------

### Timespan Facet Schema and Data Examples

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=og-sevone-data-insight-report-linking-url-specification-guide

Illustrates the JSON schema for a Timespan Facet, which can define either a relative timeframe or a specific start and end time. The example also shows a data payload for a relative timespan.

```json
{
    "schema": {
      "$id": "insight-timespan",
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "startTime": {
              "type": "number",
              "description": "Start time."
            },
            "endTime": {
              "type": "number",
              "description": "End time."
            },
            "timezone": {
              "type": "string"
            }
          },
          "required": [
            "startTime",
            "endTime"
          ]
        },
        {
          "type": "object",
          "properties": {
            "label": {
              "type": "string"
            },
            "timespan": {
              "type": "string"
            },
            "timezone": {
              "type": "string"
            }
          },
          "required": [
            "label",
            "timespan"
          ]
        }
      ]
    },
    "data": {
      "timespan": <RELATIVE TIMESPAN>>,
      "label": ""
    }
  }
```

--------------------------------

### Example: Run Agent On-Demand with Minimal Arguments

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=troubleshooting-sd-wan-viptela-collector-use-cases-guide

This example demonstrates the minimal command to run an agent on-demand, providing only the deployment name and agent name without explicit flags or a log level. The log level will default to 'info'.

```bash
sevone-cli solutions run_agent solutions-sdwan-viptela-1 InstallerAgent
```

--------------------------------

### SevOne NMS Connection Bootstrap Example

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-sevone-data-insight-installation-guide

An example demonstrating the execution of the `sevone-cli sdi connect-nms` command with sample user inputs for datasource name, NMS URL, username, password, and tenant name. This example also shows the interactive prompts and the expected output during the bootstrap process, including authentication and provisioning steps.

```bash
> @sevone/insight-server@8.1.0 prod:bootstrap
> NODE_PATH=./dist/libs node dist/scripts/database-init/bootstrap.js

Please respond to the following prompts:
info: Authsource Configuration
    Enter the name of your authentication source. Note that it may be the same
    as your datasource. Ex: , SevoneNMS8, Auth Serv, Datasource 123
Name: SevOne
info: Enter the NMS base URL to your authentication source.
    Ex: https://api.example.com
URL: https://10.129.14.168
Login instead of providing an API key? [y/n]: y
Username: admin
Password: ******
info: [SevOne@reconfigure-datasource] SOA request (SOA-1) post https://10.129.14.168/api/v3/users/signin
(node:248) Warning: Setting the NODE_TLS_REJECT_UNAUTHORIZED environment variable to '0' makes TLS connections and HTTPS requests insecure by disabling certificate verification.
(Use `node --trace-warnings ...` to show where the warning was created)
info: [SevOne@reconfigure-datasource] SOA response (SOA-1) elapsed 1994ms.
info: [SevOne@reconfigure-datasource] SOA request (SOA-2) post https://10.129.14.168/api/v3/users/apikey
info: [SevOne@reconfigure-datasource] SOA response (SOA-2) elapsed 72ms.
info: Tenant Configuration
    Enter the name of your tenant. This is independent to Data Insight.
    Ex: WestCoast BestCoast, EastCoast BeastCoast
Name: SevOne
(OPTIONAL. Hit enter to skip) Enter the alternate/display name of your tenant.
Tenant Alternate/Display Name: 
info: Super Admin User Configuration
    Enter the username of your Retina Super Admin user. Note that this user
    MUST match a user with appropriate permissions on your authsource. Even
    if it's not a Super User on your authsource, it WILL be on Retina.
    Ex: JJJSchmidt, jsmith
Username: admin

Output:
info: [SevOne@reconfigure-datasource] SOA request (SOA-3) get https://10.129.14.168/api/v3/health/ping
info: [SevOne@reconfigure-datasource] SOA response (SOA-3) elapsed 7ms.
info: Bootstrap complete.
Defaulted container "graphql" out of: graphql, fix-shared-storage-permission (init)

> @sevone/insight-server@8.1.0 prod:provision
> NODE_PATH=./dist/libs node dist/scripts/database-init/provision.js


No existing object metadata filters.

Please respond to the following prompts:
Would you like to Add an object metadata filter? [y/N] N

Output:
(node:275) Warning: Setting the NODE_TLS_REJECT_UNAUTHORIZED environment variable to '0' makes TLS connections and HTTPS requests insecure by disabling certificate verification.
(Use `node --trace-warnings ...` to show where the warning was created)
info: [SevOne@SevOne] SOA request (SOA-1) post https://datasource-di-1.default.svc.cluster.local.:443/api/v3/users
info: [SevOne@SevOne] SOA response (SOA-1) elapsed 54ms.
info: Provisioning complete.

```

--------------------------------

### Example: Run Agent On-Demand with Deployment, Agent, and Log Level

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=troubleshooting-sd-wan-viptela-collector-use-cases-guide

An example demonstrating how to run an agent on-demand specifying the deployment name, agent name, and a debug log level. This command targets a specific deployment and agent for immediate execution.

```bash
sevone-cli solutions run_agent --deployment_name solutions-sdwan-viptela-1 \
--agent_name InstallerAgent --log_level debug
```

--------------------------------

### GET /api/v3/devicegroups

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

Retrieves a paginated list of device groups. The response includes details about the current page, page size, total number of pages, and total elements.

```APIDOC
## GET /api/v3/devicegroups

### Description
Retrieves a list of device groups. This endpoint supports pagination and provides details on the total number of elements and pages available.

### Method
GET

### Endpoint
/api/v3/devicegroups

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 0.
- **size** (integer) - Optional - The number of resources to return per page. Defaults to 20.

### Request Example
```bash
curl -X GET --header "Accept: application/json" --header "Authorization: bearer <your_token>" "http://<your_api_host>/api/v3/devicegroups?page=0&size=20"
```

### Response
#### Success Response (200)
- **content** (array) - An array of device group objects.
  - **name** (string) - The name of the device group.
  - **parentId** (string) - The ID of the parent device group.
  - **id** (string) - The unique identifier for the device group.
  - **devices** (array) - A list of devices within this group (can be empty).
- **pageNumber** (integer) - The current page number.
- **pageSize** (integer) - The number of elements per page.
- **totalPages** (string) - The total number of pages available.
- **totalElements** (string) - The total number of device groups available.

#### Response Example
```json
{
  "content": [
    {
      "name": "All Device Groups",
      "parentId": "1",
      "id": "2",
      "devices": []
    },
    {
      "name": "Location",
      "parentId": "2",
      "id": "3",
      "devices": []
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "totalPages": "4",
  "totalElements": "61"
}
```
```

--------------------------------

### Launch SevOne NMS - Example URL

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

This example shows the base URL format for launching the SevOne NMS user interface from a web browser. Replace '<PAS hostname or IP address>' with the actual hostname or IP address of your SevOne Performance Analysis Server (PAS).

```http
http://<PAS hostname or IP address>
```

--------------------------------

### Initialize SevOne GUI Installer

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=deployment-sd-wan-viptela-collector-upgrade-process-guide

Executes the SevOne-validate-image script to update datasources and launch the GUI installer. It requires the latest .tgz image and .sha256.txt checksum files located in the upgrade directory.

```bash
SevOne-validate-image \
-i $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_viptela-*.tgz | tail -n 1) \
-s $(ls -Art /opt/SevOne/upgrade/sevone_solutions_sdwan_viptela-*.tgz.sha256.txt | tail -n 1) \
--installer solutions-gui
```

--------------------------------

### Deploy SD-WAN Widgets

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide

Execute the 'deploy.sh' script to install the SD-WAN widgets. Provide the path to the widget tar package as an argument.

```bash
./deploy.sh /home/sevone/sdwan-8.1/sdwan-widgets-v8.1.0-build.<###>.tar.gz
```

--------------------------------

### Retrieve Plugins List

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

Retrieves a list of available plugins using a GET request with a query parameter. This endpoint returns a structured JSON object containing plugin details and counts.

```bash
curl -X GET --header "Accept: application/json" --header "Authorization: bearer <TOKEN>" "http://10.12.206.104/api/v3/plugins/filter?queryType=FULL"
```

--------------------------------

### Access SevOne API Docs (Version 3) - Example URL

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-restful-api-quick-start-guide

This example demonstrates the URL structure to access the SevOne API documentation, specifically version 3, through the Swagger User Interface. Ensure you replace '<PAS hostname or IP address>' with your SevOne PAS hostname or IP address.

```http
http://<PAS hostname or IP address>/api/v3/docs
```

--------------------------------

### Create KVM Setup Script

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=platforms-sevone-data-platform-deployment-kvm

Shell commands to create an empty script file named kvm_setup.sh in the /opt directory. This script will be used to configure KVM data disks.

```bash
touch /opt/kvm_setup.sh
```

--------------------------------

### Troubleshoot PrivateLink Configuration Errors

Source: https://www.ibm.com/docs/en/sevone-npm/8.1.0?topic=guides-aws-quick-start-guide

Log examples representing common failures when connecting to AWS services via PrivateLink. These logs indicate missing configuration files or network connectivity issues between VPCs.

```json
{"level":"info","ts":1749817617.106396,"msg":"Warning: ec2 vpc endpoint not found in configuration for region ap-southeast-1"}
```

```json
{"level":"error","ts":1749794399.442174,"msg":"failed to Authenticate with AWS","error":"failed to assume role arn:aws:iam::012345678901:role/sevone-auto_collector_role: operation error STS: GetCallerIdentity, get identity: get credentials: failed to refresh cached credentials, operation error STS: AssumeRole, exceeded maximum number of attempts, 3, https response error StatusCode: 0, RequestID: , request send failed, Post \"https://vpce-1234-gmundb4e.sts.us-east-1.vpce.amazonaws.com/\": dial tcp 67.220.240.253:443: i/o timeout"}
```

```json
{"level":"error","ts":1749794306.1431816,"msg":"failed to Authenticate with AWS","error":"failed to assume role arn:aws:iam::012345678901:role/sevone-auto_collector_role: operation error STS: GetCallerIdentity, get identity: get credentials: failed to refresh cached credentials, operation error STS: AssumeRole, exceeded maximum number of attempts, 3, https response error StatusCode: 0, RequestID: , request send failed, Post \"https://sts.ap-south-1.amazonaws.com/\": dial tcp 13.200.92.183:443: i/o timeout"}
```
Tokens:
Raw