Документация VMmanager 5 KVM

Утилита mgrctl

ISPSystem

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

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

  • core — COREmanager;
  • ispmgr — ISPmanager;

  • ispmgrnode — узел кластера ISPmanager Business;
  • billmgr — BILLmanager;

  • vmmgr — VMmanager KVM или Cloud;

  • vemgr — VMmanager OVZ;

  • dcimgr — DCImanager;

  • dcimini — локация DCImanager;
  • ipmgr — IPmanager;

  • dnsmgr — DNSmanager.

-i — краткая информация обо всех возможных функциях панели управления. Если указана функция <funcname>, то будет отображена краткая информация обо всех параметрах этой функции. Если указан параметр lang, то информация будет отображена на выбранном языке <language>. Доступные значения: ru, en. По умолчанию — ru.

-o <output format> — формат вывода информации. Доступные значения: text, xml, devel, json. По умолчанию — text.

-l — приостановить работу панели управления. Панель управления останавливается вызовом функции exit. Блокируется возможность её повторного запуска.

Обратите внимание!

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

-u — возобновить работу панели управления, приостановленной при помощи ключа -l.

Обратите внимание!

В случае если:

  1. Командой mgrctl -m <manager> -l поочерёдно приостановлена работа нескольких панелей управления на сервере, включая COREmanager.
  2. Командой mgrctl -m core -u возобновляется работа COREmanager.

Работа остальных панелей управления не будет возобновлена.

-R — перезапустить панель управления перед выполнением функции.

<funcname> — имя функции.

<param>=<value> — параметр функции и его значение.

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


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

Завершение работы панели управления
/usr/local/mgr5/sbin/mgrctl -m <manager> exit
Список всех доступных функций mgrctl для панели управления
/usr/local/mgr5/sbin/mgrctl -m <manager> -i
Список параметров определённой функции панели управления
/usr/local/mgr5/sbin/mgrctl -m <manager> -i funcname lang=ru

Примеры для VMmanager KVM

Остановить виртуальные машины
/usr/local/mgr5/sbin/mgrctl -m vmmgr vm.stop elid=<id1>,<id2>
 Пояснения
<id1>, <id2> — идентификаторы виртуальных машин
Остановить все виртуальные машины
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
Получить названия всех запущенных виртуальных машин
/usr/local/mgr5/sbin/mgrctl -m vmmgr vm | grep running | awk '{print $2}' | awk -F= '{print $2}'
Спасибо за ваш отзыв!
Была ли полезна статья?
Уточните, почему:

статья не соответствует названию

статью сложно понять

в статье нет ответа на мой вопрос

рекомендации из статьи не помогли

другая причина

Расскажите, что вам не понравилось в статье: