SD-WAN Nokia-Nuage Networks Collector Installation Guide

About

This document covers the installation of the SD-WAN Nokia-Nuage Networks Collector.

Terminology usage...

Note: In this guide if there is,
  • [any reference to master] OR
  • [[if a CLI command (for NMS or Kubernetes or Redis) contains master] AND/OR
  •  [its output contains master]],
   it means leader or Control Plane.
And, if there is any reference to slave or worker, it means follower or agent.

Prerequisites

In order to install the collector, the tar file sdwan-nuage-installation-v6.8.0-build.268036.tgz 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 Support for the tar file. The tar must contain the following components:

  • Docker Installation files and dependencies
  • Nuage Networks Collector (sdwan-nuage.tar.gz)
  • Flow Augmenter (flow-augmenter.tar.gz)
  • Install script to automate the installation/upgrade
    Note:
    • The deployment script must be executed on the SevOne NMS appliance that will receive data from the collector.
    • Requires root access where collector will be installed or need sudo user with root privileges.

Docker

Important: Docker 18 is a minimum requirement. If docker is not installed and you need to install Docker components, please contact IBM SevOne Support.
  1. SSH into the SevOne NMS or the system on which the collector/flow augmenter needs to be deployed.
  2. If the installation is on an NMS appliance, and docker is not enabled and/or started, execute the following commands.
    $ systemctl enable docker
    
    $ systemctl start docker
  3. If the installation is on a non-NMS appliance, ensure that docker is enabled and started.

Collector Installation

using Graphical User Interface

