# Command-line tools (CLI)

The list of the commands (CLI) you can use to manage CloudLinux OS components.

• CageFS
• LVE-stats 2
• MySQL Governor
• PHP Selector
• Python Selector
• Ruby Selector
• Node.js Selector
• Apache mod_lsapi PRO
• Website monitoring tool and Slow Site analyzer
• X-Ray Autotracing
• Other CLI tools

# CageFS

• Running command inside CageFS
• Sanity check

cagefsctl is used to manage CageFS. It allows initializing and updating CageFS, as well as enabling/disabling CageFS for individual users.

Use the following syntax to manage CageFS: /usr/sbin/cagefsctl [OPTIONS]

Options:

Use the following syntax to manage users:
/usr/sbin/cagefsctl [OPTIONS] username [more usernames]

Options:

PHP Selector related options:

Common options:

# Running command inside CageFS

Sometimes you will need to execute a command as user inside CageFS.

If a user has shell enabled - you can simply use:

/bin/su - $USERNAME  -c _command_

/sbin/cagefs_enter_user [--root] [--no-fork] $USERNAME _command_

Options:

• --root – tells the utility not to reset UID and GID to user ones. It might be dangerous to call untrusted commands.
• --no-fork – do not create a child process for a called command. The called command will replace the cagefs_enter process with exec.
• --no-cpu-limit- remove all CPU limits (requires kmod-lve >= 2.0.36)
• --no-io-and-memory-limit - remove all limits of IO and Memory (requires kmod-lve >= 2.0.36)

If you disable CageFS for a user, then cagefs_enter will be executed without proxyexec .

You can forcibly disable cagefs_enter start via proxyexec for all users (regardless if CageFS is enabled or disabled) by specifying the parameter cagefs_enter_proxied=0 in /etc/sysconfig/cloudlinux.

/bin/cagefs_enter.proxied can be executed instead of /bin/cagefs_enter to enter CageFS without proxyexec . Note that starting cagefs_enter via proxyexec is necessary to enable sending local notification messages to users with enabled CageFS. cagefs_enter is executed via proxyexec by default.

# Sanity check

CageFS --sanity-check utility allows to check CageFS configuration consistency, so that an administrator can save the time investigating issues with CageFS and ensure that custom configuration is correct.

To start, run the command:

cagefsctl --sanity-check

1. Check cagefs mount points exists - reads cagefs.mp file and verifies if the directories specified in it really exist on the disk. To learn more, visit Mount points and Split by username

2. Check cagefs users.enabled is a directory - ensures that if /etc/cagefs/users.enabled exists, then it is a directory, not a file (if it is recognized as a file, then it would cause a breakdown).

3. Check cagefs users.disabled is a directory - ensures that if /etc/cagefs/users.disabled exists, then it is a directory, not a file (if it is recognized as a file, then it would cause a breakdown).

4. Check cagefs disable.etcfs exists - checks if /etc/cagefs/etc.safe/disable.etcfs exists.

5. Check cagefs users can enter cagefs - chooses two users in the system with enabled CageFS (the first and the second ones in the unsorted list) and tries to log in to CageFS under their credentials and see what happens. It runs su -l "$USER" -s /bin/bash -c "whoami" and compares the output with the $USER and su command retcode estimation.

