Users

Manage users: Add, Delete, Suspend, Unsuspend, etc.

List Users

To list all users, use the following command:

opencli user-list

Example output:

opencli user-list
+----+----------+-----------------+-----------------+---------------------+
| id | username | email           | plan_name       | registered_date     |
+----+----------+-----------------+-----------------+---------------------+
| 52 | stefan   | stefan          | cloud_4_nginx_3 | 2023-11-16 19:11:20 |
| 53 | petar    | petarc@petar.rs | cloud_8_nginx   | 2023-11-17 12:25:44 |
| 54 | rasa     | rasa@rasa.rs    | cloud_12_nginx  | 2023-11-17 15:09:28 |
+----+----------+-----------------+-----------------+---------------------+

You can also format the data as JSON:

opencli user-list --json

Add User

To create a new user run the following command:

opencli user-add <USERNAME> <PASSWORD> <EMAIL> <PLAN_NAME>

TIP

Provide random as password to generate a strong random password.

Delete User

To delete a user and all his data run the following command:

opencli user-delete <USERNAME>

add -y flag to disable prompt.

WARNING

This action is irreversible and will permanently delete all user data.

Suspend User

To suspend (temporary disable access) to user, run the follwowing command:

opencli user-suspend <USERNAME>

Unsuspend User

To unsuspend (enable access) to user, run the follwowing command:

opencli user-unsuspend <USERNAME>

Rename User

To change a username run:

opencli user-rename <USERNAME> <NEW_USERNAME>

Change Email

To change a email run:

opencli user-email <USERNAME> <NEW_EMAIL>

Change Password

To reset the password for a OpenPanel user, you can use the user-password command:

opencli user-password <USERNAME> <NEW_PASSWORD> --ssh

Use the --ssh flag to also change the password for the SSH user in the container.

Login as User

This command allows you to login as the root user inside any users container.

opencli user-login <USERNAME>

Check / Disable 2FA

To disable Two-Factor Authentication for a user, run the following command:

opencli user-2fa <USERNAME> [disable]

Assign / Remove IP to User

To assign free IP address to a user run the following command:

opencli user-ip <USERNAME> <IP_ADDRESS>

To assign IP address that is currently used by another user to this user, run the following command:

opencli user-ip <USERNAME> <IP_ADDRESS> --y

To remove dedicated IP address from a user run:

opencli user-ip <USERNAME> delete

View disk usage for user

To list real-time disk and inodes usage for a user:

opencli user-disk <USERNAME> <summary|detail|path> [--json]

Example usage:

• Disk usage summary for user:

  # opencli user-disk proba summary
  
  -------------- disk usage --------------
  - 564M	/home/proba
  - 864M	/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184

  # opencli user-disk proba summary --json
  
  {"home_directory_usage": "564564", "docker_container_usage": "883864", "home_path": "/home/proba", "docker_path": "/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184"}

• Detailed disk usage report for user:

  # opencli user-disk proba detail
  ------------- home directory -------------
  - home directory:        /home/proba
  - mountpoint:            /home/proba
  - bytes used:            61440
  - bytes total:           10375548928
  - bytes limit:           true
  - inodes used:           20
  - inodes total:          1000960
  ---------------- container ---------------
  - container directory:   /var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184
  - bytes used:            1025388544
  - bytes total:           10726932480
  - inodes used:           20905
  - inodes total:          5242880
  - storage driver:        devicemapper

  # opencli user-disk proba detail --json
  
  {
    "user": "proba",
    "home": {
      "path": "/home/proba",
      "bytes_used": "61440",
      "bytes_total": "10375548928",
      "bytes_limit": true,
      "inodes_used": "20",
      "inodes_total": "1000960"
    },
    "container": {
      "path": "/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184",
      "storage_driver": "devicemapper",
      "bytes_used": "1025388544",
      "bytes_total": "10726932480",
      "inodes_used": "20905",
      "inodes_total": "5242880"
    }
  }

• Paths for user:

  # opencli user-disk proba path
  
  -------------- paths --------------
  - home_directory=/home/proba
  - docker_container_path=/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184

  # opencli user-disk proba path --json
  
  {"home_directory": "/home/proba","docker_container_path": "/var/lib/docker/devicemapper/mnt/ac28d2b066f5ffcacf4510b042623f6a3c196bd4f5fb9e842063c5325e4d0184"}

Grant root

Administrators can grant root-level (sudo) permissions to users inside their docker containers. This allows user to use the 'su -' command and switch to root user.

• Check current sudo status:

  opencli user-sudo USERNAME status

• Grant sudo privilegies:

  opencli user-sudo USERNAME enable

• Remove sudo privilegies:

  opencli user-sudo USERNAME disable

View login log

View up to last 20 successfull logins for the user.

opencli user-loginlog <USERNAME> [--json]

REDIS

Check REDIS service status for user and enable/disable REDIS® service.

opencli user-redis [check|enable|disable] <USERNAME>

Example:

opencli user-redis check stefan

Memcached is not installed for user stefan.

Memcached

Check Memcached service status for user and enable/disable Memcached service.

opencli user-memcached [check|enable|disable] <USERNAME>

Example:

opencli user-memcached enable stefan

Memcached enabled successfully for user stefan.