Warning: You must be on SD-WAN >= 6.8 to perform the installation using GUI.
  1. Using ssh, login to NMS appliance as root.
    $ ssh root@<NMS appliance>

    Example

    $ ssh root@10.128.10.226
  2. 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 /root directory of SevOne NMS appliance.
    1. sdwan-nuage-installation-v6.8.0-build.268036.tgz
    2. sdwan-nuage-installation-v6.8.0-build.268036.tgz.sha256.txt
    3. signature-tools-latest-version-build.<###>.tgz. For example, signature-tools-2.0.2-build.1.tgz
    4. signature-tools-latest-version-build.<###>.tgz.sha256.txt. For example, signature-tools-2.0.2-build.1.tgz.sha256.txt
  3. 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 /
  4. Extract the .tgz file.
    $ mkdir -p /opt/SevOne/upgrade/ansible/playbooks
    
    $ cp sdwan-nuage-installation-v6.8.0-build* /opt/SevOne/upgrade
    
    $ cd /opt/SevOne/upgrade && tar xvzf /opt/SevOne/upgrade/sdwan-nuage-installation*.tgz -C /opt/SevOne/upgrade/ansible/playbooks/
    Note: You will find sample_config.yaml file in /opt/SevOne/upgrade/ansible/playbooks/config directory.
  5. Add a tenant by configuring sample_config.yaml file to create <tenant>_config.yaml file for each tenant created.
  6. Make a directory and copy this config file to it.

    Example: Default path, /opt/nuage_ansible/config, for config files

    $ mkdir -p /opt/nuage_ansible/config
    $ cp -f /opt/SevOne/upgrade/ansible/playbooks/config/* /opt/nuage_ansible/config
  7. You are now ready to install the Nuage Networks Collector. Run the setup script.

    Run the setup script

    Example: Default config directory

    $ cd /opt/SevOne/upgrade/ansible/playbooks/
    
    $ sh setup_ssu.sh

    Example: The command returns the following

    ******************************************************************************
    
    SEVONE GUI INSTALLER
    
    Please open https://10.49.15.129:3000 in your web browser to access the GUI Installer.
    
    Your credentials are:
    - Username: admin
    - Password: hbqpXs@CTs
    
    If you ever lose your credentials, they are stored in:
    /etc/sevone-guii/creds
    
    ******************************************************************************

    You are now ready to install using the Graphical User Interface Installer.

  8. Using a web browser of your choice, enter the URL the setup script has returned. For example, https://10.49.15.129:3000. Nuage Fresh GUI Installer Start
    Note: You will also need the credentials (Username and Password) that the setup script returns. These credentials are also stored in /etc/sevone-guii/creds file.

    Example

    $ 
    cat /etc/sevone-guii/creds | jq
    {
    "password": "hbqpXs@CTs",
    "tokenSecret": "VfwPLkFdxypXxUNbQxsBnBVoTjWYgHGj",
    "username": "admin"
    }
  9. Click Update Cluster to install SD-WAN Nuage Collector.
  10. Enter the credentials returned to perform the Self-Service Upgrade. For example, Username: admin and Password: hbqpXs@CTs
    Nuage Fresh GUI Installer Credential
    Note: To use the Graphical User Interface installer in dark theme, click GUI Install Dark Theme next to SevOne logo.
    For help on what each upgrade step does, click GUI Installer Help Icon button in the upper-right corner.
    Important:
    All the screenshots below are based on the example being used to write this document. Your total number of tasks passed (ok) , skipped, failed, ignored, unreachable, or unexecuted will vary based on your setup. The tasks failed must be addressed as ansible has not ignored them.
  11. Enter username & password and then click Login. The graphical user interface installer checks the Current Version and allows you to proceed with the installation. Nuage Fresh GUI Installer Check Versions
    Important: Example
    Current Version is on SD-WAN Nuage Collector 6.8.0+268036.

    You can proceed with redeploy/install.
    Important: During the Self-Service Upgrade, if you experience network connectivity issue or the upgrade has been halted for any reason, the self-service upgrade will resume from the step where it left off after the issue is resolved. However, if you are at the Deploy step and the self-service upgrade has been halted for any reason, self-service upgrade will show a message requesting you to contact IBM SevOne Support.

    To resume with the Self-Service Upgrade, using a web browser of your choice, re-enter the URL the setup script has returned. For example, https://10.49.15.129:3000.
  12. Click the Continue to Configure button to configure SD-WAN Nokia Nuage solution. Nuage Fresh GUI Installer Configure
    1. From Configuration drop-down, choose a configuration file from the list. The default configuration file is solutions-sdwan-nuage_custom_guii.yaml. Provide inputs for all mandatory fields.
      Important: Once you provide inputs for all mandatory fields, error messages will no longer appear.
      Nuage Fresh GUI Installer Configure Primary
    2. Configure
      • NMS/PAS IP - The IP address of the SevOne NMS Appliance.
      • NMS/PAS GUI Username - GUI username of the NMS / PAS.
      • NMS/PAS GUI password - GUI password of the NMS / PAS.
      • DNC/NMS IP address - The IP address of the NMS / DNC, where the augmented flow must be sent.
      • DNC/NMS Flows Port - Port of DNC, where the flows are sent.
      • VSD Host IP or DNS name - The IP address or DNC of targeted Virtualized Services Directory (VSD).
      • VSD username - The username for the VSD.
      • VSD password - The password for the VSD.
      • Nuage organization - The organization for the VSD.
      • Elasticsearch host IP - The elasticsearch host IP.
      • Elasticsearch host Port - The elasticsearch host port.
      • Collect Data from ElasticSearch - Collect data from elasticsearch.
      • ActiveMQ username - The username of the Messaging Service (ActiveMQ) broker. The format must be %40. For example, sevone%40csp, where sevone is the username and csp is the organization.
      • ActiveMQ password - The password of the Messaging Service (ActiveMQ) broker.
      • ActiveMQ Topic name - Topic to subscribe to the Messaging Service (ActiveMQ) broker. The format must be topic/<topic_name>. For example, topic/CNAAlarms, where CNAAlarms is the topic name.
      • ActiveMQ Port - Port of the Messaging Service (ActiveMQ) broker. The default port is 5672.
      • ActiveMQ IP - The IP address of the Messaging Service (ActiveMQ) broker.
      • Collector installation on remote/local - The mode of installation for the collector. local installs the collector on the same NMS where the script is running.
      • Collector IP - The IP address of the Virtual Machine where collector needs to be installed.
      • Collector ssh username - The SSH username of the VM for collector installation.
      • Collector ssh password - The SSH password of the VM for collector installation.
      • Upgrade Collector - Flag to upgrade the collector.
      • Collector Log Level - Defines the log-level for the collector. Value can be info or debug or error. The default value is info.
      • Enable flow data collection - Flag to enable flow data collection.
      • Flow Augmenter installation on remote/local - The mode of installation for Flow Augmenter.
      • List of Flow VMs - List of Details of VMs where Flow Augmenter needs to be installed.
      • Augmenter Log Level - Defines the log-level for the augmenter. Value can be info or debug or error. The default value is info.

      • Upgrade Flow Augmenter - Flag to upgrade the augmenter.
      • MSP Name - The Managed Service Provider name to which the configured tenant level Orchestrator belongs to. The MSP name can be of your choice.
      • Tenant Name - The tenant name is the Enterprise name that matches with the tenant/enterprise name available in VSD, for the data that needs to be collected.
      • Self monitoring device name - Device name for self monitoring of the Nuage collector.
      • Distribute data across all NMS peers - The flag if set to true, will distribute the devices across the cluster on its own on all the peers. However, if set to false, it will send data to local peer or given list of peers (if provided). The default value is false.
      • Distribution Peers list - The flag expects a list of peers to distribute data. This flag is ignored if Distribute data across all NMS peers flag is true. It is empty by default.
      • q<#>_name- Allows you to change the names of the interface queues as per the user requirements. During installation, if the interface queue names are changed, the same names must be retained during the upgrade or else, new interface queue objects will be created with the new names set during the upgrade. The default interface queue names are q1, q2, q3, q4, and q10.
      • Nuage API version - API version that is compatible with VSD.
      • Create custom site group using device metadata - Flag for creating a custom site group using device metadata. If two devices have the same name (matching of name is case insensitive), it will create the site with the name from the REST-API response. The default value is false.
      • Unique device hostname per MSP - When all the device hostnames are unique across all the tenants, set it to true. This flag is to avoid suffixing the tenant name to the device name. The default value is false.
      • Enable FlowView creation - If the default Nuage Flow View is created at the time of deployment, set the value to true.
      • Update VSD Lat Long value - For latitude, set the flag to the default value, true. Longitude value is updated in device/site metadata by the collector. If an update is required by some external system in NMS, set the flag to false.
      • Enable Self Monitoring - Flag to enable self monitoring. It will create Objects and Indicators for a selfmon device and is set to true. The default value is false.
      • Enable Flow object mapper - Flag to run the flow object mapper. It maps the flow interfaces to the interface objects. The default value is true.
      • Create Devices - Flag to determine devices to be created. If set to true, it will create all devices. If set to false, devices with no data will not be created. The default value is true.
      • Enable Tunnel stat Runner - Flag to run the tunnel stats runner in a separate container for better performance. The default value is true.
      • Enable Interface stat Runner - Flag to run the interface stats runner in a separate container for better performance. The default value is true.
      • Enable Device Summary Runner - Flag to run the device summary runner in a separate container for better performance. The default value is true.

      • Enable Interface Queue stat Runner - Flag to run the queue interfaces runner in a separate container for better performance. The default value is true.
      • Enable Events Runner - Flag to run the events runner in a separate container for better performance. The default value is true.
      • Enable Alarms Runner - Flag to run the alarms runner in a separate container for better performance. The default value is true.
      • Enable vport Poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates raw vport objects. The default value is true.
      • Enable Lan Aggregation Poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates the aggregated vport objects at the subnet and domain level. The default value is true.
      • Enable APM probe stat Runner - Flag to run the APM probe runner in a separate container for better performance. The default value is true.
      • Enable SLA stat Runner - Flag to run the SLA runner in a separate container for better performance. The default value is true.
      • Enable Tunnel description Runner - Flag to run the Tunnel description runner in a separate container for better performance.
      • Enable Flow Interface speed runner - Flag to run the flow interface speed runner. It updates the interface speed for the flow interfaces. The default value is true.
      • Enable flow interface rename runner - Flag to run the flow interface rename runner. It renames the flow interfaces to show the interface name instead of ifIndex. The default value is true.
      • Enable Octet Indicators - Flag to enable octet indicators.
      • Enable Packet Indicators - Flag to enable packet indicatos.
      • Enable LTE Interface Poller - Flag to enable / disable LTE data collection. The default value is true.
      • Enable Device Description Runner - Flag to run the device description runner in a separate container for better performance. The default value is true.
      • SevOne API read Timeout - The read timeout for the SevOne REST API connection. The default value is 30 seconds.
      • Collection Offset - Represents the number of seconds the collector runs in delay from the current time. Set to 0 for regular poll interval collection. Provide the number of seconds for the offset from the current time. For example, if the value is set to 300 (in seconds), the collector collects the data until 5 minutes before the collector's run time. The default value is 0.
      • Create Devices Runner Interval - Interval set in minutes to run the runner. Recommended value is 30 minutes.
      • Tunnel stat Runner Interval - Interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes.
      • Interface stat Runner Interval - Interval set in minutes to run the interface stat runner. Recommended value is 5 minutes.
      • Device Summary Runner Interval - Interval set in minutes to run the device summary runner. Recommended value is 5 minutes.
      • Interface Queue stat Runner Interval - Interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes.
      • Events Runner Interval - Interval set in minutes to run the events runner. Recommended value is 5 minutes.
      • vport & aggregation Runner Interval - Interval set in minutes to run the vport & aggregation runner. Recommended value is 5 minutes.
      • APM probe stat Runner Interval - Interval set in minutes to run the APM probe runner. Recommended value is 5 minutes.
      • SLA stat Runner Interval - Interval set in minutes to run the SLA runner. Recommended value is 5 minutes.
      • Custom Site Group Runner Interval - The interval set in hours for the custom site group creation. Recommended value is 1 hour.
      • Device Description Runner Interval - The interval set in minutes to update the device description to apply the device group rules on it. Recommended value is 15 minutes.
      • Installer Interval - Interval value of installer. Recommended value is 24 hours.
      • Flow Object Mapper Interval - The interval set in hours for the flow object mapper Recommended value is 24 hour.
      • device_summary_runner_aggregation_interval - Aggregation interval set in minutes to run the device summary runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • interface_stat_runner_aggregation_interval- Aggregation interval set in minutes to run the interface stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • interface_queue_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • tunnel_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • lan_aggregation_and_vport_poller_aggregation_interval - Aggregation interval set in minutes to run the vport & lan aggregation runner. Only aggregated data is pushed. Recommended value is 5 minutes. If the interval value is set to 0 then it will not push any data.
      • apm_probe_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the APM probe stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • Redis Password - The install script sets the password for the redis.
      • Fetch Tunnel Page Size - Size of the page to fetch the data from elastic search index for probes. The default value 5000.
      • fetch_tunnel_workers - Number of parallel probe fetchers per tunnel runner instance. The default value is 4.
      • send_tunnel_workers - Number of parallel tunnel data senders towards NMS. The default value is 4.
      • ES Session Timeout - Elastic search session timeout value. The default value is 30 seconds.
      • tunnel_count_bucket_size - Tunnel count bucket size for sending towards NMS per device. The default value is 700.
      • Filtered Indicator List - Comma separated list of indicators that will be filtered/enabled.
      • Enable Dry run - Flag to enable/disable the dry-run mode. The default value is false.
      • Dry run Interval - Duration for running Nokia collector in dry-run mode. The default value is 0 seconds.
      • Total Tunnel Runner - Flag to set the total tunnel runner instances required for fetching data points. Recommended value is 1 instance. For example, 1 tunnel instance fetches around 500k probe data points. Based on the incoming rate, increase the instance count. NOTE: Please do not change the default instant count value if you want to use the aggregation for the tunnel data.
      • Total APM probe Runner - Flag to set the total APM probe runner instances required for fetching data points. Recommended value is 1 instance.
      • SLA Alert Cleanup Interval - Time to keep the violation alerts in NMS as active. Violation alerts get deleted when violation alert timestamp and sla_alert_cleanup_interval are <= current timestamp. The default value is 300 seconds.
      • SLA fetch pagesize - Flag to configure the SLA fetch page size. The default value is 100.
      • Tunnel Description Runner Interval - The interval set in hours to update the tunnel description when site names are changed by custom site group runner. Recommended value is 1 hour.
      • LTE Interface Poller Interval - Interval set in minutes to for LTE data collection. The default value is 5 minutes.
      • LTE Interface Poller Page Size - Flag to configure elastic search page size for LTE data collection. The default value is 5000.
      • LTE interface runner Interval - Interval set in hours to run the LTE interface runner. The default value is 24 hours. It creates object groups, rules, and object metadata. LTE interface runner is enabled / disabled based on the Enable LTE Interface Poller flag.
      • LTE interface runner NMS buffer size - Flag for updating the buffer size for object metadata in bulk. The default value is 500.
      • Enable IKE tunnel Poller - Flag to enable / disable data collection for IKE tunnel objects. The default value is true.
      • IKE Tunnel Poller Interval - Interval set in minutes to run the IKE tunnel runner. The default value is 5 minutes.
      • Enable IKE Probe Poller - Flag to enable / disable data collection for IKE probe objects. The default value is true.
      • IKE Probe Poller Interval - Interval set in minutes to run the IKE probe runner. The default value is 5 minutes.
      • IKE Tunnel Poller page size - Flag to configure elastic search page size for the data collection of IKE tunnel objects. The default value is 5000.
      • IKE Probe Poller page size - Flag to configure elastic search page size for the data collection of IKE probe objects. The default value is 5000.
      • IKE Object Runner NMS buffer size - Flag for updating the buffer size for object metadata related to IKE tunnels and probes in bulk. The default value is 500.
      • IKE Object Group update interval - Interval set in hours to update the object groups related to IKE tunnel and IKE probe. The default value is 24 hours. The value must be set only when Enable IKE tunnel Poller and Enable IKE Probe Poller are set to true.
      • template_send_frequency - The frequency at which the IPFIX data template is sent at DNC.
      • flominer_receiver_read_buffer - The flowminer receiver buffer size.
      • flow_collection_interval - The interval in seconds at which flow collection must happen. The default value is 300 seconds.
      • flow_fetch_workers - The number of parallel fetching threads the elastic search receives to fetch the flows. The default value is 2.
      • flow_send_workers - The number of parallel processing threads that process the flow data points and send to rabbitmq for decoder. The default value is 4.
      • flow_fetch_pagesize - The page size to fetch by the elasticsearch query for the flows. The default value is 5000.
  13. Click Save. Configuration is saved in /opt/nuage_ansible/config/solutions-sdwan-nuage_custom_guii.yaml.
    Important: Once the configuration is saved, click Continue button to Deploy.
  14. Click Continue button to Deploy. Nuage Fresh GUI Installer Run Deploy
  15. Click the Run Deploy button to run the deployment. This can take a few minutes to run. Nuage Fresh GUI Installer Deploy Completed
    Note: To view the logs for a task, click GUI Installer Eye Icon for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.

    SD-WAN Nuage Collector installation has now completed.

    Note: The task list can be long. Search tasks capability is available to search for text you are looking for in the task list.
  16. Click the Continue button. Nuage Fresh GUI Installer Upgrade Finished
Important: This indicates that the installation has completed successfully.
Important: If there was a kernel upgrade for this release, it is recommended to reboot the cluster after the deployment to install the right kernel version.

using Command Line Interface

Important: Before proceeding with the Command Line Interface (CLI) based installation, please ensure that you have performed steps 1 to 6 from section Collector Installation > subsection using Graphical User Interface.

You are now ready to install the Nuage Networks Collector using CLI. Run the deployment script.

Run the deployment script

Example: Default config directory

$ cd /opt/SevOne/upgrade/ansible/playbooks/
 
$ sh deploy_nuage.sh

While running the Nuage install script, please wait when you receive the following prompt. The script automatically continues the execution after the pause.

Nuage Ansible Confirmation

To ensure that installation has completed successfully, perform the steps in Check Installation.

sample_config.yaml

The sample_config.yaml file is a sample file and it must be copied for each tenant to contain the details specific to the tenant.

  1. To add a tenant, copy sample_config.yaml to <tenant>_config.yaml file, where tenant is the name of the tenant. It is case insensitive and spaces must be replaced with underscores. For example, for tenant Enterprise SevOne, the config file can be named as enterprise_sevone_config.yaml.
    $ cd /opt/SevOne/upgrade/ansible/playbooks/config
    
    $ cp sample_config.yaml enterprise_sevone_config.yaml
    Note: Create individual <tenant>_config.yaml files for each tenant. The install script reads all the files in the /opt/SevOne/upgrade/ansible/playbooks/config directory and ignores the sample_config.yaml file.
  2. The following are the predefined set of configuration variables for the Nuage Networks Collector in enterprise_sevone_config.yaml file.
    Note: The configuration file enterprise_sevone_config.yaml contains the default values for the environment variables. You need to edit the configuration variables and save the file.

Using the text editor of your choice, configure the variables in enterprise_sevone_config.yaml file.

$ vi enterprise_sevone_config.yaml
Warning: Mandatory fields - please do not leave them empty in the config file.
  • msp_name
  • tenant_name
  • sevone_api_host
  • nuage_api_url
  • nuage_password
  • nuage_organization
  • elasticsearch_host
  • elasticsearch_port
Important: Whenever there is a single-quote ( ' ) or a double-quote ( " ) in the username or password fields, then remove the enclosing single-quote ( ' ) from the configuration file for those fields.
  • msp_name - The Managed Service Provider name to which the configured tenant level Orchestrator belongs to. The MSP name can be of your choice.
  • tenant_name - The tenant name is the Enterprise name that matches with the tenant/enterprise name available in VSD, for the data that needs to be collected.
  • sevone_api_host - The IP address of the SevOne NMS Appliance.
    Warning: Please use a Virtual IP for sevone_api_host in case of a PAS-HSA setup for the SevOne NMS Appliance - with this, the collector works seamlessly in an event of SevOne NMS failover. Please contact IBM SevOne Support on how to configure Virtual IP for the PAS-HSA pair.

    Please follow the steps below if a DNC is unable to communicate with the Cluster Leader when Virtual IP is configured:
    1. Add Virtual IPs in mysql.user in data/config databases for both the Cluster Leader and HSA.
    2. Add the routing details in /etc/sysconfig/network-scripts/route-ens160.
    3. Restart both the PAS and DNC leader.
    4. Reload peer for the config to fix the devices that are not visible in DNC.

    NOTE: When NMS detects a failure and performs the failover from the leader to the follower (PAS to HSA), data will not be collected during that time - this is approximately 15 - 20 minutes.
  • sevone_api_user - The SevOne NMS user name for an administrator-level account. The default value is admin.
  • sevone_api_password - The SevOne NMS password. The default value is SevOne.
  • sevone_api_read_timeout - The read timeout for the SevOne REST API connection. The default value is 30 seconds.
  • distribute_on_all_peers: The flag if set to true, will distribute the devices across the cluster on its own on all the peers. However, if set to false, it will send data to local peer or given list of peers (if provided). The default value is false.
  • distribution_peers_list: The flag expects a list of peers to distribute data. This flag is ignored if distribute_on_all_peers flag is true. It is empty by default.
  • nuage_api_url - The IP address or DNS of targeted Virtualized Services Directory (VSD).
  • nuage_username - The username for the VSD.
  • nuage_password - The password for the VSD.
  • nuage_organization - The organization for the VSD.
  • elasticsearch_host - The elasticsearch host IP.
  • elasticsearch_port - The elasticsearch host port.
  • es_device_health - Flag to determine where to collect the data from. If set to true, then data is collected from the Elasticsearch on the controller device in Nuage. If false, data is collected from the VSD. The default value is true.
  • amqp_username - The username of the Messaging Service (ActiveMQ) broker. The format must be %40.
  • amqp_password - The password of the Messaging Service (ActiveMQ) broker.
  • amqp_topic - Topic to subscribe to the Messaging Service (ActiveMQ) broker. The format must be topic/<topic_name>. For example, topic/CNAAlarms, where CNAAlarms is the topic name.
  • amqp_port - Port of the Messaging Service (ActiveMQ) broker. The default port is 5672.
  • amqp_ip - The IP address of the Messaging Service (ActiveMQ) broker.
    Important: The AMQP configuration is done from Nuage VSD. For additional details on Messaging Service (ActiveMQ) broker, please refer to Nuage-VSP-6.0.5-API-Integration-Guide > section Creating a JMS Client User in VSD using VSD Architect in https://partners.nuagex.io/documentation.
  • collector_upgrade - Flag to install or upgrade the collector. For first-time installation, it must be set to false. To upgrade the collector, set it to true and follow the steps in Upgrade Collector section. The default value is false.
    Note: For any change to enterprise_sevone_config.yaml (for example) to take effect, the following steps must be performed.
    • collector_upgrade must be set to true.
      • collector_upgrade: 'true'
    • Redeploy the collector.

      Example

      $ cd /opt/SevOne/upgrade/ansible/playbooks  
      
      $ sh deploy_nuage.sh
  • flowaugmenter_upgrade - Flag to install or upgrade the augmenter. For first-time installation, it must be set to false. To upgrade the augmenter, set it to true and follow the steps in Upgrade Collector section. The default value is false.
  • collector_install_mode - The mode of installation for the collector. local installs the collector on the same NMS where the script is running.
  • collector_vm_ip - The IP address of the Virtual Machine where collector needs to be installed. This value must only be set if collector_install_mode is set to remote.
  • collector_vm_username - The SSH username of the VM for collector installation. This value must only be set if collector_install_mode is set to remote.
  • collector_vm_password - The SSH password of the VM for collector installation. This value must only be set if collector_install_mode is set to remote.
  • dry_run - Flag to enable/disable the dry-run mode. The default value is false.
  • dry_run_interval - Duration for running Nokia collector in dry-run mode. The default value is 0 seconds.
  • total_tunnel_runner - Flag to set the total tunnel runner instances required for fetching data points. Recommended value is 1 instance. For example, 1 tunnel instance fetches around 500k probe data points. Based on the incoming rate, increase the instance count.
    Important: Please do not change the default instant count value if you want to use the aggregation for the tunnel data.
  • flow_enabled - Flag to enable Flow Augmenter installation. The default value is false.
  • flowaugmenter_install_mode - The mode of installation for Flow Augmenter. Value can be remote or local. The value must be set to remote for Flow Augmenter installation on another VM. The default value is local.
  • flowaugmenter_vm_ip - The IP address of the Virtual Machine where augmenter needs to be installed. The value must be set only if flowaugmenter_install_mode is set to remote.
  • flowaugmenter_vm_username - The SSH username of the VM for augmenter installation. The value must be set only if flowaugmenter_install_mode is set to remote.
  • flowaugmenter_vm_password - The SSH password of the VM for augmenter installation. The value must be set only if flowaugmenter_install_mode is set to remote.
  • dnc_ip_address - The IP address of the NMS/DNC, where the augmented flows must be sent.
    Warning: Please use a Virtual IP for dnc_api_address in case of a PAS-HSA setup for the SevOne NMS Appliance - with this, the collector works seamlessly in an event of SevOne NMS failover. Please contact IBM SevOne Support on how to configure Virtual IP for the PAS-HSA pair.

    Please follow the steps below if a DNC is unable to communicate with the Cluster Leader when Virtual IP is configured:
    1. Add Virtual IPs in mysql.user in data/config databases for both the Cluster Leader and HSA.
    2. Add the routing details in /etc/sysconfig/network-scripts/route-ens160.
    3. Restart both the PAS and DNC leader.
    4. Reload peer for the config to fix the devices that are not visible in DNC.

      NOTE: When NMS detects a failure and performs the failover from the leader to the follower (PAS to HSA), data will not be collected during that time - this is approximately 15 - 20 minutes.
  • dnc_flows_port - Port of DNC, where the flows are sent. The default value is 9996.
  • enable_custom_site_grouping - Flag for creating a custom site group using device metadata. If two devices have the same name (matching of name is case insensitive), it will create the site with the name from the REST-API response. The default value is false.
    Note: When enable_custom_site_grouping is set to true, additional steps are required. For details, please refer to section Optiopnal Configuration> subsection Configure Custom Sites.
  • unique_hostname_per_msp - When all the device hostnames are unique across all the tenants, set it to true. This flag is to avoid suffixing the tenant name to the device name. The default value is false.
  • collection_offset - Represents the number of seconds the collector runs in delay from the current time. Set to 0 for regular poll interval collection. Provide the number of seconds for the offset from the current time. For example, if the value is set to 300 (in seconds), the collector collects the data until 5 minutes before the collector's run time. The default value is 0.
  • create_devices - (recommended) Flag to determine devices to be created. If set to true, it will create all devices. If set to false, devices with no data will not be created. The default value is true.
  • enable_tunnel_stat_runner - (recommended) Flag to run the tunnel stats runner in a separate container for better performance. The default value is true.
  • enable_interface_stat_runner - (recommended) Flag to run the interface stats runner in a separate container for better performance. The default value is true.
  • enable_device_summary_runner - (recommended) Flag to run the device summary runner in a separate container for better performance. The default value is true.
  • enable_interface_queue_stat_runner - (recommended) Flag to run the queue interfaces runner in a separate container for better performance. The default value is true.
    enable_events_runner - (recommended) Flag to run the events runner in a separate container for better performance. The default value is true.
  • enable_alarms_runner - (recommended) Flag to run the alarms runner in a separate container for better performance. The default value is true.
  • enable_vport_poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates raw vport objects. The default value is true.
  • enable_lan_aggregation_poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates the aggregated vport objects at the subnet and domain level. The default value is true.
  • enable_flow_object_mapper - (recommended) Flag to run the flow object mapper. It maps the flow interfaces to the interface objects. The default value is true.
  • enable_flow_interface_speed_runner - (recommended) Flag to run the flow interface speed runner. It updates the interface speed for the flow interfaces. The default value is true.
  • enable_flow_interface_rename_runner - (recommended) Flag to run the flow interface rename runner. It renames the flow interfaces to show the interface name instead of ifIndex. The default value is true.
  • log_severity - Defines the log-level for the collector. Value can be info or debug or warning or error. The default value is info.
  • create_devices_interval - Interval set in minutes to run the runner. Recommended value is 30 minutes.
  • tunnel_stat_runner_interval - Interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes.
  • interface_stat_runner_interval - Interval set in minutes to run the interface stat runner. Recommended value is 5 minutes.
  • device_summary_runner_interval - Interval set in minutes to run the device summary runner. Recommended value is 5 minutes.
  • interface_queue_stat_runner_interval - Interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes.
  • events_runner_interval - Interval set in minutes to run the events runner. Recommended value is 5 minutes.
  • enable_lan_aggregation_vport_poller_interval - Interval set in minutes to run the vport & aggregation runner. Recommended value is 5 minutes.
  • device_summary_runner_aggregation_interval: Aggregation interval set in minutes to run the device summary runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
  • interface_stat_runner_aggregation_interval: Aggregation interval set in minutes to run the interface stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
  • interface_queue_stat_runner_aggregation_interval: Aggregation interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
  • tunnel_stat_runner_aggregation_interval: Aggregation interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
  • lan_aggregation_and_vport_poller_aggregation_interval: Aggregation interval set in minutes to run the vport & lan aggregation runner. Only aggregated data is pushed. Recommended value is 5 minutes. If the interval value is set to 0 then it will not push any data.
  • enable_apm_probe_stat_runner - (recommended) Flag to run the APM probe runner in a separate container for better performance. The default value is true.
  • apm_probe_stat_runner_interval - Interval set in minutes to run the APM probe runner. Recommended value is 5 minutes.
  • apm_probe_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the APM probe stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
  • total_apm_probe_runner - Flag to set the total APM probe runner instances required for fetching data points. Recommended value is 1 instance.
  • enable_sla_stat_runner - (recommended) Flag to run the SLA runner in a separate container for better performance. The default value is true.
  • sla_stat_runner_interval - Interval set in minutes to run the SLA runner. Recommended value is 5 minutes.
  • sla_alert_cleanup_interval - Time to keep the violation alerts in NMS as active. Violation alerts get deleted when violation alert timestamp and sla_alert_cleanup_interval are <= current timestamp. The default value is 300 seconds.
  • sla_fetch_pagesize - Flag to configure the SLA fetch page size. The default value is 100.
  • enable_lte_interface_poller: Flag to enable / disable LTE data collection. The default value is true.
  • lte_interface_poller_interval: Interval set in minutes to for LTE data collection. The default value is 5 minutes.
  • lte_interface_poller_page_size: Flag to configure elastic search page size for LTE data collection. The default value is 5000.
  • lte_interface_runner_interval: Interval set in hours to run the LTE interface runner. The default value is 24 hours. It creates object groups, rules, and object metadata. LTE interface runner is enabled / disabled based on the enable_lte_interface_poller flag.
  • lte_interface_runner_nms_buffer_size: Flag for updating the buffer size for object metadata in bulk. The default value is 500.
  • enable_ike_tunnel_poller: Flag to enable / disable data collection for IKE tunnel objects. The default value is true.
  • enable_ike_probe_poller: Flag to enable / disable data collection for IKE probe objects. The default value is true.
  • ike_tunnel_poller_interval: Interval set in minutes to run the IKE tunnel runner. The default value is 5 minutes.
  • ike_probe_poller_interval: Interval set in minutes to run the IKE probe runner. The default value is 5 minutes.
  • ike_tunnel_poller_page_size: Flag to configure elastic search page size for the data collection of IKE tunnel objects. The default value is 5000.
  • ike_probe_poller_page_size: Flag to configure elastic search page size for the data collection of IKE probe objects. The default value is 5000.
  • ike_object_runner_nms_buffer_size: Flag for updating the buffer size for object metadata related to IKE tunnels and probes in bulk. The default value is 500.
  • ike_object_group_update_interval: Interval set in hours to update the object groups related to IKE tunnel and IKE probe. The default value is 24 hours. The value must be set only when enable_ike_tunnel_poller and enable_ike_probe_poller are set to true.
  • redis_password - The install script sets the password for the redis.
  • redis_port - Default port is port 6381.
  • enable_flow_view_creation - If the default Nuage Flow View is created at the time of deployment, set the value to true.
  • flow_interface_speed_runner_interval - The interval set in hours to run the flow interface speed runner. Recommended value is 1 hour.
  • installer_interval - Interval to run the Device Discovery, Device Groups creation. The default value is 24 hours.
  • json_decoder_count - One decoder can process 40000 flows/sec. Based on this, determine the count of JSON decoders to run . The default value is 1.
  • flowaugmenter_log_level - Flow Augmenter Log Level. Value can be info or debug or warning or panic or fatal or error. The default value is info.
  • self_monitoring - Flag to enable self monitoring. It will create Objects and Indicators for a selfmon device and is set to true. The default value is false.
  • sevone_selfmon_name - Device name for self monitoring of the Nuage collector. The default value is an empty string and this will not create a selfmon device.
  • custom_site_group_runner_interval - The interval set in hours for the custom site group creation. Recommended value is 1 hour.
  • device_description_runner_interval - The interval set in minutes to update the device description to apply the device group rules on it. Recommended value is 15 minutes.
  • enable_device_description_runner - (recommended) Flag to run the device description runner in a separate container for better performance. The default value is true.
  • flow_collection_interval- The interval in seconds at which flow collection must happen. The default value is 300 seconds.
  • flow_fetch_workers - The number of parallel fetching threads the elastic search receives to fetch the flows. The default value is 2.
  • flow_send_workers - The number of parallel processing threads that process the flow data points and send to rabbitmq for decoder. The default value is 4.
  • flow_fetch_pagesize - The page size to fetch by the elasticsearch query for the flows. The default value is 5000.
  • q<#>_name- Allows you to change the names of the interface queues as per the user requirements. During installation, if the interface queue names are changed, the same names must be retained during the upgrade or else, new interface queue objects will be created with the new names set during the upgrade. The default interface queue names are q1, q2, q3, q4, and q5.
  • tunnel_description_runner_interval - The interval set in hours to update the tunnel description when site names are changed by custom site group runner. Recommended value is 1 hour.
  • update_vsd_lat_long_value - For latitude, set the flag to the default value, true. Longitude value is updated in device/site metadata by the collector. If an update is required by some external system in NMS, set the flag to false.
  • fetch_tunnel_page_size - Size of the page to fetch the data from elastic search index for probes. The default value 5000.
  • fetch_tunnel_workers - Number of parallel probe fetchers per tunnel runner instance. The default value is 4.
  • send_tunnel_workers - Number of parallel tunnel data senders towards NMS. The default value is 4.
  • es_session_timeout - Elastic search session timeout value. The default value is 30 seconds.
  • tunnel_count_bucket_size - Tunnel count bucket size for sending towards NMS per device. The default value is 700.
  • sender_map - An array of mappings of destination IP address to one or more packet source IP addresses. This is an optional mapping of DNC to source IP addresses.
    • ip - Enter destination IP address of mapping.
    • port - Enter UDP port of mapping. Port must be 9996.
    • sources - Enter an array of packet source IP addresses of mapping.

    Example: enterprise_sevone_config.yaml

    ---
    ### Collector Configuration
    # MSP Name
    msp_name: ''
    # Enter tenant name
    tenant_name: ''
    
    ## Client must provide the NMS details
    sevone_api_host: '<NMS IP>'           # NMS Cluster Leader HostIP
    sevone_api_user: 'admin'              # NMS UI Login username
    sevone_api_password: 'SevOne'         # NMS UI Login password
    sevone_api_read_timeout: '30'         # SevOne API read timeout in seconds
    
    ## Client must provide the vendor specific data collector details.
    nuage_api_url: 'nuage url'      # Nokia Nuage Host IP or DNS name,, must be in the format https://<ip_address/DNS>:8443 and shouldn't be a forwarding slash at the end
    nuage_username: ''              # Nokia Nuage username
    nuage_password: ''              # Nokia Nuage password
    nuage_organization: 'csp'       # Configuration for nuage organization
    elasticsearch_host: ''          # Elasticsearch host IP
    elasticsearch_port: ''          # Elasticsearch host Port
    es_device_health: 'true'
    
    # AMQ Configuration
    amqp_username: ''
    amqp_password: ''
    amqp_topic: ''
    amqp_port: ''
    amqp_ip: ''
    
    
    # True when Upgrade collector and for first time installation it would be false
    collector_upgrade: 'false'
    flowaugmenter_upgrade: 'false'
    
    
    # Collector installation to be done on remote/local machine
    collector_install_mode: 'local'
    
    # Provide values for the following only if collector_install_mode is remote
    collector_vm_ip: ''                  # <VM-IP>
    collector_vm_username: ''            # <ssh-username>
    collector_vm_password: ''            # <ssh-password>
    
    
    ###FLOW AUGMENTOR CONFIGURATION
    #Set this to true to enable the flows data collection
    flow_enabled: 'false'
    
    # Provide values for the following only  if flow_enabled=true
    # Flow Augmenter installation to be done on remote/local machine
    flowaugmenter_install_mode: 'local'
    ## if flowaugmenter_install_mode is "local", only provide a valid json decoder count below, default is 1
    remote_flowaugmenters:
    ## if flowaugmenter_install_mode is "remote", provide a list of flow vms with IP, Username, Passwords and JSON-decoder-count for each as in the format below
    - flowaugmenter_vm_ip: ''          # VM IP
        flowaugmenter_vm_username: ''    # SSH Username
        flowaugmenter_vm_password: ''    # SSH Password
        json_decoder_count: '1'          # Specify number of json decoders, default is 1
    
    
    # Flominer destination address Could be DNC or NMS
    dnc_ip_address: ''
    dnc_flows_port: '9996'
    
    # Optional mapping of DNC to source IPs. (Added in v2.8)
    # Array of mappings of destination IP to one or more packet source IPs.
    #sender_map:
    #  - ip: 'Your-DNC-IP-1'
    #    port: '9996'
    #    sources:
    #      - 'Your-SRC-IP-1'
    #      - 'Your-SRC-IP-2'
    
    
    # For creating custom site group using device metadata.
    # If two devices has same name but case insensitive character it will create site with same which device got from REST-API response
    enable_custom_site_grouping: "false"
    
    # IMPORTANT PLEASE READ AND PROCEEED !!!!
    # UPDATING THIS FLAG AT YOUR OWN RISK.IF SET TO "true" THE TENANT NAME WILL NOT BE APPENDED TO DEVICE HOSTNAME AND
    # IN OBJECTS ASWELL.
    # DO NOT CHANGE THIS FLAG WHILE UPGRADING.
    unique_hostname_per_msp: 'false'
    
    #Set to 0 for regular poll interval collection, or else provide the number of seconds for offset
    collection_offset: "0"
    
    ### Update these values when need to enable individual poller
    # Preference is to set following flags to true, as it will run each runner in separate container and will make it optimum
    create_devices: 'true'
    enable_tunnel_stat_runner: 'true'
    enable_interface_stat_runner: 'true'
    enable_device_summary_runner: 'true'
    enable_interface_queue_stat_runner: 'true'
    enable_events_runner: 'true'
    enable_alarms_runner: 'true'
    enable_vport_poller: 'true'
    enable_lan_aggregation_poller: 'true'
    enable_apm_probe_stat_runner: 'true'
    enable_sla_stat_runner: 'true'
    enable_tunnel_description_runner: 'true'
    
    ## Collector logging configuration.
    log_severity: 'info'
    
    # Interval values for respective runners in minutes
    create_devices_interval: '30'
    tunnel_stat_runner_interval: '5'
    interface_stat_runner_interval: '5'
    device_summary_runner_interval: '5'
    interface_queue_stat_runner_interval: '5'
    events_runner_interval: '5'
    enable_lan_aggregation_vport_poller_interval: '5'
    apm_probe_stat_runner_interval: '5'
    sla_stat_runner_interval: '5'
    
    # Redis version configuration
    redis_password: 'nokia123!'
    redis_port: '6381'
    
    # Enable the flow view creation
    enable_flow_view_creation: 'true'
    
    # Interval value for installer in hours
    installer_interval: "24"
    
    flowaugmenter_log_level: 'info'
    
    ### Version 2.5 CHANGES
    # Deprecated flags in 2.5
    # augmenter_count: '1'
    
    # NEW FLAGS ADDED.
    # If the selfmon name is not empty then the collector will create the selfmon device
    # and push the alert if the VSD or elasticsearch is down
    sevone_selfmon_name: ''
    
    # If self_monitoring is true then it will create object for every poller and
    #  push memory and cpu usage of that container
    self_monitoring: 'false'
    
    ### Version 2.6.0 New Changes
    
    ## New Flags Added
    
    ## Distribute data across all peers
    # If you want to distribute data across all peer make distribute_on_all_peers flag as true
    #  and keep distribution_peers_list as default(empty)
    # e.g. distribute_on_all_peers: 'true' and distribution_peers_list: ''
    
    ## Distribute data across specific peers
    # If you want distribute data to specific peer keep distribute_on_all_peers to default(false)
    # and make distribution_peers_list as comma separated peer id list
    # e.g. distribute_on_all_peers: 'false' and distribution_peers_list: '1,2,3'
    
    ## No distribution
    # If you want don't want distribute data across other peers than keep both flag as default
    # e.g. distribute_on_all_peers: 'false' and distribution_peers_list: ''
    
    # NOTE: Please don't update below flags if using NMS version < 5.7.2.19
    distribute_on_all_peers: 'false'
    distribution_peers_list: ''
    
    # To enable flow object mapping script & set interval in hour, offset in minutes
    enable_flow_object_mapper: 'true'
    flow_object_mapper_interval: '24'
    
    # To enable flow interface speed updating script & set interval in hour
    enable_flow_interface_speed_runner: 'true'
    
    # To enable flow interface renaming script & set interval in hour
    enable_flow_interface_rename_runner: 'true'
    
    # -> Aggregation interval values for respective pollers in minutes default is 0
    # -> Aggregation interval should be equal or smaller than polling interval
    # -> Here 0 means non-aggregated data and for other it will aggregate data based on provided minute
    # ->e.g. aggregation interval is 5 minute, start time is 7:00 and current time is 7:15
    #   it will aggregate 5 minute data point to one and push with starting time of data
    #   here it would be like this,
    #   data is pushed at 7:00 (aggregated data of 7:00 to 7:05)
    #   data is pushed at 7:05 (aggregated data of 7:05 to 7:10)
    #   data is pushed at 7:10 (aggregated data of 7:10 to 7:15)
    device_summary_runner_aggregation_interval: '0'
    interface_stat_runner_aggregation_interval: '0'
    interface_queue_stat_runner_aggregation_interval: '0'
    tunnel_stat_runner_aggregation_interval: '0'
    lan_aggregation_and_vport_poller_aggregation_interval: '0'
    apm_probe_stat_runner_aggregation_interval: '0'
    # Enable the octets indicators for interface, vport, lan side aggregation and interface queue
    enable_octet_indicators: 'true'
    # Enable the packet indicator for interface, vport, lan side aggregation and interface queue
    enable_packet_indicators: 'false'
    # Comma separated string of optional indicator to enable
    # The acceptable values are CPU usage system, CPU usage user, Memory usage, Messages Sent, Data Messages Sent
    # e.g. filtered_indicator_list: 'CPU usage system, Memory usage'
    filtered_indicator_list: ''
    
    ### Version 2.6.8 New Changes
    
    ## New Flags Added
    
    # To enable dry-run mode
    dry_run: 'false'
    # If provided collector will fetch data for provided interval from current time.
    # Interval value is in Seconds
    # 0 will not fetch any previous data
    # only valid for 1st collector interval
    dry_run_interval: '0'
    
    #choose the below flags based on the number of tunnel runners required
    # for around 500K probe data points, 1 tunnel instance is recommanded , based on the incoming rate please increase the count below
    # 1 instance would consume 1 cpu and 3 GB RAM , VM is required to have resources accordingly
    # do not modify if aggregation is enabled
    total_tunnel_runner: '1'
    
    ### Version 2.8.0 New Changes
    
    ## New Flags Added
    #choose the below flags based on the number of apm probe runners required
    # for around 500K probe data points, 1 apm probe instance is recommanded , based on the incoming rate please increase the count below
    # 1 instance would consume 1 cpu and 3 GB RAM , VM is required to have resources accordingly
    # do not modify if aggregation is enabled
    total_apm_probe_runner: '1'
    sla_alert_cleanup_interval: '300'
    sla_fetch_pagesize: '100'
    tunnel_description_runner_interval: "1" # hours
    
    ### Version 2.13.0 New Changes
    ## New Flags Added
    
    # To enable LTE interface data collection
    enable_lte_interface_poller: 'true'
    # Provide interval in minute
    lte_interface_poller_interval: '5'
    # LTE interface elasticsearch page size
    lte_interface_poller_page_size: 5000
    # LTE interface runner interval in hour
    lte_interface_runner_interval: '24'
    # Buffer size to bulk update object metadata
    lte_interface_runner_nms_buffer_size: 500
    
    ### Version 2.14.0 New Changes
    ## New Flags Added
    
    # To enable ike data collection
    enable_ike_tunnel_poller: 'true'
    enable_ike_probe_poller: 'true'
    # Provide interval in minute
    ike_tunnel_poller_interval: '5'
    ike_probe_poller_interval: '5'
    # ike tunnel/probe elasticsearch page size
    ike_tunnel_poller_page_size: 5000
    ike_probe_poller_page_size: 5000
    # Buffer size to bulk update object metadata for ike
    ike_object_runner_nms_buffer_size: 500
    # interval to update object groups for IKE tunnel and IKE probe binding
    # it would only impact if both ike tunnel and ike probe collection is enabled
    ike_object_group_update_interval: '24'

Check Installation

  1. Check that docker images for Nuage Networks Collector are imported using the following command.

    Check docker images for Nuage Networks Collector

    Example

    $ docker images
    
    REPOSITORY                                             TAG                  IMAGE ID       CREATED       SIZE
    docker.sevone.com/soa                                  v6.7.0-build.59      80707a5fb531   2 days ago    895MB
    docker.sevone.com/cloud-monitoring/aws-nms-collector   cccee6cc             a3ecd856fc2b   4 days ago    76.5MB
    docker.sevone.com/sc/collectors/nokia-nuage            6.8.0-build.268036      14c886965333   4 days ago    237MB
    redis                                                  7.0.13-alpine        992e4a48ecfc   5 weeks ago   30.2MB
    Note: In case of remote installation, please check the docker images on the remote appliance. You can ssh into the remote appliance and check if the docker images for SD-WAN Nuage Networks Collector are loaded.
  2. The following docker containers must be running for the Nuage Networks Collector.

    Check docker containers for Nuage Networks Collector

    Example

    $ docker ps
    
    CONTAINER ID   IMAGE                                                            COMMAND                  CREATED              STATUS              PORTS                                                 NAMES
    eb828fa6fd8c   docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036      "python3 src/main.py"    About a minute ago   Up About a minute
                                                nuage_alarm_runner_Nuage2-Corp1
    c634816f3cf1   redis:6.8.13-alpine                                              "docker-entrypoint.s…"   2 minutes ago        Up 2 minutes        6379/tcp, 0.0.0.0:6381->6381/tcp, :::6381->6381/tcp   nuage-redis
    2012e841e406   docker.sevone.com/soa:v6.8.0-build.v6.7.0-build.59                           "/entrypoint.sh"         27 hours ago         Up 27 hours
                                                soa                      
    
    Note: There must be at least these containers up and running if Flow Augmenter is installed locally. In case of remote installation, please check the docker containers on the remote appliance. You can ssh into the remote appliance and check if the docker containers for SD-WAN Nuage Networks Collector are running.
  3. Execute the following commands to ensure the cronjobs are set and running. The install script sets the cron jobs to run the collector and delete the containers.

    Check cronjobs - cat /etc/cron.d/nuage_<tenant_name> shows the cronjobs for the given tenant name

    #Ansible: Nuage2-Corp1 nuage create devices
    */30 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_create_devices_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e CREATE_DEVICES=true  docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_create_devices_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage tunnel stat runner 1
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_tunnel_stat_runner_Nuage2-Corp1_1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_TUNNEL_STAT_RUNNER=true -e TUNNEL_RUNNER_NUMBER=1 docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_tunnel_stat_runner_1_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage apm probe stat runner 1
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_apm_probe_stat_runner_Nuage2-Corp1_1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_APM_PROBE_STAT_RUNNER=true -e APM_PROBE_RUNNER_NUMBER=1 docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_apm_probe_stat_runner_1_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage interface stat runner
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_interface_stat_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_INTERFACE_STAT_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_interface_stat_runner_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage device summary runner
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host  --name nuage_device_summary_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_DEVICE_SUMMARY_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_device_summary_runner_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage interface queue stat runner
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_interface_queue_stat_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_INTERFACE_QUEUE_STAT_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_interface_queue_stat_runner_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage sla stat runner
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_sla_stat_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_SLA_STAT_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_sla_stat_runner_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage device description runner
    */15 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_device_description_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_DEVICE_DESCRIPTION_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_device_description_runner_6.8.0-build.268036.log 2>&1
    #Ansible: nuage Nuage2-Corp1 installer
    0 */24 * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm --name=nuage_installer_Nuage2-Corp1 --net=host --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e INSTALL=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_installer_logs_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage event runner
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm --name=nuage_event_runner_Nuage2-Corp1 --net=host --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_EVENTS_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_event_logs_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage tunnel description runner
    0 */1 * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm --name=nuage_tunnel_description_runner_Nuage2-Corp1 --net=host --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_TUNNEL_DESCRIPTION_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_tunnel_description_logs_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage vport and lan aggregator poller
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm --name=nuage_vport_and_lan_poller_Nuage2-Corp1 --net=host --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_VPORT_POLLER=true -e ENABLE_LAN_AGGREGATION_POLLER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_vport_lan_aggregator_poller_logs_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage LTE interface interface poller
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_lte_interface_poller_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_LTE_INTERFACE_POLLER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_lte_interface_poller_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage LTE interface interface runner
    0 */24 * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_lte_interface_runner_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_LTE_INTERFACE_RUNNER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_lte_interface_runner_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage IKE Tunnel poller
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_ike_tunnel_poller_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_IKE_TUNNEL_POLLER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_ike_tunnel_poller_6.8.0-build.268036.log 2>&1
    #Ansible: Nuage2-Corp1 nuage IKE Probe poller
    */5 * * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_ike_probe_poller_Nuage2-Corp1 --env-file /opt/sdwan-nuage/Nuage2-Corp1/runner-settings.env -e ENABLE_IKE_PROBE_POLLER=true docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 >> /var/log/sdwan-nuage/Nuage2-Corp1/6.8.0-build.268036/Nuage2-Corp1_nuage_ike_probe_poller_6.8.0-build.268036.log 2>&1  

    cat /etc/cron.d/nuage_interface_crons

    0 */1 * * * root docker run --log-opt max-size=10m --log-opt max-file=1 --rm  --net=host --name nuage_interface_speed_runner_SEVONE_ENTERPRISE1 --workdir /nokia-nuage/automation/scripts/flow_overwrite_script/ --entrypoint "/usr/local/bin/python3"  docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 "/nokia-nuage/automation/scripts/flow_overwrite_script/flow_interface_speed_updater.py" --tenant_name "SEVONE_ENTERPRISE1" --nms_host "10.128.0.1" --nms_username "admin" --msp_name "NOKIA::SDWAN" --nms_password "SevOne" --nms_soap_username "admin" --nms_soap_password "SevOne" --secure false >> /var/log/sdwan-nuage/SEVONE_ENTERPRISE1/interface_speed_log 2>&1


    cat /etc/cron.d/nuage_flow_object_mapping_crons

    #Ansible: SEVONE_ENTERPRISE1 nuage flow object mapping script
    0 */24 * * * root docker run --rm  --net=host  --name nuage_flow_object_mapping_SEVONE_ENTERPRISE1 --env-file /opt/sdwan-nuage/SEVONE_ENTERPRISE1/runner-settings.env --entrypoint python3 docker.sevone.com/sc/collectors/nokia-nuage:6.8.0-build.268036 "/nokia-nuage/src/solutions_util/src/scripts/flow_override_script/flow_object_mapping.py" --mapping-type=interface >> /var/log/sdwan-nuage/SEVONE_ENTERPRISE1/develop-4054f235/flow_object_mapping.log 2>&1

    Check the following cron entries on Virutal Machine from which the deployment script is running


    cat /etc/cron.d/nuage_interface_crons

    #Ansible: SEVONE_ENTERPRISE1 nuage interface renaming script
    0 */24 * * * root cd /opt/sdwan-nuage/SEVONE_ENTERPRISE1/flow_overwrite_script/ && ./overwrite_flow_interface --tenant_name="SEVONE_ENTERPRISE1" --msp_name="NOKIA::SDWAN" --nms_username="admin" --nms_password="SevOne" --nms_soap_username="admin" --nms_soap_password="SevOne" >> /var/log/sdwan-nuage/SEVONE_ENTERPRISE1/interface_renaming.log 2>&1
    Note: SEVONE_ENTERPRISE1 in the above examples is the tenant name.

