Утилита mgrctl

Утилита mgrctl предназначена для выполнения операций с панелью управления и вызова её функций из командной строки. По умолчанию она расположена в /usr/local/mgr5/sbin/mgrctl.

Синтаксис

/usr/local/mgr5/sbin/mgrctl [-m <manager>] [-u | -i [lang=<language>] | -l | [[-o <output format>] [-R | <funcname> [[<param>=<value>] ...]] [[-e <param>=$<ENV_NAME>] ...]]]

Где:

• -m — определяет, к какой панели управления относится команда. После ключа укажите сокращённое название панели управления:
  • core — COREmanager;
  • billmgr — BILLmanager;
  • vmmgr — VMmanager KVM или Cloud;
  • vemgr — VMmanager OVZ;
  • dcimgr — DCImanager 5;
  • dcimini — локация DCImanager 5;
  • ipmgr — IPmanager;
  • dnsmgr — DNSmanager;
• -i — краткая информация обо всех возможных функциях панели управления. Если указана функция <funcname>, то будет отображена краткая информация обо всех параметрах этой функции. Если указан параметр lang, то информация будет отображена на выбранном языке <language>. Доступные значения: ru, en. По умолчанию — ru;
• -o
  — формат вывода информации. Доступные значения: text, xml, devel, json. По умолчанию — text;
• -l — приостановить работу панели управления. панель управления останавливается вызовом функции exit. Повторный запуск панели управления блокируется;
• -u — возобновить работу панели управления, приостановленной с помощью ключа -l;
  
  Если приостанавливается работа COREmanager, то приостанавливается работа всех панелей управления на сервере. После возобновления работы COREmanager будет возобновлена работа остальных панелей управления на сервере. Однако, если приостановить и COREmanager, и панели управления, то после возобновления работы COREmanager работа панелей управления не возобновится.
• -R — перезапустить панель управления перед выполнением функции.
  • <funcname> — имя функции;
  • <param>=<value> — параметр функции и его значение;
• -e =$ —  параметры, передаваемые через переменные окружения.

Передача параметров через переменные окружения

Чтобы передать секретные данные в параметрах mgrctl, используйте переменные окружения. Для этого запустите утилиту с параметром:

 -e '<param>=$<ENV_NAME>'

Пример передачи пароля

Чтобы передать пароль:

1. Задайте значение пароля в переменной окружения SECRET_PASSWORD:

   export SECRET_PASSWORD=secret

2. Создайте в BILLmanager пользователя для FTP:

   /usr/local/mgr5/sbin/mgrctl -m billmgr ftp.user.edit name=ftpuser home=/ owner=www-root -e 'passwd=$SECRET_PASSWORD' sok=ok

Примеры использования

Общие примеры

/usr/local/mgr5/sbin/mgrctl -m <manager> exit

/usr/local/mgr5/sbin/mgrctl -m <manager> -i

/usr/local/mgr5/sbin/mgrctl -m <manager> -i funcname lang=ru

Примеры для BILLmanager

/usr/local/mgr5/sbin/mgrctl -m billmgr pricelist.suspend elid=<id>