Configuration

Edit online

Important: The content on this page is specifically relevant for new installations and does not pertain to upgrades.

Important: When deploying the collector on SevOne NMS, to handle HSA-PAS failover scenario to avoid any data loss, user must deploy the collector on both the HSA and the PAS.

Important:
Before proceeding with the installation or upgrade process, please perform the steps available in section Prerequisites > subsection Create MySQL User.

Important: It is recommended to update the latest MAC Address manufacturer list in oui.csv file. To update the list, please refer to section Update MAC Address Manufacturer List

The following steps apply to deploy the collector on SevOne NMS.

SSH to SevOne NMS appliance.
```
$ ssh support@<NMS appliance>
```
Change the environment variables in following .env file.
The configuration files are stored in /config/collectors/wifi/configuration directory. It contains the following files.
- aruba.env - env file for running collector for vendor aruba.
- cisco.env - env file for running collector for vendor cisco.
- disable_config.json - used to Cleanup Inactive Wifi Station objects.
- oui.csv.sample - IEEE Registration Authority MAC Address Block Large (MA-L) CSV file.
Using a text editor of your choice, change the environment variables in the .env files.

Go the directory where configuration files are stored
```
$ vi /config/collectors/wifi/configuration/<aruba | cisco>.env
```
Important: Please change all the configuration variables in these .env files before proceeding to the next steps.

If you are performing an upgrade, the original .env files are copied to /opt/WLCCollector<###>.old/configuration directory, if needed, for reference. Please do not overwrite the files in this directory with the new .env files.
The list of all the .env variables along with their description can be found in section Additional Commands / Features > sub-section Environment Variables.
To pin the devices and edit the environment files (for example, aruba.env, cisco.env), please refer to section Additional Commands / Features > sub-section Create / Pin WLC Devices on SevOne NMS.
(optional) To import out-of-the-box (OOTB) reports, please execute the following commands.
1. Using ssh, login to SevOne NMS appliance as support.
```
$ ssh support@<SevOne NMS appliance IP address>
```
2. Go to SevOne NMS container.
```
$ sudo podman exec -it nms-nms-nms /bin/bash
```
3. Change directory to /config/collectors/wifi/spk.
```
$ cd /config/collectors/wifi/spk/
```
  You will see the following files in the directory.
  - WifiSolution-ootb-alerts.spk - It imports WLC Selfmon alerts.
  - WifiSolution-TopN-reports.spk - It imports WLC selfmon TopN views.
  - WifiSolution-ootb-reports-NMS.spk - It imports various WLC, AP & station TopN views.
4. Import the following .spk files.
  - WifiSolution Alerts
```
$ SevOne-import --allow-overwrite --file WifiSolution-ootb-alerts.spk
```
  - WifiSolution TopN Reports
```
$ SevOne-import --allow-overwrite --file WifiSolution-TopN-reports.spk
```
  - WifiSolution OOTB Reports NMS
```
$ SevOne-import --allow-overwrite --file WifiSolution-ootb-reports-NMS.spk
```
(optional) If you want to remove the prefix WiFi AP: from the name of AP devices, set NO_PREFIX value to true and then run the following command to rename Access Points (APs). Applicable in case of upgrades only.
Enter the WiFi collector container.
```
$ sudo podman exec -it nms-collections-wifi-collector bash
```
```
$ /config/collectors/wifi/wlccmd.sh v{collector-version}-build{version} task rename_aps cisco
```
Important: Please make sure to check the following before running the above command.
- There must be no running collector docker container for any vendor.
- Collector crons must be disabled/deleted so no new containers are spun when the rename script is running.
Verify the log directory has been created and the logs are being redirected to it.
```
$ cd /var/log/wifi-wlc
```
This directory contains the following log files for the Wifi collector.
- wlc_<vendor>_install.log - different file for each vendor.
- wlc_<vendor>_<WLC_GROUPS>.log - different file for each vendor and each member of WLC_GROUPS.
Once done, perform the steps available in section Update MAC Address Manufacturer List.
Important: Update oui.csv file regularly so collector can identify manufacturer for the maximum number of stations.