Upgrade Collector

using Graphical User Interface

Warning: Nokia-Nuage SSU (Self-Service Upgrade) does not offer support for multi-tenancy and multi-DNC.
Important: Nokia-Nuage SSU only allows SevOne NMS to be upgraded to 6.8 after installing the SSU RPM file.

Execute the following steps to upgrade SD-WAN Nokia-Nuage Collector using Graphical User Interface (GUI).

  1. Using ssh, login to NMS appliance as root.
    $ ssh root@<NMS appliance>

    Example: Currently on SD-WAN Nokia-Nuage Collector 6.7 and to be upgraded to SD-WAN Nokia-Nuage Collector 6.8

    $ ssh root@10.49.14.111
  2. Make a directory.
    $ mkdir -p /opt/SevOne/upgrade/ansible/playbooks
  3. 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 /root directory.
    1. sdwan-nuage-installation-v6.8.0-build.268036.tgz
    2. sdwan-nuage-installation-v6.8.0-build.268036.tgz.sha256.txt
    3. signature-tools-latest-version-build.<###>.tgz. For example, signature-tools-2.0.2-build.1.tgz
    4. signature-tools-latest-version-build.<###>.tgz.sha256.txt. For example, signature-tools-2.0.2-build.1.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. Extract the .tgz file.
    $ cp sdwan-nuage-installation-v6.8.0-build* /opt/SevOne/upgrade
    
    $ cd /opt/SevOne/upgrade && tar xvzf /opt/SevOne/upgrade/sdwan-nuage-installation*.tgz -C /opt/SevOne/upgrade/ansible/playbooks/
  6. Change directory to /opt/SevOne/upgrade/ansible/playbooks/.
    $ cd /opt/SevOne/upgrade/ansible/playbooks/
  7. Run the migration script to move the existing configuration from the main.yml file to the tenant configuration file.
    Important: You must perform this step when upgrading from SD-WAN <=6.5 to SD-WAN 6.8.
    $ ./migrate_config -src /root/<Previous Installation Folder Name>/nuage/defaults/main.yml -dest /opt/nuage_ansible/config/<tenant name.yaml>

    Example

    $ ./migrate_config -src /root/sdwan-nuage-installation-6.6.0/nuage/defaults/main.yml -dest /opt/nuage_ansible/config/enterprise_sevone_config.yaml
    Important: It is important to have a single .yaml file in /opt/nuage_ansible/config directory. If multiple files are present, the installer will interpret it as a multi-tenant deployment. In such cases, it is recommended to use the CLI method for upgrading the collector.
  8. Install the GUI.
    $ sh setup_ssu.sh

    Example: The command returns the following

    ******************************************************************************
    
    SEVONE GUI INSTALLER
    
    Please open https://10.49.14.111:3000 in your web browser to access the GUI Installer.
    
    Your credentials are:
    - Username: admin
    - Password: nRxOGboum-
    
    If you ever lose your credentials, they are stored in:
    /etc/sevone-guii/creds
    
    ******************************************************************************

    You are now ready to install using the Graphical User Interface Installer .

  9. Using a web browser of your choice, enter the URL the setup script has returned. For example, https://10.128.9.13:3000. Nokia GUII Installer Start
    Note: You will also need the credentials (Username and Password) that the setup script returns. These credentials are also stored in /etc/sevone-guii/creds file.
    $ cat /etc/sevone-guii/creds | jq   
    
    {
        "password": "nRxOGboum-",
        "tokenSecret": "oPtlOAXDQpCEQBmwVEcVEOREhAkSPBol",
        "username": "admin"
    }
  10. Click Update Cluster to update SD-WAN Nuage Collector. For example, upgrade from SD-WAN Nuage Collector 6.7.0+243695 to SD-WAN Nuage Collector 6.8.0+268036.
  11. Enter the credentials returned to perform the Self-Service Upgrade. For example, Username: admin and Password: nRxOGboum-
    Nokia GUII Installer Credential
    Note: To use the Graphical User Interface installer in dark theme, click GUI Installer dark theme next to SevOne.

    For help on what each upgrade step does, click GUI Installer help button in the upper-right corner.
    Important: All the screenshots below are based on the example being used to write this document. Your total number of tasks passed (ok) , skipped , failed , ignored , unreachable , or unexecuted will vary based on your setup. The tasks failed must be addressed as ansible has not ignored them.
  12. The graphical user interface installer checks the Current Version and the Upgrade Available version. If the current version is older than the upgrade version available, you are now ready to continue to Configure. Nokia GUII Installer Check Version
    Important: EXAMPLE
    Current Version is on SD-WAN Nuage Collector 6.7.0+243695.
    Upgrade Available version is SD-WAN Nuage Collector 6.8.0+268036.
    Important: During the Self-Service Upgrade, if you experience network connectivity issue or the upgrade has been halted for any reason, the self-service upgrade will resume from the step where it left off after the issue is resolved. However, if you are at the Upgrade step and the self-service upgrade has been halted for any reason, self-service upgrade will show a message requesting you to contact IBM SevOne Support.

    To resume with the Self-Service Upgrade, using a web browser of your choice, re-enter the URL the setup script has returned. For example, https://10.49.14.111:3000.
  13. Click the Continue to Configure button to configure SD-WAN Nuage chart values, if required.
    Important: If you do not want to configure the chart values, click Continue button to start the upgrade.
    Nokia GUII Installer Configure
    1. From Configuration drop-down, choose a configuration file from the list. For example, the primary configuration file is solutions-sdwan-nuage_custom_guii.yaml. If SD-WAN Nuage collector has already been configured, you can select that configuration from the drop-down list to edit it. If multiple configuration files are present for the same tenant, the files will be applied in the alphabetical order.
      Important: Please ignore warnings related to the runner intervals. These configurations will be automatically migrated to the cron configuration from existing cron jobs.
      Nokia GUII Installer Configure Primary
    2. Configure
      • NMS/PAS IP - The IP address of the SevOne NMS Appliance.
      • NMS/PAS GUI Username - GUI username of the NMS / PAS.
      • NMS/PAS GUI password - GUI password of the NMS / PAS.
      • DNC/NMS IP address - The IP address of the NMS / DNC, where the augmented flow must be sent.
      • DNC/NMS Flows Port - Port of DNC, where the flows are sent.
      • VSD Host IP or DNS name - The IP address or DNC of targeted Virtualized Services Directory (VSD).
      • VSD username - The username for the VSD.
      • VSD password - The password for the VSD.
      • Nuage organization - The organization for the VSD.
      • Elasticsearch host IP - The elasticsearch host IP.
      • Elasticsearch host Port - The elasticsearch host port.
      • Collect Data from ElasticSearch - Collect data from elasticsearch.
      • ActiveMQ username - The username of the Messaging Service (ActiveMQ) broker. The format must be %40. For example, sevone%40csp, where sevone is the username and csp is the organization.
      • ActiveMQ password - The password of the Messaging Service (ActiveMQ) broker.
      • ActiveMQ Topic name - Topic to subscribe to the Messaging Service (ActiveMQ) broker. The format must be topic/<topic_name>. For example, topic/CNAAlarms, where CNAAlarms is the topic name.
      • ActiveMQ Port - Port of the Messaging Service (ActiveMQ) broker. The default port is 5672.
      • ActiveMQ IP - The IP address of the Messaging Service (ActiveMQ) broker.
      • Collector installation on remote/local - The mode of installation for the collector. local installs the collector on the same NMS where the script is running.
      • Collector IP - The IP address of the Virtual Machine where collector needs to be installed.
      • Collector ssh username - The SSH username of the VM for collector installation.
      • Collector ssh password - The SSH password of the VM for collector installation.
      • Upgrade Collector - Flag to upgrade the collector.
      • Collector Log Level - Defines the log-level for the collector. Value can be info or debug or error. The default value is info.
      • Enable flow data collection - Flag to enable flow data collection.
      • Flow Augmenter installation on remote/local - The mode of installation for Flow Augmenter.
      • List of Flow VMs - List of Details of VMs where Flow Augmenter needs to be installed.
      • Augmenter Log Level - Defines the log-level for the augmenter. Value can be info or debug or error. The default value is info.
      • Upgrade Flow Augmenter - Flag to upgrade the augmenter.
      • MSP Name - The Managed Service Provider name to which the configured tenant level Orchestrator belongs to. The MSP name can be of your choice.
      • Tenant Name - The tenant name is the Enterprise name that matches with the tenant/enterprise name available in VSD, for the data that needs to be collected.
      • Self monitoring device name - Device name for self monitoring of the Nuage collector.
      • Distribute data across all NMS peers - The flag if set to true, will distribute the devices across the cluster on its own on all the peers. However, if set to false, it will send data to local peer or given list of peers (if provided). The default value is false.
      • Distribution Peers list - The flag expects a list of peers to distribute data. This flag is ignored if Distribute data across all NMS peers flag is true. It is empty by default.
      • q<#>_name- Allows you to change the names of the interface queues as per the user requirements. During installation, if the interface queue names are changed, the same names must be retained during the upgrade or else, new interface queue objects will be created with the new names set during the upgrade. The default interface queue names are q1, q2, q3, q4, and q10.
      • Nuage API version - API version that is compatible with VSD.
      • Create custom site group using device metadata - Flag for creating a custom site group using device metadata. If two devices have the same name (matching of name is case insensitive), it will create the site with the name from the REST-API response. The default value is false.
      • Unique device hostname per MSP - When all the device hostnames are unique across all the tenants, set it to true. This flag is to avoid suffixing the tenant name to the device name. The default value is false.
      • Enable FlowView creation - If the default Nuage Flow View is created at the time of deployment, set the value to true.
      • Update VSD Lat Long value - For latitude, set the flag to the default value, true. Longitude value is updated in device/site metadata by the collector. If an update is required by some external system in NMS, set the flag to false.
      • Enable Self Monitoring - Flag to enable self monitoring. It will create Objects and Indicators for a selfmon device and is set to true. The default value is false.
      • Enable Flow object mapper - Flag to run the flow object mapper. It maps the flow interfaces to the interface objects. The default value is true.
      • Create Devices - Flag to determine devices to be created. If set to true, it will create all devices. If set to false, devices with no data will not be created. The default value is true.
      • Enable Tunnel stat Runner - Flag to run the tunnel stats runner in a separate container for better performance. The default value is true.
      • Enable Interface stat Runner - Flag to run the interface stats runner in a separate container for better performance. The default value is true.
      • Enable Device Summary Runner - Flag to run the device summary runner in a separate container for better performance. The default value is true.
      • Enable Interface Queue stat Runner - Flag to run the queue interfaces runner in a separate container for better performance. The default value is true.
      • Enable Events Runner - Flag to run the events runner in a separate container for better performance. The default value is true.
      • Enable Alarms Runner - Flag to run the alarms runner in a separate container for better performance. The default value is true.
      • Enable vport Poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates raw vport objects. The default value is true.
      • Enable Lan Aggregation Poller - Flag to run the vport & aggregation runner in a separate container for better performance. It creates the aggregated vport objects at the subnet and domain level. The default value is true.
      • Enable APM probe stat Runner - Flag to run the APM probe runner in a separate container for better performance. The default value is true.
      • Enable SLA stat Runner - Flag to run the SLA runner in a separate container for better performance. The default value is true.
      • Enable Tunnel description Runner - Flag to run the Tunnel description runner in a separate container for better performance.
      • Enable Flow Interface speed runner - Flag to run the flow interface speed runner. It updates the interface speed for the flow interfaces. The default value is true.
      • Enable flow interface rename runner - Flag to run the flow interface rename runner. It renames the flow interfaces to show the interface name instead of ifIndex. The default value is true.
      • Enable Octet Indicators - Flag to enable octet indicators.
      • Enable Packet Indicators - Flag to enable packet indicatos.
      • Enable LTE Interface Poller - Flag to enable / disable LTE data collection. The default value is true.
      • Enable Device Description Runner - Flag to run the device description runner in a separate container for better performance. The default value is true.
      • SevOne API read Timeout - The read timeout for the SevOne REST API connection. The default value is 30 seconds.
      • Collection Offset - Represents the number of seconds the collector runs in delay from the current time. Set to 0 for regular poll interval collection. Provide the number of seconds for the offset from the current time. For example, if the value is set to 300 (in seconds), the collector collects the data until 5 minutes before the collector's run time. The default value is 0.
      • Create Devices Runner Interval - Interval set in minutes to run the runner. Recommended value is 30 minutes.
      • Tunnel stat Runner Interval - Interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes.
      • Interface stat Runner Interval - Interval set in minutes to run the interface stat runner. Recommended value is 5 minutes.
      • Device Summary Runner Interval - Interval set in minutes to run the device summary runner. Recommended value is 5 minutes.
      • Interface Queue stat Runner Interval - Interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes.
      • Events Runner Interval - Interval set in minutes to run the events runner. Recommended value is 5 minutes.
      • vport & aggregation Runner Interval - Interval set in minutes to run the vport & aggregation runner. Recommended value is 5 minutes.
      • APM probe stat Runner Interval - Interval set in minutes to run the APM probe runner. Recommended value is 5 minutes.
      • SLA stat Runner Interval - Interval set in minutes to run the SLA runner. Recommended value is 5 minutes.
      • Custom Site Group Runner Interval - The interval set in hours for the custom site group creation. Recommended value is 1 hour.
      • Device Description Runner Interval - The interval set in minutes to update the device description to apply the device group rules on it. Recommended value is 15 minutes.
      • Installer Interval - Interval value of installer. Recommended value is 24 hours.
      • Flow Object Mapper Interval - The interval set in hours for the flow object mapper Recommended value is 24 hour.
      • device_summary_runner_aggregation_interval - Aggregation interval set in minutes to run the device summary runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • interface_stat_runner_aggregation_interval- Aggregation interval set in minutes to run the interface stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • interface_queue_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the interface queue stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • tunnel_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the tunnel stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • lan_aggregation_and_vport_poller_aggregation_interval - Aggregation interval set in minutes to run the vport & lan aggregation runner. Only aggregated data is pushed. Recommended value is 5 minutes. If the interval value is set to 0 then it will not push any data.
      • apm_probe_stat_runner_aggregation_interval - Aggregation interval set in minutes to run the APM probe stat runner. Recommended value is 5 minutes. If the interval value is set to 0 then it will push non-aggregated data.
      • Redis Password - The install script sets the password for the redis.
      • Redis Port - Default Redis port is port 6381.
      • Fetch Tunnel Page Size - Size of the page to fetch the data from elastic search index for probes. The default value 5000.
      • fetch_tunnel_workers - Number of parallel probe fetchers per tunnel runner instance. The default value is 4.
      • send_tunnel_workers - Number of parallel tunnel data senders towards NMS. The default value is 4.
      • ES Session Timeout - Elastic search session timeout value. The default value is 30 seconds.
      • tunnel_count_bucket_size - Tunnel count bucket size for sending towards NMS per device. The default value is 700.
      • Filtered Indicator List - Comma separated list of indicators that will be filtered/enabled.
      • Enable Dry run - Flag to enable/disable the dry-run mode. The default value is false.
      • Dry run Interval - Duration for running Nokia collector in dry-run mode. The default value is 0 seconds.
      • Total Tunnel Runner - Flag to set the total tunnel runner instances required for fetching data points. Recommended value is 1 instance. For example, 1 tunnel instance fetches around 500k probe data points. Based on the incoming rate, increase the instance count. NOTE: Please do not change the default instant count value if you want to use the aggregation for the tunnel data.
      • Total APM probe Runner - Flag to set the total APM probe runner instances required for fetching data points. Recommended value is 1 instance.
      • SLA Alert Cleanup Interval - Time to keep the violation alerts in NMS as active. Violation alerts get deleted when violation alert timestamp and sla_alert_cleanup_interval are <= current timestamp. The default value is 300 seconds.
      • SLA fetch pagesize - Flag to configure the SLA fetch page size. The default value is 100.
      • Tunnel Description Runner Interval - The interval set in hours to update the tunnel description when site names are changed by custom site group runner. Recommended value is 1 hour.
      • LTE Interface Poller Interval - Interval set in minutes to for LTE data collection. The default value is 5 minutes.
      • LTE Interface Poller Page Size - Flag to configure elastic search page size for LTE data collection. The default value is 5000.
      • LTE interface runner Interval - Interval set in hours to run the LTE interface runner. The default value is 24 hours. It creates object groups, rules, and object metadata. LTE interface runner is enabled / disabled based on the Enable LTE Interface Poller flag.
      • LTE interface runner NMS buffer size - Flag for updating the buffer size for object metadata in bulk. The default value is 500.
      • Enable IKE tunnel Poller - Flag to enable / disable data collection for IKE tunnel objects. The default value is true.
      • IKE Tunnel Poller Interval - Interval set in minutes to run the IKE tunnel runner. The default value is 5 minutes.
      • Enable IKE Probe Poller - Flag to enable / disable data collection for IKE probe objects. The default value is true.
      • IKE Probe Poller Interval - Interval set in minutes to run the IKE probe runner. The default value is 5 minutes.
      • IKE Tunnel Poller page size - Flag to configure elastic search page size for the data collection of IKE tunnel objects. The default value is 5000.
      • IKE Probe Poller page size - Flag to configure elastic search page size for the data collection of IKE probe objects. The default value is 5000.
      • IKE Object Runner NMS buffer size - Flag for updating the buffer size for object metadata related to IKE tunnels and probes in bulk. The default value is 500.
      • IKE Object Group update interval - Interval set in hours to update the object groups related to IKE tunnel and IKE probe. The default value is 24 hours. The value must be set only when Enable IKE tunnel Poller and Enable IKE Probe Poller are set to true.
      • template_send_frequency - The frequency at which the IPFIX data template is sent at DNC.
      • flominer_receiver_read_buffer - The flowminer receiver buffer size.
      • flow_collection_interval - The interval in seconds at which flow collection must happen. The default value is 300 seconds.
      • flow_fetch_workers - The number of parallel fetching threads the elastic search receives to fetch the flows. The default value is 2.
      • flow_send_workers - The number of parallel processing threads that process the flow data points and send to rabbitmq for decoder. The default value is 4.
      • flow_fetch_pagesize - The page size to fetch by the elasticsearch query for the flows. The default value is 5000.
  14. Click Save. Configuration is saved in /opt/nuage_ansible/config/enterprise_sevone_config.yaml.
    Important: Once the configuration is saved, click Continue button to Upgrade.
  15. Click Continue button to Upgrade. Nokia GUII Installer Run Upgrade
  16. Click the Run Upgrade button to run the upgrade. This can take a few minutes to run. Nokia GUII Installer Upgrade Completed
    Note: To view the logs for a task, click GUI Installer Eye Icon for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.

    SD-WAN Nuage Collector upgrade has now completed.

    Note: The task list can be long. Search tasks capability is available to search for text you are looking for in the task list.
  17. Click the Continue button. Nokia GUII Installer Upgrade Finished
    Important: This indicates that the upgrade has completed successfully.
    Important: If there was a kernel upgrade for this release, it is recommended to reboot the cluster after the deployment to install the right kernel version.
  18. You may now click the link Click Here.
  19. Link Click Here will launch SevOne Data Insight, where you can view the data collected by the collector.Nokia GUII Installer Launch After Upgrade
