UISP - Command Line Interface (CLI)

2023-09-12 13:59:32 UTC


Readers will learn the format of certain UISP-related CLI commands that can be used on self-hosted UISP installations. 

- Applicable to the latest UISP release version on self-hosted UISP installations.
- Use the commands listed in this article with caution and only when there is a good reason to do so.
- The commands listed in this article are intended to be used by network administrators that have knowledge of the Linux CLI.


ATTENTION: Use the commands listed in this article with caution and only when there is a good reason to do so.

Below you will find some useful console commands for self-hosted UISP installations. You can use these commands to restart the UISP instance or restore a backup. Run all the commands listed in this article from a user account that has sudo privileges. Use the --help flag at the end of a command to list the available options.

Stopping and (re)starting UISP

Run the command below to restart/rebuild all UISP containers. 

sudo ~unms/app/unms-cli restart

Run the command below to stop all UISP containers. 

sudo ~unms/app/unms-cli stop

Run the command below to start all UISP containers.

sudo ~unms/app/unms-cli start

Set the Superadmin Role

The Superadmin role is necessary for access to the CRM module. The command below sets the specified user as a super admin.

sudo ~unms/app/unms-cli set-superadmin --username <username>

Running this command without the --username option will list all users that are currently set as super admin:

sudo ~unms/app/unms-cli set-superadmin

Recovering Passwords and Disabling Two-Factor Authentication (2FA)

ATTENTION: In order for this CLI command to work properly, it is necessary to have docker-compose 1.23.2+ installed. It is possible to check the current docker-compose version with this command:

sudo docker-compose version

In case the docker-compose version is lower than 1.23.2 it is necessary to upgrade it. It is possible to use this command to do it (it may not work if docker-compose was not installed via UISP installation script).

sudo curl -sL "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ~unms/app/unms-cli set-password --username <username>

The command below will disable two-factor authentication (2FA) for a specific user:

sudo ~unms/app/unms-cli disable-two-factor --username <username>

Running these command without the --username option will list all users:

sudo ~unms/app/unms-cli set-password
sudo ~unms/app/unms-cli disable-two-factor

Refreshing the Let's Encrypt Certificate

This command refreshes the Let's Encrypt certificate. 

sudo ~unms/app/unms-cli refresh-certificate

Reducing the Device Update Frequency

This command reduces the UISP device update frequency, which is helpful when your UISP instance is overloaded and it is not possible to log into the Web UI. 

sudo ~unms/app/unms-cli reduce-device-update-frequency

Clearing and Restoring UISP and Device Backup Files

Use the following command to clear the backup files of devices that are connected to the UISP console (server):

sudo ~unms/app/unms-cli clear-device-backups

Use the following command to restore the UISP server from a selected backup file.

sudo ~unms/app/unms-cli restore-backup --file <backup-file>

NOTE: The most recent/latest automatic backup file is used if you do not specify the --file option.

Changing the Processor Worker Count

ATTENTION: The <count> value should not be higher than the actual number of available CPU cores. It is possible to set this value to auto in order to let UISP decide how many workers it needs. It is recommended to have at least 0.5 Gb (500Mb) of free RAM available for each worker.

Set the number of worker processes to the desired value (count) or use auto:

sudo ~unms/app/unms-cli set-workers <count>
sudo ~unms/app/unms-cli set-workers auto

Whitelisting IP Addresses for the Web UI and API

The following commands will allow you to block access to the Network module of the UISP and specify a list of IP addresses that are allowed to access the Network module GUI and API.

Show the current whitelist:

sudo ~unms/app/unms-cli ip-whitelist --show

Create a new whitelist:

sudo ~unms/app/unms-cli ip-whitelist --set ",,2001:db8:12:34::/64"

Clear the whitelist to allow access from all addresses:

sudo ~unms/app/unms-cli ip-whitelist --clear

NOTE: This only limits which users are allowed to connect to the Network module UI and API. Devices connecting to UISP are not affected by this whitelist.

Related Articles

UISP - How to Find Logs, Report Bugs & Device Log Analysis

Was this article helpful?
42 out of 81 found this helpful