6. Check cagefs proxy commands configs are parsable - tries to load /etc/cagefs/*.proxy.commands files and parse them to check the syntax. In case of any parsing error the test will fail. To learn more, visit Executing by proxy.

7. Check cagefs virt.mp files syntax - reads all /var/cagefs///virt.mp files (if any) and checks their syntax validity. At the moment there are only two checks of the syntax: the file is not empty if it exists, and the file is not starting with the sub directory definitions (with @). To learn more, visit Per-user virtual mount points

8. Check MultiPHP system default PHP version – checks that MultiPHP system default PHP version is NOT Alt-PHP. That means PHP Selector should work properly. If MultiPHP system default PHP version is Alt-PHP, PHP Selector does not work and should be disabled. To learn more on how to disable PHP Selector, visit cPanel LVE Manager

Possible results of the checks:

• OK - the check succeeded.

• FAILED - the check revealed a problem.

• SKIPPED - the check was skipped as it made no sense in such environment (e.g. wrong control panel) or can not be performed for some reason (e.g no users with enabled CageFS found). The actual result does not mean that a problem exists and can be considered as positive.

• INTERNAL_TEST_ERROR - the check failed because of a problem inside the checker itself. Must be reported to the developers.

In case if at least one of the checks resulted neither OK nor SKIPPED then the checker will end with ret code >0.

# LVE-stats 2

• lveinfo
• lvechart
• dbgovchart
• lve-read-snapshot
• lve-create-db
• cloudlinux-top
  • Usage
  • Output format
  • Units of measurement
  • Errors handling
  • Examples
• cloudlinux-statistics
  • Usage
  • Output format
  • Units of measurement
  • Errors handling
  • Examples

Usage

lveinfo [-h] [-v] [--dbgov DBGOV] [-f YYYY-MM-DD[HH:MM]]

              [-t YYYY-MM-DD[HH:MM]] [--period PERIOD] [-u USER | --id ID]

              [-d] [-o ALIAS] [-b ALIAS [ALIAS ...]] [-p 0..100]

              [--by-fault ALIAS [ALIAS ...]] [-r FAULTS]

              [--style {user,admin}] [-l LIMIT] [-c [PATH] | -j]

              [--server_id SERVER_ID] [--servers-info]

              [--show-all | --show-columns COLUMN_NAME [COLUMN_NAME ...]]

              [--time-unit TIME_UNIT] [-m {v1,v2}]

              [--blank-value [BLANK_VALUE]]

lveinfo is an utility to display historical information about LVE usage.

Optional arguments

• -h, --help – show this help message and exit

• -v, --version – show program's version number and exit

• --dbgov DBGOV – show MySql Governor statistic

• -u USER, --user USER – use username instead of LVE id, and show only record for that user

• --id ID – will display record only for that LVE id

• -d, --display-username – try to convert LVE id into username when possible

• -o ALIAS, --order-by ALIAS – orders results by one of the following:

  ALIAS	ALIAS	DESCRIPTION
  cpu_avg	aCPU	average CPU usage
  cpu_max	mCPU	max CPU usage
  total_cpu_faults	CPUf	total number of max CPU usage faults
  vmem_avg	aVMem	average virtual memory usage
  mep_avg	aEP	average number of entry processes (concurrent connections)
  mep_max	mEP	max number of entry processes (concurrent connections)
  total_ep_faults	EPf	total number of max entry processes faults
  pmem_avg	aPMem	average physical memory usage (LVE version >= 6)
  pmem_max	mPMem	max physical memory usage (LVE version >= 6)
  nproc_avg	aNproc	average number of processes (LVE version >= 6)
  nproc_max	mNproc	max number of processes (LVE version >= 6)
  io_avg	aIO	average io usage (LVE version >= 6)
  io_max	mIO	max io usage (LVE version >= 6)
  total_pmem_faults	PMemF	total number of out of physical memory faults (LVE version >= 6)
  total_nproc_faults	NprocF	total number of max processes faults (LVE version >= 6)
  total_io_faults	IOf	total number of max io faults (LVE version >= 6)
  iops_avg	aIOPS	average io operations (LVE version >= 8)
  iops_max	mIOPS	max io operations (LVE version >= 8)
  total_iops_faults	IOPSf	total number of max io operations faults (LVE version >= 8)
  any_faults	anyF	total number of faults of all types

• -b ALIAS [ALIAS ...] --by-usage ALIAS [ALIAS ...] – show LVEs with usage (averaged) within 90 percent of the limit available values:

  ALIAS	ALIAS	ALIAS	DESCRIPTION
  cpu_avg	cpu	aCPU	average CPU usage
  cpu_max	cpu_max	mCPU	max CPU usage
  vmem_avg	vmem	aVMem	average virtual memory usage
  vmem_max	vmem_max	mVMem	max virtual memory usage
  mep_avg	mep	aEP	average number of entry processes (concurrent connections)
  mep_max	mep_max	mEP	max number of entry processes (concurrent connections)
  pmem_avg	pmem	aPMem	average physical memory usage (LVE version >= 6)
  pmem_max	pmem_max	mPMem	max physical memory usage (LVE version >= 6)
  nproc_avg	nproc	aNproc	average number of processes (LVE version >= 6)
  nproc_max	nproc_max	mNproc	max number of processes (LVE version >= 6)
  io_avg	io	aIO	average io usage (LVE version >= 6)
  io_max	io_max	mIO	max io usage (LVE version >= 6)
  iops_avg	iops	aIOPS	average io operations (LVE version >= 8)
  iops_max	iops_max	mIOPS	max io operations (LVE version >= 8)

• -p 0..100, --percentage 0..100 – defines percentage for --by-usage option; default 90

• --style {user,admin} – deprecated, not used.

• -l LIMIT, --limit LIMIT – max number of results to display, 10 by default, if 0 no limit

• -c [PATH], --csv [PATH] – save statistics in CSV format; - by default (output to screen)

• -j, --json – display output in JSON format

• --server_id SERVER_ID – used with central database for multiple servers, default localhost

• --servers-info – show servers LVE versions

• --show-all – full output (show all limits); brief output is default; equivalent --show-columns all

• -show-columns COLUMN_NAME [COLUMN_NAME ...] – show only the listed columns; all for all supported columns

  COLUMN_NAME	DESCRIPTION
  From	Show start period statistics
  To	Show end period statistics
  ID	LVE Id or username
  aCPU	Average CPU usage
  uCPU	The percentage of user-allocated resource CPU
  mCPU	deprecated
  lCPU	CPU limit
  CPUf	Out Of CPU usage Faults
  aEP	Average Entry Processes
  uEP	The percentage of user-allocated resource Entry processes
  mEP	deprecated
  lEP	maxEntryProc limit
  aVMem	Average Virtual Memory Usage
  uVMem	The percentage of user-allocated resource Virtual Memory
  mVMem	deprecated
  lVMem	Virtual Memory Limit
  VMemF	Out Of Memory Faults
  EPf	Entry processes faults
  aPMem	Average Physical Memory Usage (LVE version >= 6)
  uPMem	The percentage of user-allocated resource Physical Memory (LVE version >= 6)
  mPMem	deprecated (LVE version >= 6)
  lPMem	Physical Memory Limit (LVE version >= 6)
  aNproc	Average Number of processes (LVE version >= 6)
  uNproc	The percentage of user-allocated resource Number of processes (LVE version >= 6)
  mNproc	deprecated (LVE version >= 6)
  lNproc	Limit of Number of processes (LVE version >= 6)
  PMemF	Out Of Physical Memory Faults (LVE version >= 6)
  NprocF	Number of processes faults (LVE version >= 6)
  aIO	Average I/O (LVE version >= 6)
  uIO	The percentage of user-allocated resource I/O (LVE version >= 6)
  mIO	deprecated (LVE version >= 6)
  lIO	I/O Limit (LVE version >= 6)
  IOf	Out Of I/O usage Faults (LVE version >= 6)
  aIOPS	Average I/O Operations (LVE version >= 8)
  mIOPS	deprecated (LVE version >= 8)
  uIOPS	The percentage of user-allocated resource I/O Operations (LVE version >= 8)
  lIOPS	I/O Operations Limit (LVE version >= 8)
  IOPSf	Out Of I/O Operations Faults (LVE version >= 8)

• --time-unit TIME_UNIT – time step for grouping statistic in minutes; 1 min., by default; can use m\|h\|d suffixes; for example: 1h or 1h30m or 1d12h

• -m {v1,v2}, --compat {v1,v2} – v1 - return old output mode; v2 - new mode; default v1; you can change default in config

• --blank-value [BLANK_VALUE] – Use to fill unsupported limits; default -

• -f YYYY-MM-DD[ HH:MM], --from YYYY-MM-DD[ HH:MM] – run report from date and time in [YY]YY-MM-DD[ HH:MM] format; if not present last 10 minutes are assumed

• -t YYYY-MM-DD[ HH:MM], --to YYYY-MM-DD[ HH:MM] – run report up to date and time in [YY]YY-MM-DD[ HH:MM] format; if not present, reports results up to now

• --period PERIOD – time period; specify minutes with m, h - hours, days with d, and values: today, yesterday; 5m - last 5 minutes, 4h - last four hours, 2d - last 2 days, as well as today

• --by-fault ALIAS [ALIAS ...] – show LVEs which failed on max processes limit or memory limit

  ALIAS	ALIAS	ALIAS	DESCRIPTION
  mcpu	cpu	CPUf	total number of max CPU usage faults
  mem	vmem	VMemF	total number of out of virtual memory faults
  mep	ep	EPf	total number of max entry processes faults
  pmem	pmem	PMemF	total number of out of physical memory faults (LVE version >= 6)
  nproc	nproc	NprocF	total number of max processes faults (LVE version >= 6)
  io	io	IOf	total number of max io faults (LVE version >= 6)
  iops	iops	IOPSf	total number of max io operations faults (LVE version >= 8)
  any_faults	any	anyF	total number of faults of all types

• -r FAULTS, --threshold FAULTS– in combination with --by-fault, shows only LVEs with number of faults above; default 1

Prefixes Kb, Mb and Gb indicates powers of 1024.

/usr/sbin/lvechart - creates a chart representing LVE usage for user.

Usage

/usr/sbin/lvechart [OPTIONS]

Acceptable options

/usr/sbin/dbgovchart - creates a chart representing MySQL usage for user.`

Usage

/usr/sbin/dbgovchart [OPTIONS]

Acceptable options

Usage

lve-read-snapshot [-h] [--version] [-f FROM [FROM ...]] [-t TO [TO ...]
                  [ -p PERIOD | --timestamp TIMESTAMP]
                  [-i ID | -u USER] [-l] [-o file] [-j] [--stats]
                  [--unit unit]

Reads LVE system state snapshots for LVE/user.

Optional arguments

• -h, --help – show this help message and exit
• --version – version number
• -f FROM [FROM ...], --from FROM [FROM ...] – run report from date and time in YYYY-MM-DD HH:MM format, if not present last 10 minutes are assumed (default: 2016-10-24 19:28)
• -t TO [TO ...], --to TO [TO ...] – run report up to date and time in YYYY-MM-DD HH:MM format, if not present, reports results up to now (default: 2016-10-24 19:38)
• -p PERIOD, --period PERIOD – time period specify minutes with m, h - hours, days with d, and values: today, yesterday, 5m - last 5 minutes, 4h - last four hours, 2d - last 2 days, as well as today (default: 10m)
• --timestamp TIMESTAMP – time stamp in unix format for get one snapshot (default: None)
• -i ID, --id ID – LVE id to show records for (default: None)
• -u USER, --user USER – user account to show records for (default: None)
• -l, --list – show timestamp list only (default: False)
• -o file, --output file – filename to save snaphots report to, if not present,output will be sent to STDOUT (default: None)
• -j, --json – output in json format (default: False)
• --stats – output stats, instead of snapshots (default: False)
• --unit unit – group stats by time unit. Example values 3h, 24h, 1d, 1w. Other possible value is auto for grouping by each incident (default: 1d)

One of -u --user or -i --id should be specified.

Usage

lve-create-db [-h] [--recreate] [--print-sql]
                   [--update-serverid-prompt] [--update-serverid-auto]
                   [--validate]

Creates a database for lve-stats.

Optional arguments

• -h, --help – show this help message and exit
• --recreate – drops and recreates database even if tables exists (default: False)
• --print-sql – prints sql and exits, without creating db (default: False)
• --update-serverid-prompt – update exist server ID or create new one (default: False)
• --update-serverid-auto – update exist server ID with uuid (default: False)
• --validate – check the correctness of the database structure (default: False)

# cloudlinux-top

Utility provides information about current MySQL and LVE usage of a running system in JSON format.

# Usage

cloudlinux-top [-h] [-v] [-j] [--hide-mysql]
               [-u USERNAME | -r FOR_RESELLER] [-d DOMAIN] [-m MAX]
               [-o ORDER_BY]

Optional arguments

• -h, --help – show this help message and exit
• -v, --version – show program version number and exit
• -j, --json – return data in JSON format
• --hide-mysql | `don't show MySQL related info
• -u USERNAME, --username USERNAME – show data only for a specific user. Can be used to filter the output; returns users with username %USERNAME%
• -r FOR_RESELLER, --for-reseller FOR_RESELLER – get information only about specified reseller and his users
• -d DOMAIN, --domain DOMAIN – show data only for a specific domain. Can be used to filter the output; returns users with domain %DOMAIN%
• -m MAX, --max MAX – show up to N records. If --max key is omitted. By default will show top 25 users
• -o ORDER_BY, --order-by ORDER_BY – sort output by resource usage; available options: cpu, mysql_cpu, io, mysql_io, iops, ep, nproc, pmem

# Output format

{
  "mySqlGov": "enabled",              # possible values: enabled, error
  "mySqlGovMode": "abusers",          # see “MySQL Governor > Modes Of Operation”
                                      # if MySQL Governor is not enabled, value is "none"
 
  "resellers": [                      # list of resellers (available only with
                                      # reseller limits feature)
      {
          "id": 1000020005,           # internal record id
          "limit": <lve_section>,     # current limits (last 5 seconds)
          "name": "reseller_name",    # reseller’s login in control panel
          "usage": <lve_section>      # current usage (last 5 seconds)
      }
  ],
  "result": "success",                # see the ‘errors handling’ section
  "timestamp": 1522858537.337549,
  "users": [
      {
          "domain": "domain.com",     # user’s primary domain (from control panel)
          "id": 20005,                # lve_id, same as user id in /etc/passwd file
          "limit": <lve_section>,     # limits for last 5 seconds
          "reseller": "reseler1",     # user’s reseller (from control panel)
          "usage": <lve_section>,     # usage for last 5 seconds
          "username": "user"          # username from /etc/passwd file or “N/A” if user
                                      # with such id does not exist
       }
   ]
 }

The structure ^* of <lve_section>:

{
"cpu": {
 "all": 50.0,      # CPU usage or limit (LVE only)
 "mysql": 0.0*     # CPU usage or limit (MySQL Governor only)
},
"ep": 1.0,           # number of entry processes
"io": {
 "all": 0.0,       # IO usage or limit (LVE only)
 "mysql": 0.0**     # IO usage or limit (MySQL Governor only)
},
"iops": 0.0,         # IO operations per second
"mem": 258048,       # memory usage or limit
"pno": 1.0           # number of processes
}

# Units of measurement

For limits and usage sections we use the following units of measurement.

# Errors handling

The format of the error message is the same as in the other cloudlinux- * utilities. When everything is ok, the result value is success. Otherwise, it contains error message. In case of unexpected errors, the output will be as follows.

cloudlinux-top --json 

{
  "context": {
      "error_text": "Very bad error"
  },
  "result": "An error occured: \"%(error_text)s\"",
  "timestamp": 1523871939.639394
}

# Examples

• get 100 users ordered by CPU usage

  cloudlinux-top --json --order-by cpu --max=100
  

• get information about one user

  cloudlinux-top --json -u username
  

• get information about reseller and his users

  cloudlinux-top --json --for-reseller=reseller_name
  

• show only IO limits and usage

  cloudlinux-top --json --show=io
  

cloudlinux-statistics is a CLI utility that provides historical information about resource usage.

# Usage

cloudlinux-statistics [-h] [-j] [-v] [--by-usage BY_USAGE]
                      [--percentage 0..100] [--by-fault BY_FAULT]
                      [--threshold THRESHOLD] [--server_id SERVER_ID]
                      [-f FROM] [-t TO] [--period PERIOD]
                      [--limit LIMIT]
                      [--show COLUMN_NAME [COLUMN_NAME ...]]
                      [-o ORDER_BY] [--id ID] [--time-unit TIME_UNIT]
                      [-r FOR_RESELLER]

Optional arguments

• -h, --help – show this help message and exit

• -j, --json – return data in JSON format

• -v, --version – show program version number and exit

• --server_id SERVER_ID, --server-id SERVER_ID – can be used with the central database for multiple servers; default ...

• --limit LIMIT – limit the number of results to display, 0 is unlimited

• --show COLUMN_NAME [COLUMN_NAME ...] – show only listed columns; all for all supported columns (fields)

  Key	Fields to show
  all	all available fields
  cpu	CPU field
  io	IO field
  iops	IOPS field
  ep	entry processes (concurrent connections) field
  nproc	number of processes field
  pmem	physical memory field
  vmem	virtual memory field
  mysql	mysql_cpu & mysql_io field

• -o ORDER_BY, --order-by ORDER_BY – order results by one of the following keys (fields):

  FIELD	DESCRIPTION
  any_faults	total number of faults of all types
  cpu	average CPU usage
  mysql_cpu	average MySQL CPU usage
  io	average IO usage
  mysql_io	average MySQL IO usage
  iops	average IO operations; (LVE version >= 8)
  ep	average number of entry processes (concurrent connections)
  nproc	average number of processes
  pmem	average physical memory usage
  vmem	average virtual memory usage
  cpu_faults	total number of CPU usage faults
  io_faults	total number of max IO faults
  iops_fault	total number of max IO operations faults; (LVE version >= 8)
  ep_faults	total number of max entry processes faults
  nproc_faults	total number of max processes faults
  pmem_faults	total number of out of physical memory faults
  vmem_faults	total number of out of virtual memory faults

• -r FOR_RESELLER, --for-reseller FOR_RESELLER – show statistics only for given reseller and his users

Filter items by resource usage.

• --by-usage BY_USAGE – show LVEs with usage (averaged) within 90 percent of the limit available values

  FIELD	DESCRIPTION
  cpu	average CPU usage
  mysql_cpu	average MySQL CPU usage
  io	average IO usage
  mysql_io	average MySQL IO usage
  iops	average IO operations; (LVE version >= 8)
  ep	average number of entry processes (concurrent connections)
  nproc	average number of processes
  pmem	average physical memory usage
  vmem	average virtual memory usage

• -percentage 0..100 – define percentage for --by-usage option; default 90

Filter items by the number of faults.

• --by-fault BY_FAULT – show only accounts that have some faults for the given limit

  FIELD	DESCRIPTION
  any	faults of all types
  cpu	CPU usage faults
  io	max IO usage faults
  iops	max IO operations faults; (LVE version >= 8)
  ep	max entry processes faults
  nproc	max processes faults
  pmem	out of physical memory faults
  vmem	out of virtual memory faults

• --threshold THRESHOLD – in combination with --by-fault shows only accounts with the number of faults more than given; default 1

Filter items by a time interval.

Allows to get information for the given period of time; you can either set --from and --to options, or just get information for the recent time period using --period option.

• -f FROM, --from FROM – run report from date and time in [YY]YY-MM-DD[ HH:MM] format; if not present, last 10 minutes are assumed
• -t TO, --to TO – run report up to date and time in [YY]YY-MM-DD[ HH:MM] format; if not present, reports results up to now
• --period PERIOD – time period; specify minutes with m, hours with h, days with d, and values: today, yesterday; 5m - last 5 minutes, 4h - last four hours, 2d - last 2 days, and today

Get detailed statistics.

• --id ID – get detailed statistics for database record with the given id
• --time-unit TIME_UNIT – group statistics using the given time; 1 minute by default. For example: 1h or 1h30m or dynamic; available only in pair with --id

# Output format

There are two different JSON formats used for summary statistics and detailed statistics.

Summary statistics

cloudlinux-statistics --json

 {
 "resellers": [
   {
     "usage": <lve_section>,
     "faults": <lve_section>,
     "name": "reseller",
     "limits": <lve_section>,
     "id": 1000020005
   }
 ],
 "timestamp": 1522920637,
 "mySqlGov": "enabled",            # possible values: ”enabled”, “error”
 "result": "success",
 "users": [
   {
     "username": "username",
     "domain": "example.com",
     "reseller": "reseller",
     "limits": <lve_section>,
     "faults": <lve_section>,
     "usage": <lve_section>,
     "id": 20005
   }
 ]
 }

Detailed statistics

cloudlinux-statistics --json --id=20001

 {
 "timestamp": 1523011550,
 "mySqlGov": "enabled",           # possible values: ”enabled”, “error”
 "result": "success",
 "user": [
   {
     "usage": <lve_section>,
     "faults": <lve_section>,
     "from": 1523011144,
     "limits": <lve_section>,
     "to": 1523011143
   },
 ...
   {
     "usage": <lve_section>,
     "faults": <lve_section>,
     "from": 1523011204,
     "limits": <lve_section>,
     "to": 1523011203
   }
 ]
 }

For both, summary statistics and detailed statistics, <lve_section> is the same and looks like following ^*.

{
   "ep": {
     "lve": 1        # number of entry processes
   },
   "vmem": {
     "lve": 2428928  # virtual memory usage or limit (deprecated)
   },
   "iops": {
     "lve": 0        # io operations per second
   },
   "io": {
     "lve": 0.0,     # io usage or limit (lve only)
     "mysql": 0.0**   # io usage or limit (mysql only)
   },
   "nproc": {
     "lve": 1        # number of processes in lve
   },
   "cpu": {
     "lve": 25.6,    # cpu usage (lve only)
     "mysql": 0.0*   # cpu usage (mysql governor only)
   },
   "pmem": {
     "lve": 360448   # physical memory usage or limit
   }
 }

# Units of measurement

For limits and usage sections we use the following units of measurement.

# Errors handling

The format of the error message is the same as in the other cloudlinux- * utilities. When everything is ok, the result value is success. Otherwise, it contains error message.

cloudlinux-statistics --json 

{
  "context": {
      "error_text": "Very bad error"
  },
  "result": "An error occured: \"%(error_text)s\"",
  "timestamp": 1523871939.639394
}

# Examples

• get top 10 users ordered by CPU usage for today

cloudlinux-statistics --json --order-by=cpu --period=today --limit=10

• get users that hit IO limit more than 10 times for today

cloudlinux-statistics --json --period=today --by-fault=io --threshold=10

• get users that used more than 80% of CPU in last 24 hours

cloudlinux-statistics --json --by-usage=cpu --percentage=80 --period=24h

• get information only about reseller and his users

cloudlinux-statistics --json --for-reseller=reseller_name

• get information only about CPU and IO usage

cloudlinux-statistics --json --show=cpu,io

# MySQL Governor

• dbtop

• dbctl

• lveinfo --dbgov

• dbgovchart

• dbtop monitors MySQL usage on per user bases.

• dbctl is a command line tool to manage DB Governor configuration.

• lveinfo --dbgov provides historical information about usage and customer restrictions.

• dbgovchart generates charts for MySQL usage.

# dbtop

Utility to monitor MySQL usage. Requires db_governor to be running. It shows usage for the current, mid and long intervals.

Options:

Control keys

Control keys, that sort table, displays into header of table bold and underlined symbol. Sorted field will be highlighted by *. CAUSE field shows current stage, reason for restriction and number of seconds before restriction will be lifted: Values of column ' CAUSE ' - cause of restriction or freezing: Possible stages:

• - OK
• 1 - Restriction 1
• 2 - Restriction 2
• 3 - Restriction 3
• 4 - Restriction level 4

Display fields:

• cpu - number in %, shows cpu usage by user
  • read - number of bytes (kbytes, mbytes, gbytes) which user reads per second
  • write - number of bytes (kbytes, mbytes, gbytes) write user reads per second

Accounts highlighted in red color means that the account is restricted.
Accounts highlighted in blue color are in cool down period

Command line parameters of dbtop utility:
-r - dbtop refresh period in seconds ( dbtop -r12 )

# dbctl

usage: dbctl command [parameter] [options]

Commands:

Parameters

Options

<restrict_mode use="period"/> (see Configuration)

The default mode is " limit " - when a user hits limits, the account will be marked as restricted and if the user does not hit the limit again during " unlimit=1m " account will be unrestricted. This mode doesn't have any additional levels/penalties.
<restrict_mode use="limit" unlimit="1m"/>

Changing the "unlimit" can be done only via the configuration file (see Configuration).

--slow=N: limit time (in seconds) for long running SELECT queries

Options for parameter list:

Examples:

dbctl set test2 --cpu=150,100,70,50 --read=2048,1500,1000,800

sets individual limits for cpu (current, short, middle period) and read (current, short, middle, long periods) for user test2

dbctl set default --cpu=70,60,50,40

changes default cpu limits.

All new limits will be applied immediately

To unrestrict user:

dbctl unrestrict username

To unrestrict all users:

dbctl unrestrict-all 

To restrict user:

dbctl restrict dbgov

To restrict user to level 2 restriction:

dbctl restrict dbgov --level=2

To make Governor to ignore user:

dbctl ignore username

Delete user's limits, and use defaults instead:

dbctl delete username

Show limits as bytes:

dbctl list --bb

# lveinfo --dbgov

lveinfo --dbgov --help

Displays information about DB Governor historical usage

Usage:

lveinfo [OPTIONS]

Optional arguments:

# dbgovchart

dbgovchart is analog of lvechart tool to create charts representing customer's to MySQL usage

Usage: /usr/sbin/dbgovchart [OPTIONS]

Acceptable options are:

--help      This help screen
--version   Version number
--from=     Run report from date and time in YYYY-MM-DD HH:MM format
            if not present last 10 minutes are assumed
--to=       Run report up to date and time in YYYY-MM-DD HH:MM format
            if not present, reports results up to now
--period=   Time period
            specify minutes with m,  h - hours, days with d, and values:
            today, yesterday
            5m - last 5 minutes, 4h - last four hours, 2d - last 2 days,
            as well as today
--user=     mysql username
--output=   Filename to save chart as, if not present, output will be sent to STDOUT
--show-all  Show all graphs (by default shows graphs for which limits are set)

Charts examples:

# PHP Selector

• selectorctl

# selectorctl

selectorctl is a new tool that replaces cl-selector (which is deprecated and should not be used anymore) and piniset. It is available starting with CageFS 5.1.3.

All new features will be implemented as part of selectorctl.

Common options

Global options

The global options modify settings in /etc/cl.selector/defaults.cfg file.

End user options

All end user settings are contained in individual user's alt_php.ini files and controlled using selectorctl command.

Additional options

# Python Selector

• Hoster
• Examples
• Examples
• End user

Below, there is a list of commands hoster and end user can run in a command line.

# Hoster

• Get all Python-related information: default version, a list of supported versions, status of Python Selector, a list of users, their applications, etc:

  cloudlinux-selector [get] [--json] --interpreter python
  

  JSON output for get command:

{
  "selector_enabled": true | false, 
  "default_version": "2.7.15", 
  "result": "success", 
  "timestamp": 1508667174.220027,
  “cache_status”: “ready”,         //  or “updating” during automatic yum cache rebuild
  "available_versions": {   //  begin of  “versions”
      "2.7.15" : {   //   begin of version "2.7.15"
          "status": "enabled",  //  enabled, disabled, not_installed, installing, removing, locked
          “base_dir”: “/opt/alt/alt-python27”   //  empty when version is not installed
          “users”: {   //  begin of  “users”
              “user1”: {   //  begin of “user1”
	“homedir”: “/home/user1”,		
                 “applications”: {    //  begin of “applications”
                     “apps_dir/app1” : {   //   begin of application “apps_dir/app1”
                         “domain”: “cltest1.com”,
                         “app_uri”: “apps/my-app1”,
                         “startup_file” : “run.py”,
                         “entry_point” : “app”,
                         “app_status” : “started”,   // ‘started’ or ‘stopped’
                         “config_files” : [
                             “requirements.txt”,
                             “requirements-migration.txt”
                         ],
                         “env_vars” : {
                             “var1” : “value1”,
                             “var2” : “value2”
                         },
                     },   // end of application “apps_dir/app1”
                     “apps_dir/app2” : {    //   begin of application “apps_dir/app2”
                          << data for application “apps_dir/app2”  (same structure as for application “apps_dir/app1” above) >>
                     },   //  end of application “apps_dir/app2”
                 },   //  end of “applications”
              },   //  end of “user1”
              “user2”: {   //  begin of “user2”
                  << data for user “user2”  (same structure as for “user1” above) >>
              },   //  end of “user2”
          },   // end of “users”
        },    //  end of version “2.7.15”
      "8.21.5" : {   //   begin of version "3.3.7"
            << data for version "3.3.7"  (same structure as for version “2.7.15” above) >>
        },    //  end of version “3.3.7”
    },    //  end of “versions”
}   //   end of json

• Set default version, supported versions, and status of Python Selector:

  cloudlinux-selector set [--json] --interpreter python (--selector-status <enabled,disabled> | --default-version <str> | --supported-versions <str>)
  

# Examples

1. Enable Python Selector:

   cloudlinux-selector set --json --interpreter python --selector-status enabled
   

2. Set default Python Selector version as 3.3:

   cloudlinux-selector set --json --interpreter python --default-version 3.3
   

3. Set supported Python Selector version as 3.3:

   cloudlinux-selector set --json --interpreter python --supported-versions='{"2.7": false, "3.3": true}'
   

4. Install a specific Python version:

   cloudlinux-selector install-version --json --interpreter python --version 2.7
   

5. Uninstall a specific Python version:

   cloudlinux-selector uninstall-version --json --interpreter python --version 2.7
   

6. Enable a specific Python version:

   cloudlinux-selector enable-version --json --interpreter python --version 2.7
   

7. Disable a specific Python version:

   cloudlinux-selector disable-version --json --interpreter python --version 2.7
   

• Change version for an application:

  • For a specific application:

    cloudlinux-selector set [--json] --interpreter python --user <str> --app-root <str> --new-version <str>
    

  • For all applications that use specific Python version:

    cloudlinux-selector change-version-multiple --json --interpreter python --from-version <str> --new-version <str>
    

  • For multiple applications:

    cloudlinux-selector change-version-multiple --json --interpreter python --data  <pairs user:app-root as json> --new-version <str>
    

# Examples

1. Change version for a specific application:

   cloudlinux-selector set --json --interpreter python --user user1 --app-root apps_dir/app1 --new-version 2.7
   

2. Change version for all applications that use version 2.7.15 to version 3.3.5:

   cloudlinux-selector change-version-multiple --json --interpreter python --from-version 2.7 --new-version 3.3
   

3. Change version of multiple application(s) and/or multiple users:

   cloudlinux-selector change-version-multiple --json --interpreter python --data <pairs user:app-root as json> --new-version <str>
   

Example

cloudlinux-selector change-version-multiple --json --interpreter python --data [ {“user”: “user1”, “app_root”: “apps/app1”}, {“user”: “user2”, “app_root”: “apps/app1”} ]  --new-version 2.7

Common output for all set commands:

in case of success:

{
  "result": "success", 
  "timestamp": 1508666792.863358
}

in case of error:

{
  "result": "Some error message",
  "details" : "Traceback: ..." ,
  "context": {},
  "timestamp": 1508666792.863358
}

in case of warning:

{
  "result": "success",
  "warning" : "Some warning message" ,
  "context": {},
  "timestamp": 1508666792.863358
}

# End user

/bin/cagefs_enter.proxied /usr/sbin/cloudlinux-selector --json <other parameters>

• Get config file for the user application:

  cloudlinux-selector read-config [--json] --interpreter python  [--user <str> | --domain <str>] --app-root <str> --config-file <name>
  

  JSON output:

  {
    	"result": "success", 
   "timestamp": 1508666792.863358
   	 “data”: “content of config file as Base64 encoded string”
  }
  

  Example:

  cloudlinux-selector read-config --json --interpreter python  --user user1 --app-root app_dir/app1 --config-file requirements.txt
  

• Save config file for user application:

  cloudlinux-selector save-config [--json] --interpreter python  [--user <str> | --domain <str>] --app-root <str> --config-file <path> --content <content of config file as Base64 encoded string>
  

  JSON output (the same as for all set commands):

  {
    	"result": "success", 
  "timestamp": 1508666792.863358
  }
  

  Example:

  cloudlinux-selector save-config --json --interpreter python  --user user1 --app-root app_dir/app1 --config-file requirements.txt  --content VGh1ICAyIE5vdiAxMDo0MzoxMiBFRFQgMjAxNwo=
  

  Note

  An output for all commands below is like in Hoster’s CLI, but filtered out by username.

• Get a list of applications for a specific user:

  cloudlinux-selector [get] [--json] --interpreter python  [--user <str> | --domain <str>]
  

  Example:

  cloudlinux-selector get --json --interpreter python  --user user1
  

• Create user application:

  cloudlinux-selector create [--json] --interpreter python  [--user <str> | --domain <str>]  --app-root <str> --app-uri <str> [--version <str>]  [--startup-file <str>] [--entry-point <str>] [--env-vars <json string>]
  

  Example:

  cloudlinux-selector create --json --interpreter python --app-root my_apps/app1 --domain xyz.com --app-uri apps/app1 --version 2.7 --startup-file run.py --entry-point app
  

• Start, restart, stop, and destroy user application:

  cloudlinux-selector (start | restart | stop | destroy) [--json] --interpreter python [--user <str> | --domain <str>] --app-root <str>
  

  Example:

  cloudlinux-selector start --json --interpreter python --user user1 --app-root my_apps/app1
  

• Set a custom path for Passenger log files:

  Example:

  cloudlinux-selector --json create --interpreter=python --version=3.3 --user=cltest1 --app-root=p_app2 --app-uri=p_app2_uri --passenger-log-file=/home/cltest1/passenger.log
  

• Remove a custom path for Passenger log files:

  Example:

  cloudlinux-selector --json set --interpreter=python --user=cltest1 --app-root=p_app1 --passenger-log-file=""
  

• Change properties for an application:

  cloudlinux-selector set [--json] --interpreter python  [--user <str> | --domain <str>] --app-root <str> [--app-mode <str>]  [--new-app-root <str>]  [--new-domain <str>]  [--new-app-uri <str>]  [--new-version <str>]  [--startup-file <str>] [--entry-point <str>] [--env-vars <json string>] [--config-files <str>]
  

  Example:

  cloudlinux-selector set --json --interpreter python  --user user1 --app-root my_apps/app1 --app-mode production  --new-app-root new_apps/new_app1  --new-domain new.xyz.com --new-app-uri new_apps/app1  --new-version 8  --startup-file new_app.js --env-vars { “var1” : “value1”, “var2” : “value2” }  --config-files requirements.txt,reqs.txt
  

• Run PIP install for user application:

  cloudlinux-selector install-modules [--json] --interpreter python  [--user <str> | --domain <str>] --app-root <str> --requirements-file <path>
  

  Example:

  cloudlinux-selector install-modules --json --interpreter python --user user1 --app-root my_apps/app --requirements-file requirements.txt
  

• Optional: install or uninstall Python packages for user application:

  cloudlinux-selector (install-modules|uninstall-modules) [--json] --interpreter python  [--user <str> | --domain <str>] --app-root <str> --modules <module1[,module2...]>
  

  Example:

  cloudlinux-selector install-modules --json --interpreter python --user user1 --app-root my_apps/app --modules json-annotate,termcolor
  

• Optional: run Python script in virtual environment of user application, arguments <args> are passed to the script:

  cloudlinux-selector run-script [--json] --interpreter python  [--user <str | --domain <str>>] --app-root <str> --script-name <str> [-- <args>...]
  

  Example:

  cloudlinux-selector run-script --json --interpreter python --user user1 --app-root my_apps/app --script-name test_script -- --script_opt1 --script_opt2 script_arg1 script_arg2
  

  JSON output:

  {
    	"result": "success", 
   	"timestamp": 1508666792.863358
     	“data”: “script output as Base64 encoded string”
  }
  

# Ruby Selector

To create application run:

/usr/bin/selectorctl --interpreter=ruby --version=VERSION [--user=USER] [--print-summary] [--json] --create-webapp <FOLDER_NAME> <URI>

/usr/bin/selectorctl --interpreter=ruby [--user=USER] [--print-summary] [--json] --destroy-webapp <FOLDER_NAME>

/usr/bin/selectorctl --interpreter=ruby [--user=USER] [--print-summary] [--json] --relocate-webapp <FOLDER_NAME> <NEW_FOLDER_NAME>

To change application URI :

/usr/bin/selectorctl --interpreter=ruby [--user=USER] [--print-summary] [--json] --transit-webapp <FOLDER_NAME> <NEW_URI>

To change application interpreter version:

/usr/bin/selectorctl --interpreter=ruby [--user=USER] [--print-summary] [--json] --set-user-current --version=<NEW VERSION> <FOLDER_NAME>

To restart application:

selectorctl --interpreter ruby --user cltest1 --domain cltest1.com --restart-webapp testapp

selectorctl --interpreter=ruby --user=$USER -v 2.0

# Node.js Selector

• Hoster
• End user

Below is a list of commands hoster and end user can run in a command line.

# Hoster

Get information related to Node.js: default version, list of supported versions, status of Node.js Selector , list of users, their applications, etc:

cloudlinux-selector [get] [--json] --interpreter nodejs

JSON output for get command:

{  
"selector_enabled": true | false,   
"default_version": "6.11.3",   
"result": "success",   
"timestamp": 1508667174.220027  
"cache_status": "ready"         //  or “updating” during automatic yum cache rebuild  
"available_versions": {   //  begin of  “versions”
      "6.11.3" : {   //   begin of version "6.11.3"
		"name_modifier": "",
		"status": "enabled",  //  enabled, disabled, not_installed, installing, removing
		“base_dir”: “/opt/alt/alt-nodejs6”   //  empty when version is not installed
		“users”: {   //  begin of  “users”                      
			“user1”: {   //  begin of “user1”
				“homedir”: “/home/user1”,
				“applications”: {    //  begin of “applications”
					“apps_dir/app1” : {   //   begin of application “apps_dir/app1”
						“domain”: “cltest1.com”,
						“app_uri”: “apps/my-app1”,
						“app_mode” : “development”,
						“startup_file” : “app.js”,
						“app_status” : “started”,   // ‘started’ or ‘stopped’
						“config_files” : [
							“package.json”,
							“gruntfile.js”
						],
						“env_vars” : {
							“var1” : “value1”,
							“var2” : “value2”
						},
					},   // end of application “apps_dir/app1”
					“apps_dir/app2” : {    //   begin of application “apps_dir/app2”
						<< data for application “apps_dir/app2”  (same structure as for application “apps_dir/app1” above) >>
					},   //  end of application “apps_dir/app2”
				},   //  end of “applications”
			},   //  end of “user1”
			“user2”: {   //  begin of “user2”
				<< data for user “user2”  (same structure as for “user1” above) >>
			},   //  end of “user2”
		},   // end of “users”
	},    //  end of version “6.11.3”
	"8.21.5" : {   //   begin of version "8.21.5"
		<< data for version "8.21.5"  (same structure as for version “6.11.3” above) >>
	},    //  end of version “8.21.5”
},    //  end of “versions”}   //   end of json

Set default version, supported versions, and status of Node.js Selector :

cloudlinux-selector set [--json] --interpreter nodejs (--selector-status <enabled,disabled> | --default-version <str> | --supported-versions <str>)

To set default Node.js version, please use the following command (note that required Node.js version should be enabled):

cloudlinux-selector set --json --interpreter=nodejs --default-version=<ver>

Examples:
This command enables Node.js Selector :

cloudlinux-selector set --json --interpreter nodejs --selector-status enabled

This command sets default Node.js version as 6:

cloudlinux-selector set --json --interpreter nodejs --default-version 6

This command sets supported Node.js version as 8:

cloudlinux-selector set --json --interpreter nodejs --supported-versions='{"6": false, "8": true}'

Install required Node.js version:

cloudlinux-selector install-version --json --interpreter nodejs --version 8

Uninstall required Node.js version:

cloudlinux-selector uninstall-version --json --interpreter nodejs --version 8

Enable required Node.js version:

cloudlinux-selector enable-version --json --interpreter nodejs --version 8

Disable required Node.js version (note that it is impossible to disable default Node.js version):

cloudlinux-selector disable-version --json --interpreter nodejs --version 8

Change version for application(s):

cloudlinux-selector set [--json] --interpreter nodejs ((--user <str> |  --domain <str>) --app-root <str> | --from-version <str>) --new-version <str>

Examples :
This command changes version for the specific application:

cloudlinux-selector set --json --interpreter nodejs --user user1 --app-root apps_dir/app1 --new-version 8

Common output for all set commands:

in case of success :

{  "result": "success",   "timestamp": 1508666792.863358}

in case of error:

{  "result": "Some error message",  "details" : "Traceback: ..." ,  "context": {},  "timestamp": 1508666792.863358}

in case of warning:

{  "result": "success",  "warning" : "Some warning message" ,  "context": {},  "timestamp": 1508666792.863358}

To resolve issues related to install-version/uninstall-version commands (because they are running in the background) you may use this log file /var/log/cl-nodejs-last-yum.log It contains full yum output from the latest performed operation (install or uninstall) and it will be rewritten with each operation.

# End user

Get config file for the user applications

cloudlinux-selector read-config [--json] --interpreter nodejs  [(--user <str> |  --domain <str>)] --app-root <str> --config-file <name>

JSON output:

{
    "result": "success",
	"timestamp": 1508666792.863358
	"data": "content of config file as Base64 encoded string"
}

Example:

This command gets config file for user1 ’s application app1 :

cloudlinux-selector read-config --json --interpreter nodejs  --user user1 --app-root app_dir/app1 --config-file package.json

cloudlinux-selector save-config [--json] --interpreter nodejs  [(--user <str> | --domain <str>)] --app-root <str> --config-file <path> --content <content of config file as Base64 encoded string>

JSON output (the same as for all set commands):

{
          "result": "success",
		  "timestamp": 1508666792.863358
}

Example:
This command saves config file for user1 ’s application app1 :

cloudlinux-selector save-config --json --interpreter nodejs  --user user1 --app-root app_dir/app1 --config-file package.json  --content                                         VGh1ICAyIE5vdiAxMDo0MzoxMiBFRFQgMjAxNwo=

cloudlinux-selector [get] [--json] --interpreter nodejs  [(--user <str> |  --domain <str>)]

Example:
This command gets a list of applications for the user1 :

cloudlinux-selector get --json --interpreter nodejs  --user user1

cloudlinux-selector create [--json] --interpreter nodejs [(--user <str> | --domain <str>)] --app-root <str> --app-uri <str> [--version <str>] [--app-mode <str>] [--startup-file <str>] [--env-vars <json string>]

Example:
This command creates user1 's application for the domain xyz.com :

cloudlinux-selector create --json --interpreter nodejs --user user1 --app-root my_apps/app1 --app-uri apps/app1

cloudlinux-selector create --json --interpreter nodejs --app-root my_apps/app1 --domain xyz.com --app-uri apps/app1

cloudlinux-selector (start | restart | stop | destroy) [--json] --interpreter nodejs  [(--user <str> | --domain <str>)] --app-root <str>

Example: This command starts user1 's application:

cloudlinux-selector start --json --interpreter nodejs --user user1 --app-root my_apps/app1

cloudlinux-selector set [--json] --interpreter nodejs  [(--user <str> | --domain <str>)] --app-root <str> [--app-mode <str>] [--new-app-root <str>] [--new-domain <str>] [--new-app-uri <str>] [--new-version <str>] [--startup-file <str>] [--env-vars <json string>]

Examples:

This command sets a custom path for Passenger log files:

cloudlinux-selector --json create --interpreter=nodejs --user=cltest1 --app-root=p_app2 --app-uri=p_app2_uri --passenger-log-file=/home/cltest1/passenger.log

This command removes a custom path for Passenger log files:

cloudlinux-selector --json set --interpreter=nodejs --user=cltest1 --app-root=p_app1 --passenger-log-file=""

Example 1: This command sets a production mode, new domain new.xyz.com , new Node.js version 8, new URI , new application root directory and new startup file for user1 application located on the domain xyz.com :

cloudlinux-selector set --json --interpreter nodejs  --user user1 --app-root my_apps/app1 --mode production  --new-app-root new_apps/new_app1  --new-domain new.xyz.com --new-app-uri new_apps/app1  --new-version 8  --startup-file new_app.js --env-vars '{ "var1" : "value1", "var2" : "value2" }'

Example 2:

cloudlinux-selector set --json --interpreter nodejs  --domain xyz.com --app-root my_apps/app1 --mode production  --new-app-root new_apps/new_app1  --new-domain new.xyz.com --new-app-uri new_apps/app1  --new-version 8  --startup-file new_app.js --env-vars '{ "var1" : "value1", "var2" : "value2" }'

Run npm install command for the user application

cloudlinux-selector install-modules [--json] --interpreter nodejs  [(--user <str> |  --domain <str>)] --app-root <str>

Example: This command runs npm install for user1 application:

cloudlinux-selector install-modules --json --interpreter nodejs --user user1 --app-root my_apps/app

Run a script from package.json file of a user application, arguments args are passed to the script

cloudlinux-selector run-script [--json] --interpreter nodejs  [(--user <str> | --domain <str>)] --app-root <str> --script-name <str> [-- <args>...]

Example:

cloudlinux-selector run-script --json --interpreter nodejs --user user1 --app-root my_apps/app --script-name test_script -- --script_opt1 --script_opt2 script_arg1 script_arg2

JSON output:

{
          "result": "success",
		  "timestamp": 1508666792.863358
		  "data": "script output as Base64 encoded string"
}

Activate virtual environment of NodeJS:

source <home_of_user>/nodevenv/<app_root>/<nodejs_version>/bin/activate

This command changes prompt to Example:

[newusr@test ~]$ source /home/newusr/nodevenv/newapp4/newapp3/8/bin/activate
[newapp4/newapp3 (8)]  
[newusr@test ~]$

After activation user can use npm and node from a virtual environment without full paths.

# Apache mod_lsapi PRO

switch_mod_lsapi is the command line tool used to manage mod_lsapi PRO.

It has the following syntax:

/usr/bin/switch_mod_lsapi [OPTIONS]

[OPTIONS] can be the main and an additional (for usage together with any other main option).

Main options

Additional options

The following table presents which [OPTIONS] are supported for various panels:

# Website Monitoring tool and Slow Site analyzer

# The cloudlinux-ssa-manager utility

The cloudlinux-ssa-manager utility allows to manage Slow Site analyzer via CLI.

Usage

/usr/sbin/cloudlinux-ssa-manager [command] [--optional arguments]

Optional arguments:

Commands:

You can use the -h, --help option with commands to get a full list of available optional arguments for each command.

Example of the /usr/sbin/cloudlinux-ssa-manager set-config --help command output:

/usr/sbin/cloudlinux-ssa-manager set-config --help  
............ 

usage: cloudlinux-ssa-manager set-config [-h]
                                         [--domains-number DOMAINS_NUMBER]
                                         [--urls-number URLS_NUMBER]
                                         [--requests-duration REQUESTS_DURATION]
                                         [--request-number REQUEST_NUMBER]
                                         [--time TIME]
                                         [--correlation CORRELATION]
                                         [--correlation-coefficient CORRELATION_COEFFICIENT]
                                         [--ignore-list IGNORE_LIST]
optional arguments:
  -h, --help            show this help message and exit
  --domains-number DOMAINS_NUMBER
                        Size of TOP list for slow domains
  --urls-number URLS_NUMBER
                        Size of TOP list for slow urls
  --requests-duration REQUESTS_DURATION
                        The threshold value of request duration in seconds
  --request-number REQUEST_NUMBER
                        The threshold value of slow requests number in the
                        period of time to mark URL as a slow one
  --time TIME           Period of time in hours required to analyze these
                        requests
  --correlation CORRELATION
                        Flag to enable or disable correlation
  --correlation-coefficient CORRELATION_COEFFICIENT
                        The threshold value of correlation coefficient
  --ignore-list IGNORE_LIST
                        List of URLs or domains that should not be included in
                        the daily report

# The wmt-api utility

The wmt-api utility allows to manage Website Monitoring tool via CLI.

Usage

/usr/share/web-monitoring-tool/wmtbin/wmt-api [command] [--optional arguments]

Optional arguments:

Commands:

Example of the /usr/share/web-monitoring-tool/wmtbin/wmt-api command usage:

/usr/share/web-monitoring-tool/wmtbin/wmt-api -config-change "{\"ping_connections\":8,\"report_top\":5,\"report_email\":\"user@example.com\"}"

This way you can set all or only certain parameters.

# X-Ray Autotracing

# The cloudlinux-autotracing utility

The cloudlinux-autotracing utility allows to manage the X-Ray Autotracing via CLI.

Usage

/usr/sbin/cloudlinux-autotracing [command] [--optional arguments]

Commands:

Optional arguments:

You can use the -h, --help option with commands to get a full list of available optional arguments for each command.

Example usage:

Disable user1:

/usr/sbin/cloudlinux-autotracing disable user1
{"result": "success"}

Show list of disabled users:

/usr/sbin/cloudlinux-autotracing status --list-disabled
{"result": "success", "disabled_users": ["user1"]}

Enable all:

/usr/sbin/cloudlinux-autotracing enable --all
{"result": "success"}

# Other CLI tools

• cldeploy
• lvectl
• lveps
• lvetop
• cldetect
• cldiag
• cloudlinux-config
• cl-quota
• cloudlinux-limits

# cldeploy

sh cldeploy --help

Usage:

The script will perform the following actions:

1. Register server with CLN.
2. Install CloudLinux OS Shared kernel, lve libraries, lve-utils, lve-stats and pam_lve packages.
3. Attempt to detect control panel and do the following actions:

• For cPanel:

  • install mod_hostinglimits;
  • install LVE Manager.

• For DirectAdmin:

  • recompile Apache to install mod_hostinglimits;
  • install LVE Manager.

• For Plesk, ISPManager & InterWorx:

  • update httpd and install mod_hostinglimits;
  • install LVE Manager.

• To disable installation of LVE Manager and mod_hostinglimits, please use --conversion-only option.

• To disable installation of kernel & CLN registration, please use --components-only option.

• To install mod_hostinglimits only, use --hostinglimits option.

Examples:

cldeploy --key xx-xxxxxx                            # convert RHEL/CentOS to CL by using activation key, install control panel components
cldeploy --key xx-xxxxxx --force-hybridize           # convert RHEL/CentOS 7 to CL7h by using activation key, install control panel components (from v1.61)
cldeploy --byip --conversion-only                   # convert RHEL/CentOS to CL by ip, don't install control panel components
cldeploy --components-only                          # install control panel components on already converted system
cldeploy --hostinglimits                            # update httpd and install mod_hostinglimits 

# lvectl

lvectl is the primary tool for LVE management. To use it, you have to have administrator access. lvectl is a part of lve-utils package.

lvectl syntax

Usage: lvectl command [lveid] [options]

Commands

Options

Examples

• Reset all LVEs settings based on configuration in /etc/container/ve.cfg:

  lvectl apply all
  

• Set new default CPU & Physical memory limit:

  lvectl set default --speed=100% --pmem=256m
  

• Reset all LVE's killing processes inside them:

  lvectl destroy all
  

• Show list of LVEs and their limits:

  lvectl list
  

# lveps

lveps tool shows information about running LVEs, processes and threads belonging to them, CPU/memory/IO usage consumed by LVEs and their individual processes/threads. LVE is only reported if it is considered active (at least one thread belongs to that LVE or was running during measurement in dynamic mode).

Usage:

lveps [-p] [-n] [-o <fmt1:width1,...>] [-d] [-c <time>] [-s <style>] [-t] [-h]

Options:

Command like lveps -p will display processes running inside 'active' LVEs.

# lvetop

lvetop utility allows to monitor LVE usage:

ID        EP PNO TNO SPEED MEM  IO   IPOS
testuser1 0  1   1   0%    7    0    0
testuser2 0  0   0   5%    0    3    0
testuser3 1  2   2   0%    102  2727 0
testuser4 0  1   1   0%    12   84   1
testuser5 0  2   2   1%    52   0    0

lvetop fields:

# cldetect

• clsupergid auto-configuration

cldetect is used to detect installed software, and adjust CloudLinux OS Shared options accordingly.

Usage:

/usr/bin/cldetect [--options]

# clsupergid auto-configuration

Each time lve-utils package is installed or upgraded it does some automatic system re-configuration to make some software (like nagios) work correctly, if it’s installed, by calling cldetect --setup-supergids command.

Starting from lve-utils 3.0-21 a behaviour of cldetect --set-nagios (now, it’s a part of cldetect --setup-supergids) command slightly changed.

If fs.proc_super_gid was configured by an admin to some existing group, the command will just add Nagios user to this group.

# cldiag

cldiag utility is included in lve-utils package and is intended for:

• server diagnostics performed by a server administrator for detecting the most common errors in the configuration or software operation;
• the focused check of the servers for typical errors performed by the support engineers before proceeding to the detailed analysis of the customer tickets;
• servers automatic check by cron with the following generation of the reports and email them to the server administrator.
  • Set option ENABLE_CLDIAG to false in config /etc/sysconfig/cloudlinux if you want to disable automatic check by cron permanently
  • Use the cldiag key --disable-cron-checkers for disabling separate checkers if you want to disable only some checkers (lve-utils >= 4.2.18-1)
  • A default email is root@localhost.localdomain. Note that the settings of the mail server can change the final email.

You can change the email in the following ways:

• In your control panel by changing the mail server settings
• By changing the /etc/sysconfig/cloudlinux config:
  • Set the desired email instead of the default CP value in the EMAIL option
  • Set the CP value in the EMAIL option in the license_check section. Add an option with the path to the panel script for receiving emails:

    {PANEL_NAME}_getemail_script=/path/to/getemail_script)
    
  {PANEL_NAME} is the name of the panel from the cldetect --detect-cp-name command output.
  • If there is no panel script, the default email (root@localhost.localdomain) will be used.
  • The /path/to/getemail_script file should be executable and output to stdout the admin email to which an email with checks results will be sent. Note that the settings of the mail server can change the final email.

In all cases, for the negative checker result, the exit code will be > 0 (at the moment it will be equal to the number of failed checkers).

All the checkers support additional --json option with the unified output in an appropriate format.

For example:

cldiag --symlinksifowner --json

{"total_errors": 0, "Check fs.enforce_symlinksifowner is correctly enabled in /etc/sysctl.conf": {"res": "OK", "msg": "fs.enforce_symlinksifowner = 1"}}

Each checker returns a typical result with the name of the check performed (brief description), one of the possible statuses of its execution, and detailed information on its fail or success.

For example:

Check fs.enforce_symlinksifowner is correctly enabled in /etc/sysctl.conf:

OK: fs.enforce_symlinksifowner = 1

Check suexec has cagefs jail:

SKIPPED: SuEXEC is not enabled

Possible checkers results:

1. OK - the check succeeded.
2. FAILED - the check revealed a problem.
3. SKIPPED - the check was skipped as it made no sense in the actual environment (e.g. wrong control panel) or it could not be executed for some reason (e.g. no users with enabled CageFS found). Such result doesn’t mean there is a problem and can be considered as a positive.
4. INTERNAL_TEST_ERROR - the check has failed because of a problem in the checker itself. Please report such problems using https://cloudlinux.zendesk.com/agent/.

The utility includes several built-in checkers, and can also import and run checkers from other utilities.

Currently implemented checkers:

# diag-cp

Checks control panel and its configuration (for DirectAdmin only).

Checking control panel availability, thereby detecting it with our code. Displaying control panel name and version. Also, for DirectAdmin, checking if CloudLinux OS Shared support is enabled in its config.

Fails if /usr/local/directadmin/custombuild/options.conf does not contain cloudlinux=yes line (for DirectAdmin control panel).

# symlinksifowner

Checks fs.enforce_symlinksifowner is correctly enabled in /etc/sysctl.conf.

Checking specified kernel setup described in this docs section for deprecated value and displaying its current value.

Fails if /proc/sys/fs/enforce_symlinksifowner contains value 2 (it is deprecated and can cause issues for the system operation).

# check-suexec

Checks suexec has cagefs jail.

In case if CageFS is installed and SuEXEC is on, checking if CageFS is enabled for SuEXEC.

Fails if CageFS is not enabled for suexec binary.

# check-suphp

Checks suphp has cagefs jail.

In case if CageFS is installed and SuPHP is on, checking if CageFS is enabled for SuPHP.

Fails if CageFS is not enabled for suphp binary.

# check-usepam

Checks usepam setting in /usr/sbin/sshd -T output.

Checking if /usr/sbin/sshd -T output contains usepam yes line, which is required for pam_lve correct work with sshd.

Fails if /usr/sbin/sshd -T output contains usepam no. You could specify UsePAM yes in /etc/ssh/sshd_config.

# check-symlinkowngid

Checks fs.symlinkown_gid.

First checking if user Apache is available in the system (on some panels users httpd or nobody with special GID are present instead of Apache, they are detected correctly as well). Then, if such user exists, checking that his GID equals to the one specified in sysctl or that this user belongs to this supplemental group. If these conditions are met, then the protection effect described in this docs section is applied to this user, and the appropriate message will be displayed.

Fails if Apache user is not in the group specified in /proc/sys/fs/symlinkown_gid.

# check-cpanel-packages

Checks existence of all user's packages (cPanel only)

Reading PLAN= for all users from /var/cpanel/users and checking if all of them are present in /var/cpanel/packages and if not, then displaying them in pairs like user: plan. default and undefined packages are excluded from the check.

Fails if users from /var/cpanel/users/ directory have non-existing packages (packages do not exist in /var/cpanel/packages/ directory, except for undefined and default).

# check-defaults-cfg

Checks /etc/cl.selector/default.cfg.

Checking that if this config exists, the default PHP version is not disabled in it. Also performing minimal syntax checks for PHP modules settings and displaying the incorrect.

Fails if there are some problems in /etc/cl.selector/default.cfg found.

Possible reasons for failure:

• Default version is undefined, which means /etc/cl.selector/default.cfg file does not contain section [versions] with the defined default version.
• Default PHP version is disabled.

# check-cagefs

All checks for CageFS are described separately in this docs section and their start from cagefsctl utility is completely equivalent to the start from cldiag and is designed only for a better experience.

This checker includes a set of CageFS sub-checkers, failure of one (or more) of them causes general checker failure.

# check-php-conf

Checks /etc/cl.selector/php.conf.

Checking the config syntax for acceptable blocks and directives.

Fails if /etc/cl.selector/php.conf has incorrect format.

• File contains an invalid parameter (valid parameters: Directive, Default, Type, Comment, Range, Remark).

• File contains an invalid setting for the parameter Type (valid settings for the Type parameter: value, list, bool)

# check-phpselector

Checks compatibility for the PHP Selector

Detecting which PHP handler has been configured on the server and checking its compatibility with the CloudLinux OS Shared PHP Selector according to this table and displaying the corresponding message with the link to the documentation in case of a problem detected. No checks are performed for EasyApache3.

Failure reasons:

• The installed mod_ruid package is incompatible with the PHP Selector
• mod_suexec is not installed
• mod_suphp is not installed
• Absence of the /usr/local/lsws/conf/httpd_config.xml file (only for LiteSpeed server)

# check-lve-limits

Checks the validity of LVE limits on the server.

See this page for detailed description.

# check-rpmdb

# check-hidepid

A new checker check-hidepid is available starting from lve-utils-4.2.18-1 and later. It checks if CageFS is installed and if /proc is mounted without the hidepid=2 parameter.

• If CageFS is not installed, check-hidepid skips and outputs the following:

    Check mount with hidepid=2 option:
        SKIPPED: Cagefs is not installed
  

• If check-hidepid triggers and finds an issue, it outputs the following:

    Check mount with hidepid=2 option:
        FAILED: Details: hidepid protection disabled.
    Please, mount system with hidepid=2 for better security.
    Read more about hidepid option here: https://docs.cloudlinux.com/shared/cloudlinux_os_kernel/#remounting-procfs-with-hidepid-option
  

• If check-hidepid triggers and it's OK, it outputs the following:

    Check mount with hidepid=2 option:
        OK: hidepid protection enabled
  

# check-jwt-token

This new checker is available starting from LVE-Utils 4.2.21-2

Checks the validity and presence of the JWT token which is required for correct work of client part of Centralized Monitoring.

Failure reasons:

• The JWT token is absent in path /etc/sysconfig/rhn/jwt.token
• The JWT token is malformed
• The JWT token is expired.
• The issuer of JWT token is invalid.

In all cases try running rhn_check for getting a new token.

# check-cm-all

This new checker is available starting from LVE-Utils 4.2.21-2

Checks the things on a server of client which are required for correct work of client part of Centralized Monitoring:

• Checks the validity and presence of JWT token
• Checks that service cl_plus_sender is present, enabled and active
• Checks that service node_exporter is present, enabled and active
• Checks that service lvestats is present, enabled and active
• Checks that RPM packages cl-end-server-tools and cl-node-exporter are installed

# all

Performs diagnostic checks from the list:

• check_cp_diag
• check_symlinksifowner
• check_suexec
• check_suphp
• check_use_pam
• check_symlinkowngid
• check_existence_of_all_users_packages
• check_phpselector
• check_defaults_cfg
• check_php_conf
• check_lve_limits
• check_hidepid
• check_cagefs_partition_disk_quota
• fake_cagefs_checker

# generate-email

Performs diagnostic checks (from the list above) and generates HTML report sent to the administrator's email.

# cron-check

Performs the same diagnostic checks as generate-email but with considering the ENABLE_CLDIAG option in the /etc/sysconfig/cloudlinux.

Performs diagnostic checks from the list:

• check_symlinksifowner
• check_use_pam
• check_symlinkowngid
• check_existence_of_all_users_packages
• check_lve_limits
• check_hidepid
• check_cagefs_partition_disk_quota
• check_jwt_token
• check_cl_plus_sender_service
• check_node_exporter_service
• check_cmt_packages
• check_lvestats_service

# doctor

This option can be used instead of the following command:

wget -qq -O - https://repo.cloudlinux.com/cloudlinux/cldoctor/cldoctor.sh | bash

If this option is provided cldoctor script will be downloaded to a temp directory and executed by cldiag. Also the report will be automatically sent to our support team.

# cloudlinux-config

cloudlinux-config utility shows/sets various parameters related to LVE Manager UI, MySQL Governor and faults notifications for LVE-Stats 2

Usage:

cloudlinux-config get [--json] [--for-reseller resname ]
cloudlinux-config set [--json] --data <str> [--for-reseller resname ]
cloudlinux-config set [--json] --reset-inodes-limit

Commands:

Options

JSON data structure

All options are enclosed inside options (Level 0) string. All options are enclosed in " ", while values come as is. Here's an example:

'{"options":{"L1_option1":value1, "L1_option2":value2}}'

Each Level1 option can have nested Level2 options specified using the same syntax, the same goes for Level2 and Level3 options respectively.

LVE-Stats 2 faults notification settings

MySQL Governor settings

LVE Manager UI settings

Examples

• display Python/Ruby Selector in User UI (cPanel)

cloudlinux-config set --json --data '{"options":{"uiSettings":{"hideRubyApp":false, "hidePythonApp":false}}}'

# cl-quota

• General provisions
• Setting limits and integration with panel packages
• Limits inheritance
• Caching and synchronizing the limits
• Quotas DB file
• CLI options/examples

cl-quota utility is designed to control disk quotas and provides:

• Setting user and package limits.

• Integration with panel packages.

• Limits synchronization.

• Automatic inheritance of panel limits to all appropriate users.

# General provisions

cl-quota utility never sets/reads limits directly in the system, it uses standard setquota/repquota utilities included into the quota package for this purpose.

cl-quota will not work in the following cases:

• setquota/repquota are missing or working incorrectly;

• the quotas are not configured in the system.

cl-quota only performs the minimal diagnostics of quota related errors:

• verifies the availability of setquota/repquota utilities on the disk;

• verifies if quotas are activated for a specified user (with a separate command), see below.