Mgrctl utility

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.

Note.

Suspending COREmanager will also suspend all the control panels on the server. Activating COREmanager will activate all the panels as well.

-u — resume the control panel that has been suspended with the -l key.

Note. h

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 VMmanager Cloud

Stop virtual machines

/usr/local/mgr5/sbin/mgrctl -m vmmgr vm.stop elid=<id1>,<id2>

Details

Stop all virtual machines

for i in $(/usr/local/mgr5/sbin/mgrctl -m vmmgr vm | awk '{print $1}' | awk -F= '{print $2}'); do /usr/local/mgr5/sbin/mgrctl -m vmmgr vm.stop elid=$i; done

Retrieve the names of all running virtual machines

/usr/local/mgr5/sbin/mgrctl -m vmmgr vm | grep running | awk '{print $2}' | awk -F= '{print $2}'