Important: Example: Upgrade not required
If you are already on the version you are trying to upgrade to, you will get the You can proceed with redeploy/install message. This allows you to upgrade to a later version, if available. Nokia GUII Installer Redeploy Or Install

FAQs

Change Ports

  1. For details on default port numbers and its respective config file locations for the client and the API, please refer to SevOne NMS Port Number Requirements Guide > section Solutions Deployment > for SD-WAN Nokia-Nuage collector.
  2. The following table lists the default port numbers and its respective config file location for the client and API.
    Name Default Port Config File Location
    Client 3000 /etc/sevone-guii/client.yaml
    API 3001 /etc/sevone-guii/api.yaml
  3. If you need to change the port number, using a text editor of your choice, edit the .yaml file to change the setting and save the file.

    Example: Change port number for Client

    $ vi /etc/sevone-guii/client.yaml
    main:
      port: 3000  # <-- change port number

    Example: Change port number for API

    $ vi /etc/sevone-guii/api.yaml
    main:
      port: 3001  # <-- change port number
  4. Restart the client and API services.
    Important: In case of any configuration changes, you need to restart both client and API services.
     xml:space="preserve" outputclass="bash">
    $ sudo systemctl restart sevone-guii-@api
    
    $ sudo systemctl restart sevone-guii-@client
    

