Утилита 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>] ...]]]
BASH

Где:

  • -m <manager> — определяет, к какой панели управления относится команда. После ключа укажите сокращённое название панели управления:
    • core — COREmanager;

    • billmgr — BILLmanager;

  • -i — краткая информация обо всех возможных функциях панели управления. Если указана функция <funcname>, то будет отображена краткая информация обо всех параметрах этой функции. Если указан параметр lang, то информация будет отображена на выбранном языке <language>. Доступные значения: ru, en. По умолчанию — ru;
  • -o <output format> — формат вывода информации. Доступные значения: text, xml, devel, json. По умолчанию — text;
  • -l — приостановить работу панели управления. панель управления останавливается вызовом функции exit. Повторный запуск панели управления блокируется;
  • -u — возобновить работу панели управления, приостановленной с помощью ключа -l;

    Если приостанавливается работа COREmanager, то приостанавливается работа BILLmanager на сервере. После возобновления работы COREmanager будет возобновлена работа остальных панелей управления на сервере. Однако, если приостановить и COREmanager, и BILLmanager, то после возобновления работы COREmanager работа BILLmanager не возобновится.

  • -R — перезапустить панель управления перед выполнением функции.
    • <funcname> — имя функции;
    • <param>=<value> — параметр функции и его значение;
  • -e <param>=$<ENV_NAME> —  параметры, передаваемые через переменные окружения.

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

Функция доступна в версии COREmanager 5.325 и выше.

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

 -e '<param>=$<ENV_NAME>'
BASH
  • <param> — имя параметра;
  • <ENV_NAME> — имя переменной окружения.

Укажите знак $ перед именем переменной окружения и заключите аргумент <param>=$<ENV_NAME> в одинарные кавычки.

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

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

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

    export SECRET_PASSWORD=secret
    BASH

  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
    BASH
  • /usr/local/mgr5/sbin/mgrctl — путь к утилите mgrctl;
  • -m billmgr — указывает, что команда относится к платформе BILLmanager;
  • ftp.user.edit — функция панели управления, предназначенная для создания или редактирования FTP-пользователя;
  • name=ftpuser — имя нового FTP-пользователя;
  • home=/ — определяет домашний каталог FTP-пользователя;
  • owner=www-root — указывает владельца FTP-аккаунта;
  • -e 'passwd=$SECRET_PASSWORD' — передаёт параметр passwd через переменную окружения SECRET_PASSWORD. Значение переменной будет подставлено как пароль FTP-пользователя;
  • sok=ok — обязательный параметр, подтверждающий выполнение операции.

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

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

Завершение работы платформы

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

Список всех доступных функций 

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

Список параметров определённой функции платформы

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

Примеры для BILLmanager

Отключить тарифный план

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

<id> — идентификатор тарифа.

Перезапуск BILLmanager

/usr/local/mgr5/sbin/mgrctl -m billmgr exit
CODE

Добавление сообщения в тикет

/usr/local/mgr5/sbin/mgrctl -m billmgr 'ticket.edit' name=theme message=text plid=ID elid=ID sok=ok su=admin
CODE
  • /usr/local/mgr5/sbin/mgrctl — путь к утилите mgrctl;
  • -m billmgr — указывает, что команда относится к платформе BILLmanager;
  • ticket.edit — функция платформы, отвечающая за создание или редактирование тикета;

  • name — тема запроса;

  • message — текст сообщения;

  • elid — id запроса в меню Запросы;

  • plid — id запроса в меню Все запросы;

  • sok=ok — обязательный параметр, подтверждающий выполнение операции;
  • su=admin — указывает, что операция выполняется от имени администратора. Здесь admin — имя учётной записи администратора в BILLmanager.

Получение списка тарифов

/usr/local/mgr5/sbin/mgrctl -m billmgr pricelist
CODE
  • /usr/local/mgr5/sbin/mgrctl — путь к утилите mgrctl;
  • -m billmgr — указывает, что команда относится к платформе BILLmanager;
  • pricelist — имя функции, которая возвращает список тарифных планов.

Может быть полезно

Связанные статьи: