### Run SevOne Setup Script for GUI Installer Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=deployment-sd-wan-viptela-collector-upgrade-process-guide Executes the setup script to update datasources and prepare the GUI Installer. It requires the path to the solution .tgz file and its corresponding SHA256 checksum file. The output provides a URL and credentials to access the installer. ```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 ``` -------------------------------- ### Start SevOne GUI Installer Service (Linux) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-faqs This command initiates the SevOne GUI installer service on a Linux host. It's used when the installer needs to be manually started, for example, if it failed to resume during an installation process. This command requires root privileges. ```bash systemctl start sevone-gui-installer ``` -------------------------------- ### Create Widget Installation Directory Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide Create a new directory, for example, 'sdwan-8.0', to house the SD-WAN widget files. This organizes the installation process. Standard directory creation command. ```bash mkdir sdwan-8.0 ``` -------------------------------- ### SevOne Data Disk Setup Script Example Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=platforms-sevone-data-platform-deployment-cloud Example script content for /opt/ibmcloud_setup.sh. This script is designed to format, mount, and configure an attached data disk, primarily for initial deployment scenarios. It should not be used for migrating data on existing environments. ```bash # This script is only valid during initial deployment, and should not be used # to migrate data on an existing environment with a significant amount of ``` -------------------------------- ### InstallerAgent Log Example (Log) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=troubleshooting-sd-wan-viptela-collector-guide This is an example of the output from the InstallerAgent log file. It shows timestamps, log levels (INF for informational messages), agent names, request/response details, and specific actions like sending SOA requests and logging into vManage. ```log 2023-08-28T04:55:18Z INF Sending SOA request... agent=InstallerAgent endpoint=/sevone.api.v3.Metadata/ObjectTypes requestId=8 2023-08-28T04:55:18Z INF Received SOA response agent=InstallerAgent elapsed=15.050577ms requestId=8 2023-08-28T04:55:18Z INF Sending SOA request... agent=InstallerAgent endpoint=/sevone.api.v3.Metadata/IndicatorTypes requestId=9 2023-08-28T04:55:18Z INF Received SOA response agent=InstallerAgent elapsed=10.454609ms requestId=9 2023-08-28T04:55:18Z INF Run agent start agent=InstallerAgent 2023-08-28T04:55:18Z INF Sending request... agent=InstallerAgent method=POST requestId=10 url=/j_security_check 2023-08-28T04:55:18Z INF Received response agent=InstallerAgent elapsed=3.194398ms requestId=10 status="200 OK" 2023-08-28T04:55:18Z INF Successfully logged into vManage agent=InstallerAgent 2023-08-28T04:55:18Z INF Sending request... agent=InstallerAgent method=GET requestId=11 url=/dataservice/client/server 2023-08-28T04:55:18Z INF Received response agent=InstallerAgent elapsed=1.228017ms requestId=11 status="200 OK" 2023-08-28T04:55:18Z INF Found vManage platform version: 19.2.31 agent=InstallerAgent ... ... ... ``` -------------------------------- ### Display deploy.sh Help Information Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide Display the help information for the 'deploy.sh' script to show available options and usage. This is useful for understanding advanced configurations and parameters. Requires 'deploy.sh' to be executable. ```bash ./deploy.sh --help ``` -------------------------------- ### Example SDP Configuration File (YAML) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-sevone-data-publisher An example of the 'example-config.yml' file found in '/config/sdp/'. This file contains default settings for the SevOne Data Platform output, including logging, caching, and data publishing. ```yaml version: 1 log: # Accepted values: error, warn, info, debug level: info cache: refreshPeriodSeconds: 1800 # Configure the SDP output format sdp: outputFormat: avro clusterName: NMS includeDeviceOID: false schemaFile: /config/sdp/schema.json # number of workers for live data publishing. Defaults to 10 workers if unspecified workers: 10 # Filters for the SDP output ``` -------------------------------- ### Start SevOne Simulator using PHP Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-xstats-generic-csv-adapter-quick-start-guide This command initiates the SevOne simulator. It's intended solely for testing environments. After execution, it configures simulator settings, adds a cron job, and sets up SSH keys. The output provides commands to configure specific data source profiles for the simulator. ```php php /opt/sevone-xstats/GenericCSVTransform/bin/console.php start-simulator ``` -------------------------------- ### OID to Text Conversion Example Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Converts specified OID indexes back into their corresponding ASCII string representation. Examples are provided for OIDs with and without length prefixes. ```generic $s '3.67.80.85' // The result of this is CPU. $S '67.80.85' // The result of this is also CPU. ``` -------------------------------- ### Ternary Operator Examples Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Shows the application of the ternary operator (condition ? value_if_true : value_if_false) for conditional assignments. It handles both direct values and expressions. ```generic 1. [sevenOrEight1] = `[x]` ? 7 : 8; 2. [sevenOrEight2] = `[x]` ? 6 + 1 : 2 * 2 + 4; ``` -------------------------------- ### Variable Assignment Examples Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Illustrates how to assign values to variables using assignment operators. This includes single variable assignment, chained assignment, and assignment using expressions. ```generic 1. [one] = 1; 2. [two] = 1 + 1; 3. [two] = `[one]` + `[one]` - 1 + 1; 4. [ten] = ( 2 + 1 ) * 3 + 1; 1 [x] = [y] = [z] = 12; ``` -------------------------------- ### Navigate to Adapter Directory and Check Parser Installation Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=qsg-xstats-adapter-accedian-vision-ems-tm-quick-start-guide Changes the directory to the extracted adapter files and performs a check to ensure the parser can be installed. The `-c` option simulates the installation process without making actual changes. ```shell cd /opt/sevone-xstats/AccedianCSVTransform php bin/console.php install -c ``` -------------------------------- ### Text to OID Conversion Example Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Converts the text 'CPU' into an OID index, demonstrating the ASCII values of 'C', 'P', and 'U'. It shows conversions both with and without a length prefix. ```generic #s 'CPU' // The result of this is 3.67.80.85 (includes a length prefix). #S 'CPU' // The result of this is 67.80.85 (no length prefix). ``` -------------------------------- ### SevOne-act Support Toolkit - General Usage Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-nms-mustgather-evidence-collection-guide This command displays general information about the SevOne-act support toolkit and lists available commands. It serves as an entry point for understanding the toolkit's capabilities. ```bash SevOne-act support ``` -------------------------------- ### Update Ansible Inventory for Single-Node Cluster Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=troubleshooting-sd-wan-versa-collector-use-cases-guide This example shows how to update the Ansible inventory file on the control plane node for a single-node cluster. It specifies the server details and connection method, which is 'local' for a single-node setup. ```ini [server] sdwan-node01 ansible_connection=local ``` -------------------------------- ### Run deploy.sh Script (Basic) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide Execute the 'deploy.sh' script to install the SD-WAN widgets. This is the primary installation command, taking the widget tar package as an argument. Requires 'deploy.sh' and the widget package to be accessible. ```bash ./deploy.sh /home/sevone/sdwan-8.0/sdwan-widgets-v8.0.0-build.<###>.tar.gz ``` -------------------------------- ### Install SevOne CLI and Base Packages (Bash) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-data-insight-installation-guide Copies default Ansible configuration, installs the latest sevone-cli, and then installs base OS packages using the sevone-cli playbook. It requires root privileges for copying files and installing RPMs. The 'freight_install_skip_broken=yes' extra-var is used to bypass checks for broken packages during installation. ```bash sudo cp -r /opt/SevOne/upgrade/ansible/playbooks/inventory/* /etc/ansible/ rpm -Uvh /opt/SevOne/upgrade/utilities/sevone-cli-3.0.0-2.el8.x86_64.rpm sevone-cli playbook up --tags os --extra-vars "freight_install_skip_broken=yes" ``` -------------------------------- ### S3 Variable Assignment and OID Evaluation Example Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Demonstrates the correct and incorrect ways to assign values to variables in S3, particularly when dealing with OIDs. It highlights how backticks prevent unintended OID evaluation, ensuring the variable's literal value is used. ```S3 1 [test] = 'test'; 2 [test1] = [test] 1; -- Incorrect evaluation: [test] is treated as an OID. -- Expected: test1, Actual: 1 1 [test] = 'test'; 2 [test1] = `[test]` 1; -- Correct evaluation: `[test]` prevents OID lookup. -- Value of [test1] is 'test1'. ``` -------------------------------- ### Copy Example SDP Configuration File Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-sevone-data-publisher This command copies the example configuration file 'example-config.yml' to 'config.yml' within the '/config/sdp' directory. 'config.yml' is the active configuration file for the SevOne Data Publisher (SDP) and should be edited to suit your environment. ```bash cp example-config.yml config.yml ``` -------------------------------- ### GET /api/configs Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-sevone-data-publisher Retrieves the current configuration setups for the SevOne Data Publisher. ```APIDOC ## GET /api/configs ### Description Returns the configuration setups for the SevOne Data Publisher. ### Method GET ### Endpoint /api/configs ### Parameters #### Query Parameters None ### Request Example ``` curl -s http://:/api/configs | jq ``` ### Response #### Success Response (200) - **(object)** - A JSON object containing the configuration details. The exact structure depends on the configuration. #### Response Example ```json { "configKey1": "configValue1", "configKey2": 123 } ``` ``` -------------------------------- ### Create KVM Setup Script Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=platforms-sevone-data-platform-deployment-kvm Shell command to create an empty bash 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 ``` -------------------------------- ### Install SevOne Data Insight using ISO Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-data-insight-installation-guide This set of commands is used when deploying SevOne Data Insight from an .iso image. It involves copying Ansible configuration, installing the sevone-cli utility, installing base OS packages, and finally provisioning the Kubernetes cluster. The `--extra-vars "freight_install_skip_broken=yes"` flag is used to bypass broken package installations. ```bash # copy over the default ansible config sudo cp -r /opt/SevOne/upgrade/ansible/playbooks/inventory/* /etc/ansible/ # check and install the latest sevone-cli rpm -Uvh /opt/SevOne/upgrade/utilities/sevone-cli-3.0.0-2.el8.x86_64.rpm # install base packages sevone-cli playbook up --tags os --extra-vars "freight_install_skip_broken=yes" # provision kubernetes sevone-cli playbook up --extra-vars "freight_install_skip_broken=yes" ``` -------------------------------- ### Manage SevOne GUI Installer Services with systemd Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-tools These commands provide control over the SevOne GUI Installer's client and API services using systemd. They allow checking the status, starting, and stopping of these services, which is crucial for maintenance and troubleshooting. ```shell sudo systemctl status sevone-guii-@api sudo systemctl status sevone-guii-@client sudo systemctl start sevone-guii-@api sudo systemctl start sevone-guii-@client sudo systemctl stop sevone-guii-@api sudo systemctl stop sevone-guii-@client ``` -------------------------------- ### Enable and Start firewalld Service Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-build-rebuild-physical-appliance-using-iso These commands enable the `firewalld` service to start automatically on boot and then start the service immediately. This is a standard procedure for enabling firewall management on RHEL-based systems. ```bash /usr/bin/systemctl enable firewalld /usr/bin/systemctl start firewalld ``` -------------------------------- ### Upgrade SD-WAN Collector (GUI Installer) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=troubleshooting-sd-wan-viptela-collector-guide This command is used to upgrade the SD-WAN collector when using the GUI installer. It is executed after the necessary prerequisite steps have been completed. ```bash sevone-cli solutions upgrade ``` -------------------------------- ### Skip Stages in SevOne GUI Installer by Deleting Playbooks Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guide-tools This method allows skipping specific installation stages by manually deleting their corresponding playbook YAML files. For example, deleting 'soa.yaml' will prevent the SOA Upgrade stage from running. After deletion, refreshing the GUI Installer page will reflect the skipped stage. ```shell rm -rf /opt/SevOne/upgrade/ansible/playbooks/soa.yaml ``` -------------------------------- ### SevOne NMS Version Information Example Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-nms-upgrade-process-guide An example of the output from the 'SevOne-show-version' command, detailing the specific versions of SevOne NMS and its dependencies. This serves as a reference to confirm a successful 8.0.0 upgrade. ```text SevOne version: 8.0.0 kernel version: 4.18.0-553.60.1.el8_10.x86_64 #1 SMP Fri Jun 27 05:59:19 EDT 2025 nginx version: 1.24.0 MySQL version: 10.6.22-MariaDB PHP version: 8.3.23 SSH/SSL version: OpenSSH_8.7p1, OpenSSL 3.2.2 4 Jun 2024 REST API version: 2.1.47, Build time 2025-06-12T19:31:44+0000, Hash b553970 Intel(R) Xeon(R) CPU 2 cores @ 2199.997MHz 8GB RAM 4GB SWAP 150 GB / Partition 150 GB /data partition ``` -------------------------------- ### deploy.sh Script Usage Syntax Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=gg-sd-wan-collector-widgets-data-insight-installation-upgrade-guide Provides the general usage syntax for the deploy.sh script, outlining the required widget package file and optional parameters for deployment. ```shell deploy.sh -- A one click widget packet installer Usage: ./deploy.sh [--force] [--user ] [--password ] [--tenant ] \ [--host ] [--import-ootb-reports] [--datasource-name ] ``` -------------------------------- ### Start Jaeger Service for Request Tracing Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=troubleshooting-sd-wan-viptela-collector-guide This command starts the Jaeger service on the SevOne NMS appliance, which is necessary for obtaining request traces when data retrieval from SevOne NMS is involved. Ensure the event is triggered in the SD-WAN Collector after starting Jaeger. ```bash supervisorctl start jaeger /usr/local/bin/jaeger ``` -------------------------------- ### Example Verified Network Configuration (PAS) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-sevone-nms-advanced-network-configuration-guide This is an example output of verified network configuration files ('ifcfg-${connection_name}' and 'route-${connection_name}') for PAS. It shows the structure and content of a typical configuration after static routes have been successfully applied. ```text PAS$ cd /etc/sysconfig/network-scripts PAS$ cat /etc/sysconfig/network-scripts/ifcfg-${connection_name} TYPE=Ethernet PROXY_METHOD=none BROWSER_ONLY=no BOOTPROTO=none DEFROUTE=yes IPV4_FAILURE_FATAL=no IPV6INIT=yes IPV6_AUTOCONF=yes IPV6_DEFROUTE=yes IPV6_FAILURE_FATAL=no IPV6_ADDR_GEN_MODE=stable-privacy NAME=ens160 UUID=afe20483-ba17-4955-aed6-1706093e8b88 DEVICE=ens160 ONBOOT=yes IPADDR=10.168.117.48 PREFIX=22 GATEWAY=10.168.116.1 IPADDR1=10.168.118.64 PREFIX1=22 # Optional (this file exists only if Static Routes are configured) PAS$ cat /etc/sysconfig/network-scripts/route-${connection_name} ADDRESS0=10.128.24.0 NETMASK0=255.255.252.0 GATEWAY0=10.168.116.3 OPTIONS0="src 10.168.118.64" ``` -------------------------------- ### Retrieve All Plugins (GET Request) Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-restful-api-quick-start-guide This example demonstrates how to retrieve a list of all available plugins using a GET request to the /api/v3/plugins/filter endpoint with the queryType parameter set to FULL. The response will contain a list of plugins and their associated device counts. ```curl curl -X GET --header "Accept: application/json" --header "X-AUTH-TOKEN: eyJhbGciOiJIUzUxMiJ9eyJpc3MiOiJhZG1pbiJ9kqoCxkBpEZMePETB02qcm7aRc8w-CEdyv0KsjDyGs-rMQ8vy55MZohqpJzw3ikxeD0zotZA2iRwTBrPh0bVWPQ" "http://9.42.110.16:15272/api/v3/plugins/filter?queryType=FULL" ``` ```json { "workingPlugins": { "plugins": [ { "pluginId": "1", "pluginName": "SNMP Poller", "deviceCount": "14" }, { "pluginId": "2", "pluginName": "ICMP Poller", "deviceCount": "7" }, { "pluginId": "3", "pluginName": "Process Poller", "deviceCount": "6" }, { "pluginId": "4", "pluginName": "HTTP Poller", "deviceCount": "2" }, { "pluginId": "5", "pluginName": "Proxy Ping Poller", "deviceCount": "2" }, ... ... ... { "pluginId": "29", "pluginName": "Wi-Fi", "deviceCount": "0" }, { "pluginId": "30", "pluginName": "GCP", "deviceCount": "0" } ], "pluginCount": "22" } } ``` -------------------------------- ### Copy Example Tenant Configuration Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=vco-sd-wan-viptela-collector-advanced-use-cases-guide Copies an example configuration file for the SD-WAN Viptela collector to a new location with a tenant-specific name. This new file will be customized for the specific tenant's settings. ```bash cp /opt/SevOne/upgrade/utilities/example-solutions-sdwan-viptela_config.yaml \ /opt/SevOne/chartconfs/solutions-sdwan-viptela-2_config_custom_guii.yaml ``` -------------------------------- ### S3 Scripting: Statement and Expression Examples Source: https://www.ibm.com/docs/en/sevone-npm/8.0.0/index_topic=guides-snmp-quick-start-guide Demonstrates the basic structure of S3 scripts, showing how statements and expressions are used. S3 scripts execute sequentially, and statements must end with a semicolon, although the last statement may omit it. Expressions are the atomic units of statements and can be numbers, strings, formulas, variables, OIDs, or grouped expressions. ```S3 Expression ; Expression 1 Expression 2 ; ``` ```S3 7 'Hello' ( ( 1 + 2 ) / 12 + 34 ) * 10 [INDEX] .1.3.6.1.2.1.1.1.0 ( 7 'Hello' ( ( 1 + 2 ) / 12 + 34 ) * 10 [INDEX] .1.3.6.1.2.1.1.1.0 ) ```