Manage Services

The graphical user interface installer services can be started / stopped using the standard systemd commands.


$ 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

View Logs

The logs can be viewed using journalctl.

$ journalctl -u sevone-guii-@api [-f]
 
$ journalctl -u sevone-guii-@client [-f]

Clear ARA Status

When running incremental upgrades, ARA (Ansible Run Analysis) status from the previous upgrade must be cleared. Execute the following command to clear the ARA status.

$ rm /etc/sevone-guii/ara/server/ansible.sqlite
  
$ sudo systemctl restart ara-server

using Command Line Interface

  1. Using ssh, login to NMS appliance as root.
    $ ssh root@<NMS appliance>
  2. Backup the existing config files to use as a reference.
    $ export NUAGE_BACKUP_DATE=$(date +%s) && mkdir -p /opt/SevOne/upgrade/sdwan-nuage-config-backup-$NUAGE_BACKUP_DATE && cp /opt/nuage_ansible/config/* /opt/SevOne/upgrade/sdwan-nuage-config-backup-$NUAGE_BACKUP_DATE
  3. Make a directory.
    $ mkdir -p /opt/SevOne/upgrade/ansible/playbooks
  4. 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 /root directory of SevOne NMS appliance.
    1. sdwan-nuage-installation-v6.8.0-build.268036.tgz
    2. sdwan-nuage-installation-v6.8.0-build.268036.tgz.sha256.txt
    3. signature-tools-latest-version-build.<###>.tgz. For example, signature-tools-2.0.2-build.1.tgz
    4. signature-tools-latest-version-build.<###>.tgz.sha256.txt. For example, signature-tools-2.0.2-build.1.tgz.sha256.txt
  5. 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 /
  6. Extract the .tar.gz file.
    $ cp sdwan-nuage-installation-v6.8.0-build* /opt/SevOne/upgrade
    
    $ cd /opt/SevOne/upgrade && tar xvzf /opt/SevOne/upgrade/sdwan-nuage-installation-*.tgz -C /opt/SevOne/upgrade/ansible/playbooks/
    Note: You will find sample_config.yaml file in /opt/SevOne/upgrade/ansible/playbooks/config directory.
  7. Change directory to /opt/SevOne/upgrade/ansible/playbooks/.
    $ cd /opt/SevOne/upgrade/ansible/playbooks/
  8. Run the migration script to move the existing configuration from the main.yml file to the tenant configuration file. You can use the migrated configuration file as a reference for the next step.
    Important: You must perform this step when upgrading from SD-WAN <=6.5 to SD-WAN 6.8.
    $ ./migrate_config -src /root/<Previous Installation Folder Name>/nuage/defaults/main.yml -dest /opt/nuage_ansible/config/<tenant name.yaml>

    Example

    $ ./migrate_config -src /root/sdwan-nuage-installation-6.5.0/nuage/defaults/main.yml -dest /opt/nuage_ansible/config/enterprise_sevone_config.yaml
  9. Using the text editor of your choice, configure sample_config.yaml file for each tenant based on the current config values present in the default file /opt/nuage_ansible/config.
    Important: Make sure to set the following variables to true for each tenant config file.
    • collector_upgrade: 'true'
    • flowaugmenter_upgrade: 'true'
    1. Copy the config file to the config directory and navigate to it.
      Important: This step will overwrite the existing config files with the new ones received in the package. This is necessary as new configurations have been added in SD-WAN 2.13. Please ensure that existing config files have been backed up.
      $ cp -f /opt/SevOne/upgrade/ansible/playbooks/config/* /opt/nuage_ansible/config
  10. You are now ready to upgrade the Nuage Networks Collector. Run nuage deployment script.
    $ sh deploy_nuage.sh
  11. To ensure that upgrade has completed successfully, perform the steps in Check Installation.
CAUTION:
Do not rename devices or objects created by the SD-WAN collector. By doing so, you could potentially break data collection. If a custom name is required, please use the alternative name fields.

Optional Configuration

Object Mapping

The Object Mapping page enables you to map the indicators on the objects that plugins poll to a flow interface. This enables you to display a FlowFalcon report of the flow data that is related to the poll data from an indicator that appears in an Instant Graph.

Users can generate FlowFalcon report for Object Group on the basis of Object mapping. As of SDWAN Nokia-Nuage 2.13 release, the solution will create Object mappings by default for SD-WAN Interface Objects. For any other objects, users will have to manually add the Object mappings. Steps required to manually add an object mapping can be found in SevOne NMS System Administration Guide > section Map Flow Objects.

Important: The device interface object indicator should be mapped to the appropriate direction Incoming/Outgoing.

Mapping a device interface object Nokia Object Mapping

After adding the object mapping, the user is now able to quick chain the performance metrics report to the FlowFalcon report for the indicator. Follow the steps below to see the flows report for the mapped object and the indicator.

  • Navigate to Reports > Create Report. Select Performance Metrics.
  • Select appropriate Resources the same as the mapped object and the indicator.
  • Create the Performace Metrics report by clicking on Finish. A Performance Metrics report will be generated.
  • Click on the Setting icon on the top-right corner of the report. Select Chain > Quick Chain.

    Performance Metrics Report

    Nokia Performance Metrics Report
  • This will automatically create the chained FlowFalcon for the selected object and the indicator as shown in the image below.

    Quick Chain Report

    Nokia Quick Chain Report

Configure Custom Sites

Execute the following steps to configure custom sites for the Nokia-Nuage collector.

  1. To access the SevOne NMS login page, navigate to the appropriate URL in your browser.
  2. From the navigation bar, click on Devices menu and select Device Manager.
  3. Select the device and click on Edit metadata under the Actions column to display the Edit Metadata pop-up to manage the values for the metadata attributes you want to associate with the device.
  4. Scroll-down to SDWAN_GENERIC.
    NMS Nuage Edit Metadata
  5. Place your cursor on the Site Name you want to provide a custom name to and click on Wrench icon. NMS Nuage Edit Metadata SN
  6. Enter the Site Name in the text field available and click on the Update button. For example, nokiaNuageSN.
    Note: > Site Name does not support the following characters
    • forward-slash - /
    • back-slash - \\
    • double-colon - ::
    • double-quotes - "
    • less-than - <
    • greater-than - >
    • pipe - |
    • tab
    • new-line
    NMS Nuage Edit Metadata SN Update
  7. Click on Save button to save the custom Site Name.
    NMS Nuage Edit Metadata SN Save
    Important: Since the cronjobs run every 1 hour, it can take at most 1 hour for the update to take effect.

Add / Remove Tenant to Running Collector

Add Tenant

  • You are not required to stop the collector to add a new tenant. To add a new tenant, follow the steps in Add Tenant.
  • After the tenant has been added, follow the steps in Run Deployment Script.
  • To see cronjobs for a tenant, follow the steps under Check Cronjobs.

Remove Tenant

To stop collecting data from a tenant, follow the steps below.

  1. Execute the following command to manually remove the cronjobs. This will stop collecting the data for a specific tenant.

    Remove Tenant

    $ rm /etc/cron.d/nuage_<tenant_name>
    
    $ rm /etc/cron.d/nuage_<tenant_name>_flow_collector
    
    $ rm /etc/cron.d/nuage_* # check for other files with nuage prefix , if they have tenant specific cronjob then remove it
    
    $ rm /opt/nuage_ansible/config/<tenant_name>_config.yaml
    
    $ rm /opt/sdwan-nuage/<tenant-name>/*
    
    $ docker stop nuage_alarm_runner_<tenant_name>
    
    $ docker rm nuage_alarm_runner_<tenant_name>
    Note: Default location for config directory is /opt/nuage_ansible/config. If config files are in a different location, remove the <tenant>_config.yaml file from that location.
  2. After stopping the collection of data for the tenant, manually cleanup to remove the tenant specific data from the NMS. To purge the flow data, from the navigation bar, go to Administration, select Flow Configuration, and then select Flow Interface Manager. Select the devices from the list specific to the tenant, click on the Wrench icon and Purge Device Flows. Purge Flows
  3. To finally delete the data, select the devices specific to the tenant from the list on the Flow Interface Manager, click on the Delete Device Rules button. Purge Flows
  4. To delete the tenant device group, from the navigation bar, go to Devices, select Grouping, and then select Device Groups. Hover over the tenant device group and click on Trash can icon. Click on OK to confirm. Delete Tenant device groups
  5. To delete the tenant object group, from the navigation bar, go to Devices, select Grouping, and then select Object Groups. Hover over the tenant object group and click on Trash can icon. Click on OK to confirm. Tenant object groups Delete Tenant object groups
  6. To delete the devices from this tenant, from the navigation bar, go to Devices and then select Device Manager. Select the devices for this tenant and click on Delete Selected. Then click on OK to confirm. Delete device from tenant

NMS Upgrade/Reboot

If the collector is already installed and running, and SevOne NMS is upgraded, run the deployment script.

Run the deployment script

Example: Default config directory

$ cd /root/sdwan-nuage-installation
 
$ sh deploy_nuage.sh

Verify Data Appears in SevOne NMS

Once the collector has been running for 15 to 20 minutes, data should appear in SevOne NMS. Perform the following steps to verify this.

  • Log into SevOne NMS.
  • From the navigation bar, go to Administration, select Object Types from Monitoring Configuration. Nokia Nuage Object Types
  • From the navigation bar, go to Devices, select Grouping, and then select Device Groups. Nokia Device Group
  • From the navigation bar, go to Devices, select Grouping, and then select Object Groups. Nokia Object Group
  • From the navigation bar, go to Administration and select Metadata Schema. Click on Add Namespace to check metadata creation. Metadata Add Namespace

Object Type Indicator Optimization

DEVICE HEALTH

Indicators Units Description Indicator Type Controlled by Flag
cpu_utilization % Indicates the percentage usage of device cpu. default n/a
disk_utilization % Indicates the percentage usage of device disk. mandatory n/a
memory_utilization % Indicates the percentage usage of device memory. mandatory n/a
availability % Indicates availability of a device over a period of time. mandatory n/a

INTERFACE

Indicators Units Description Indicator Type Controlled by Flag
bw_down mbps Indicates the capacity of down link to transmit maximum amount of data per second. mandatory n/a
bw_up mbps Indicates the capacity of up link to transmit maximum amount of data per second. mandatory n/a
availability % Indicates availability of an interface over a period of time. mandatory n/a
rx_drops

#

Indicates total number of dropped packets through the interface. mandatory n/a
rx_errors

#

Indicates total number of error packets received through the interface. mandatory n/a
tx_drops

#

Indicates total number of dropped transmitted packets through the interface. mandatory n/a
tx_errors

#

Indicates total number of transmitted error packets through the interface. mandatory n/a
tx_octets bytes Indicates total number of transmitted bytes through the interface. default enable_octet_indicators
rx_octets bytes Indicates total number of bytes received through the interface. optional enable_octet_indicators
rx_pkts

#

Indicates total number of packets received through the interface. optional enable_packet_indicators
tx_pkts

#

Indicates total number of transmitted packets through the interface. optional enable_packet_indicators

INTERFACE QUEUE

Indicators Units Description Indicator Type Controlled by Flag
drop_pkts

#

Indicates total number of dropped packets at given time from the queue. mandatory n/a
tx_octets bytes Indicates total number of transmitted bytes at given time. default enable_octet_indicators
tx_pkts

#

Indicates total number of transmitted packets at given time. optional enable_packet_indicators

TUNNEL OBJECT

Indicators Units Description Indicator Type Controlled by Flag
jitter ms Indicates variation in latency at given time. mandatory n/a
latency ms Indicates delay in transmitting data from one end to another end of tunnel. mandatory n/a
loss_percentage % Indicates packet loss in percentage with respect to total amount of packets sent. mandatory n/a

VPORT &LAN AGGREGATION

Indicators Units Description Indicator Type Controlled by Flag
rx_drops

#

Indicates total number of dropped packets through the interface. mandatory n/a
rx_errors

#

Indicates total number of error packets received through the interface. mandatory n/a
tx_drops

#

Indicates total number of dropped transmitted packets through the interface. mandatory n/a
tx_errors

#

Indicates total number of transmitted error packets through the interface. mandatory n/a
tx_octets bytes Indicates total number of transmitted bytes through the interface. default enable_octet_indicators
rx_octets bytes Indicates total number of bytes received through the interface. default enable_octet_indicators
rx_pkts

#

Indicates total number of packets received through the interface. optional enable_packet_indicators
tx_pkts

#

Indicates total number of transmitted packets through the interface. optional enable_packet_indicators

SELF-MONITORING INDICATORS

Indicators Units Description Indicator Type Controlled by Flag
CPU usage user sec Indicates the usage by collector of device cpu. optional filtered_indicator_list
CPU usage system sec Indicates the system usage by collector of device cpu. optional filtered_indicator_list
Memory usage bytes Indicates the memory usage by the collector. optional filtered_indicator_list

REST API TRANSPORT

Indicators Units Description Indicator Type Controlled by Flag
Data Messages sent

#

Indicates the data messages sent by the collector using the REST API transport optional filtered_indicator_list
Messages sent

#

Indicates the messages sent by the collector using the REST API transport optional filtered_indicator_list
Note:
  • mbps = megabits per second
  • ms = milliseconds
  • sec = seconds
  • # = number
  • % = percent
  • default = Indicator is reported by default but can be turned off using the required config flags.
  • mandatory = Indicator is always reported and cannot be turned off.
  • optional = Indicator is not reported by default but can be turned on using the required config flags.

Deploy on AWS

AWS Instance Types for SD-WAN

License AWS Instance Type Primary Disk (GiB) Data Disk (GiB)
SD-WAN Solution
  • m5.2xlarge
  • m6i.2xlarge
250 n/a

Download SevOne NMS / SD-WAN Virtual Appliance images for AWS 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 .

Please refer to SevOne Data Platform Deployment on Amazon Web Services guide for details on how to perform the deployment.

Important: The root disk should be 250 GiB for SD-WAN as shown in AWS Instance Types for SD-WAN table above.

Deploy on Azure

Azure Instance Types for SD-WAN

License Azure Instance Type Primary Disk (GiB) Data Disk (GiB)
SD-WAN Solution Standard_D8s_v3 250 n/a

Download SevOne NMS / SD-WAN Virtual Appliance images for AWS 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 .

Please refer to SevOne Data Platform Deployment on Microsoft Azure guide for details on how to perform the deployment.

Important: The root disk should be 250 GiB for SD-WAN as shown in Azure Instance Types for SD-WAN table above.

Please refer to SD-WAN Nokia-Nuage Networks Collector Installation Guide for details to access the new instance via SSH.

Important: SevOne recommends you to discover each new appliance from SevOne NMS using the SNMP community strings.

Troubleshooting / Useful Commands

Cleanup Containers and Images

Execute the following commands to cleanup old containers, Nuage Networks Collector image, and any other images.

$ docker rmi docker.sevone.com/sc/collectors/nuage:<collector-release-tag>
 
$ docker images -qf "dangling=true" -q | xargs -r docker rmi
 
$ docker volume ls -qf dangling=true | xargs -r docker volume rm

Installation / Upgrade for Collector Failure at Flow View Creation Stage

The total number of aggregated flow views present in SevOne NMS must be less than 10. If the aggregated flow views are greater than 10, then delete the unwanted flow views and trigger the deployment script again.

Log Rotation Rules

By default, the Nuage collector creates log rotation rules in /etc/logrotate.d/nuage-collector for the files stored in the log directory /var/log/sdwan-nuage/<tenant_name>/.

Nuage Collector log rotate rules created in /etc/logrotate.d/nuage-collector

/var/log/sdwan-nuage/*.log {
    daily
    size 100M
    missingok
    rotate 5
    compress
    delaycompress
    notifempty
    dateext
    dateformat %s
}
Note: With the rules defined, the logs are compressed and rotated daily if the file size is greater than 100MB. It adds the timestamp of tomorrow to a file rotated today. It preserves 5 most recent rotated log files and does not return an error if a log file is missing.

Check Logs

Execute the following command to check the logs.

Tail logs

$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_installer_logs_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_nuage_device_summary_runner_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_nuage_interface_queue_stat_runner_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_nuage_interface_stat_runner_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_nuage_tunnel_stat_runner_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_nuage_create_devices_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_device_description_runner_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_event_logs_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_vport_lan_aggregator_poller_logs_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/<tenant_name>_migration_logs_<collector-release-tag>.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/flow_object_mapping.log
$ tail -f /var/log/sdwan-nuage/<tenant_name>/<collector-release-tag>/flow_augmenter/<tenant_name>_nuage_flow_augmentor_<flow_augmenter_number>.log

Nuage Flow View Missing Some Required Fields Post Install / Upgrade

Sometimes, by the time Nuage Flow View creation happens, fields are still in the process of being inserted in the database. Due to this, the new fields do not end up in the Nuage Flow View. In such cases, delete the partially created view SDWAN:Nuage:AugmentedFlow from the User Interface. SSH to your NMS and execute the following command from the installation directory.

Example

$ ssh root@<NMS appliance>
 
$ cd sdwan-nuage-installation
 
$ php nuage/templates/flow_view_creator_nuage.php.j2
Note: New Nuage Flow View SDWAN:Nuage:AugmentedFlow will get created with all the required fields.

Remove Cronjobs

To stop the collector, manually remove the cronjobs.

$ rm /etc/cron.d/nuage_<tenant_name>
 
$ rm /etc/cron.d/nuage_<tenant_name>_flow_collector

Required Details for Support Tickets

For any support tickets, please obtain the following details.

Required Details Obtain Details From
Logs /var/log/sdwan-nuage
Config file used for deployment
  • common_config.yaml and tenant specific files
  • Default directory /opt/nuage_ansible/config/
Environment files for deployment /opt/sdwan-nuage/
Output of commands
  • docker images
  • cat /etc/cron.d/nuage_<tenant_name>
  • docker ps
  • docker version

Start Collector

Execute the following steps to start the collector.

  1. Using ssh, login to NMS appliance as root.
    $ ssh root@<NMS appliance>

    Example

    $ ssh root@10.128.10.226
  2. Change directory to /opt/SevOne/upgrade/ansible/playbooks.
    $ cd /opt/SevOne/upgrade/ansible/playbooks
  3. Start the collector by executing the following command.
    $ sh deploy_nuage.sh start_collector -f <tenant file path>

Stop Collector

Execute the following steps to stop the collector.

  1. Using ssh, login to NMS appliance as root.
    $ ssh root@<NMS appliance>

    Example

    $ ssh root@10.128.10.226
  2. Change directory to /opt/SevOne/upgrade/ansible/playbooks.
    $ cd /opt/SevOne/upgrade/ansible/playbooks
  3. Stop the collector by executing the following command.
    $ sh deploy_nuage.sh stop_collector -f <tenant file path>