Mgrctl is a utility that is used for performing operations with a control panel and calling its functions from the command line. The default location of the utility is /usr/local/mgr5/sbin/mgrctl.
Syntax
/usr/local/mgr5/sbin/mgrctl [-m <manager>] [-u | -i [lang=<language>] | -l | [[-o <output format>] [-R | <funcname> [[<param>=<value>] ...]] [[-e ‘<param>=$<ENV_NAME>’] ...]]] -m <manager> - a short name of a control panel associated with the command. Enter a short name after the key:
- core — COREmanager;
- billmgr — BILLmanager;
- vmmgr — VMmanager KVM or Cloud;
- vemgr — VMmanager OVZ;
- dcimgr — DCImanager;
- dcimini — DCImanager location;
- ipmgr — IPmanager;
- dnsmgr — DNSmanager.
-i — brief information about the functions of the control panel. If the function <funcname> is specified, brief information about all its parameters will be displayed. If the parameter lang is specified, the information on a selected language <language> will be displayed. Possible values:ru, en. The default value is ru.
-o <output format> — information output format. Possible values: text,xml, devel,json. The default value is text.
-l — suspend a control panel. The panel is suspended with the function exit. It cannot be restarted.
-u — resume the control panel that has been suspended with the -l key.
The control panels won't be activated if:
- The command mgrctl -m <manager> -l was executed to suspend several control panels on the server including COREmanager.
- COREmanager was activated with the command mgrctl -m core -u.
-R — restart the control panel before the function is executed.
<funcname> —a function name.
<param>=<value> — function parameter and its value.
-e ‘<param>=$<ENV_NAME>’ — parameters conveyed via environment variables.
Examples for IPmanager
/usr/local/mgr5/sbin/mgrctl -m ipmgr permstat