Skip to main content

Manager Installation

This guide explains how to install the NMS Manager, the agent for WhaTap NMS (Network Management System). Before proceeding with the installation, be sure to check the following.

Caution

Before installing the manager, WhaTap sign up and project creation must be completed. For more information, see the Getting Started document.

Manager installation​

Check the project access key​

The access key is a unique ID for activating the WhaTap service. After automatically receiving the access key, proceed to the next step.

  1. In the installation guide section, click the Getting the access key button.

  2. Copy the issued access key by clicking the Copy button. The access key can be reconfirmed.

Tip

After creating a project, it automatically moves to the Agent installation page. If you do not move to the Agent installation page, select Management > Manager Installation from the left menu on the screen.

Run the installation command​

After checking the project access key in the Management > Manager Installation guide section, proceed with the installation suitable for the operating system in order.

Red Hat-based Linux​

Note

WhaTap Network Management System supports Rocky and Redhat Linux environments.

  1. Run the following command to register the WhaTap repository.

    sudo rpm --import https://repo.whatap.io/centos/release.gpg
    sudo rpm -ivh https://repo.whatap.io/centos/5/noarch/whatap-repo-1.0-1.noarch.rpm

  2. Run the following command to install the package.

    sudo dnf install -y whatap-nms

  3. Run the following command. Enter the access key and set the WhaTap server host.

    $ sudo wtinitset -a xxxxxxx-xxxxxxxx-xxxxxxx -s 192.168.10.100

    $ sudo wtinitset --help
    usage: wtinitset [-h] -a LICENSE -s HOST [-v]

    Whatap-nms access key manager tool

    optional arguments:
    -h, --help            show this help message and exit
    -a LICENSE, --accesskey LICENSE
    Access key for project
    -s HOST, --server HOST
    Whatap host ip address for data transfer
    -v, --view            View current configuration

    example:
    # wtinitset -a znun32arkonto-76rbkt4ftlrwh9-s0dywogeww1lhs -s 192.168.10.100
    # wtinitset -a znun32arkonto-76rbkt4ftlrwh9-s0dywogeww1lhs -s 10.10.10.10/10.10.10.20

  4. After installation is complete, run the following command to check if the NMS manager is running normally.

    sudo service uvicorn status
    sudo service nmscore status
    sudo service icmptcphealthd status

Debian-based Linux​

Note

WhaTap Network Management System supports Ubuntu environment.

  1. Run the following command to register the WhaTap repository.

    curl -s https://repo.whatap.io/debian/release.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/whatap-release.gpg > /dev/null
    echo "deb [signed-by=/etc/apt/trusted.gpg.d/whatap-release.gpg] https://repo.whatap.io/debian unstable/" | sudo tee /etc/apt/sources.list.d/whatap.list

  2. Run the following command to install the package.

    sudo apt-get update
    sudo apt-get install -y whatap-nms

  3. Run the following command. Enter the access key and set the WhaTap server host.

    $ sudo wtinitset -a xxxxxxx-xxxxxxxx-xxxxxxx -s 192.168.10.100

    $ sudo wtinitset --help
    usage: wtinitset [-h] -a LICENSE -s HOST [-v]

    Whatap-nms access key manager tool

    optional arguments:
    -h, --help            show this help message and exit
    -a LICENSE, --accesskey LICENSE
    Access key for project
    -s HOST, --server HOST
    Whatap host ip address for data transfer
    -v, --view            View current configuration

    example:
    # wtinitset -a znun32arkonto-76rbkt4ftlrwh9-1234ogeww1lhs -s 192.168.10.100
    # wtinitset -a znun32arkonto-76rbkt4ftlrwh9-1234wogeww1lhs -s 10.10.10.10/10.10.10.20

  4. After installation is complete, run the following command to check if the NMS manager is running normally.

    sudo service uvicorn status
    sudo service nmscore status
    sudo service icmptcphealthd status

Manager update​

On Red Hat-based Linux, update the NMS manager with the following commands.

sudo dnf makecache
sudo dnf upgrade -y whatap-nms
Note

When the upgrade is blocked

If the /etc/dnf/dnf.conf file contains the following setting, the package is not updated even if you run dnf upgrade or dnf upgrade whatap-nms.

exclude=whatap-nms*

Open the file and remove or comment out the exclude entry so that the upgrade proceeds normally.

sudo vi /etc/dnf/dnf.conf
/etc/dnf/dnf.conf
[main]
gpgcheck=1
installonly_limit=3
clean_requirements_on_remove=True
best=True
skip_if_unavailable=False
# exclude=whatap-nms*

Manager removal​

Remove the NMS manager with the command for your Linux distribution.

  • Red Hat-based Linux

    sudo dnf remove whatap-nms

  • Debian-based Linux

    sudo apt purge whatap-nms

NMS service access​

Once the installation is complete, access https://service.whatap.io to start NMS monitoring.

Last updated on