SevOne SDN Collector Upgrade Process Guide

General

The tar file cisco-aci-agent-solution-v6.6.0-build-235714.tar.gz 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:

• Cisco ACI Agent Docker image
• launch script
• conf directory
• version.txt
• install.sh

Docker

• SSH into SevOne NMS or the system on which the collector needs to be deployed.
• To avoid typing sudo whenever you run the docker command, add your username to the docker group.
For this to take effect, you will need to log out and log back in.

$ usermod -aG docker <username>




$ usermod -aG docker sevone

Install on SevOne NMS Appliance

Execute the following command if the installation is on SevOne NMS appliance.

$ ./install.sh --upgrade

It will perform the following tasks.

1. Enables and starts Docker services, if required

2. Sets up the pre requisite directories and files

3. Validates the checksum file

4. Extracts the cisco-aci-agent-solution-v6.6.0-build-235714.tar.gz file

5. Loads the Docker image

6. Adds execute permissions to the launcher script

7. Extracts a sample certificate-private key pair that can be used for Signature-based Authentication.

   Do not use the sample keys as they are the same for all customers. You must generate your own signature pair.

8. Executes the installer to setup the settings.env and multi_site_config.json files. This option can also be executed independently by the user using the launch script. For detailed instructions, please refer to SevOne SDN Collector Set Collector Using 'launch configure' Option.

   To modify the fault filters based on the latest filters available for SDN 6.6, please refer to SevOne SDN Collector Filter Alerts Using 'launch generate-fault-config' Option.

9. Extracts and handles the dependencies, required for ACI. This includes installing the autossh package, creating a systemD service, modifying sshd 's settings, restarting the sshd service and starting the autossh tunnel forwarding service . The step was created as a shortcut when installing on SevOne NMS appliances however, it will not work when the installation is not on SevOne NMS.

   1. In a pop-up editor, you will see contents similar to the sample below.

      # TARGET=apic # this is the name
      # LOCAL_ADDR=0.0.0.0 # which local interface to bind to <all>
      # LOCAL_PORT=9999 # which local port to use
      # APIC_ADDR=172.21.100.250 # where is the apic
      # APIC_PORT=443 # what port is the API on the APIC
      
      TARGET=apic
      LOCAL_ADDR=0.0.0.0
      LOCAL_PORT=9999
      APIC_ADDR=172.21.100.250
      APIC_PORT=443
      

   2. Press Ctrl+x . However, if you attempt to install via WebEx, Ctrl+x is not possible from the WebEx session. You will need a local user to perform this step for you.

10. Refreshes the cache so that any device-ids maintained in a cache on the machine may be deleted.

11. Adds objects and indicators to SevOne NMS. This includes setting the topology constraints and create Object Types, Indicator Types, Device Groups and rules, and Metadata Schema.

12. Sets up logrotate.

$ ./install.sh --import-ootb-reports

Install on non-SevOne NMS Appliance

Execute the following command if the installation is not on SevOne NMS appliance.

$ ./install.sh --configure --non_pas_device

It will perform the tasks (3.) through (7.) and (9.) through (11.) as described above.

Configure the 'cron' file for Data Collection

Perform the following actions to configure the cron file for data collection. When running on a SevOne NMS cluster, please execute the crontab commands below on both the leader and HSA so that failover can be handled.

1. Execute the following command.

   $ crontab -e
   

2. Add the following line to start the collection agent.

   */5 * * * * /opt/cisco-aci-agent/launch run
   

   
   

   1. If the user has stored the settings.env and multi_site_config.json files in a directory other than the default (/opt/cisco-aci-agent/conf), the directory path must be provided as an argument to the launch script's --conf-path option in the crontab, as demonstrated below.
      

      */5 * * * * /opt/cisco-aci-agent/launch run --conf-path <directory path for settings.env/multi_site_config.json files>
      

      The --conf-path must be an absolute path.
   2. If your SevOne NMS is SSL verified, provide the CA bundle to the install script using the --ssl-verify option, as demonstrated below.
      

      */5 * * * * /opt/cisco-aci-agent/launch run --ssl-verify <path-to-CA-bundle>
      

      The --ssl-verify must be an absolute path. Also, if you see this option, please make sure to set the following variables in the settings.env file.

      • SEVONE_API_SECURITY=True
      • SEVONE_API_COLLECTION_PORT=443
      • SEVONE_API_CONFIG_PORT=443
   You may use this for both the leader and the HSA appliance crontab entry. It checks the /SevOne.masterslave.master file for its value to determine whether it needs to run or not.

3. Save and close the file.

   After installing the cron, it might take a few minutes before it executes the job. You may monitor the cron logs using the following command.

   $ tail -f  /var/log/cron  | grep launch
   

   Once a log appears as a result of this command, press Ctrl+C to exit. You may then proceed to verify that data appears in SevOne NMS.

Obtain List of Running Docker Containers

$ docker ps

CONTAINER ID   IMAGE                                            COMMAND                  CREATED       STATUS      PORTS   NAMES
ecf5881e406d   docker.sevone.com/sc/collectors/cisco-aci:v6.6.0 "python source/main.…"   5 days ago    Up 5 days           cisco-aci-agent-2022-06-22-10-15-25

View Log

To confirm that the collector is running and checking for errors, tail the log file you have setup. The log file will be available in the location specified in the multi_site_config.json file as cisco_log_filepath setting.

$ tail -f <data-log-file-name>.log

Reset settings.env and multi_site_config.json

In order to reset the settings.env and multi_site_config.json files to its original factory settings, the launch script has been provided with a reset-settings option. The reset-settings option, when executed, it will reset the settings.env and multi_site_config.json files.

Example

$ cd /opt/cisco-aci-agent
$ ./launch configure --mode reset-settings --conf-path <directory path for settings.env/multi_site_config.json files (optional)>

Restart Collector

To restart the collector, execute the following commands. Also, the changes made in the settings.env and multi_site_config.json files are reflected in the collector after the restart.

$ cd /opt/cisco-aci-agent
$ ./launch restart-collector

Remove Unused Objects

To remove unused SDN objects, execute the following command.

$ launch delete-objects [--conf-path <configuration directory>]

$ launch delete-objects --help

Handle ASCII Code Encoding Issue

Readline library that Python uses to read interactive input does not accept non-ASCII characters sent by the terminal. It happens due to any of the following.

• Terminal emulator does not provide characters in the UTF-8 encoding process.
• Readline is not configured to accept UTF-8 input.

To overcome this issue, execute the following command before importing OOTB reports.

$ export LC_ALL='en_US.utf8'