VMmanager KVM API

Порядок работы с API-функциями см. в статье Взаимодействие через API.

Рецепты

Функция: recipemgr

Результат: список элементов.

Управление рецептами

Уровень доступа: admin user

• name — Рецепт

• revision — Ревизия

• state — Состояние

• tags — Тэги

• repo — Источник

• date — Дата

• filename — Файл

Запустить процесс обновления списка рецептов

Функция: recipemgr.update

Запустить процесс обновления списка рецептов

Уровень доступа: admin user

Удалить выбранные рецепты

Функция: recipemgr.delete

Удалить выбранные рецепты

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции recipemgr.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование рецепта

Функция: recipemgr.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции recipemgr)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции recipemgr)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• filename — Имя файла. Имя файла, в котором хранится рецепт

• encoding — Кодировка. Символьная кодировка рецепта. При смене кодировки внесенные в редакторе изменения будут УТЕРЯНЫ!

• fdata — .

• savetime — Сохранено в . В этом поле отображается время сохранения файла. Указывается время сервера

Репозиторий

Функция: recipemgr.repo

Результат: список элементов

Репозитории рецептов

Уровень доступа: admin user

• name — Репозиторий

• location — Ссылка

Удалить репозиторий

Функция: recipemgr.repo.delete

Удалить репозиторий

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции recipemgr.repo.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование репозитория рецептов

Функция: recipemgr.repo.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции recipemgr).
  • elid — уникальный идентификатор (элемент name из функции recipemgr.repo)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции recipemgr).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции recipemgr).
  • elid — уникальный идентификатор (элемент name из функции recipemgr.repo)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Репозиторий. Наименование репозитория

• location — Ссылка. Ссылка на файл архива рецептов

Свойства рецепта

Функция: recipemgr.props

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции recipemgr)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции recipemgr)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• access — Ограничение доступа к рецепту. Доступ к рецепту можно ограничить как для пользователей ('доступен администраторам'), так и для всех учетных записей, включая администраторов ('недоступен')

Узлы кластера

Функция: vmhostnode

Результат: список элементов

Узлы кластера

Уровень доступа: admin

• id — Id

• name — Наименование

• ip — IP-адрес

• vmcount — Количество VM

• storageinfo — Использовано хранилищ

• meminfo — Используется оперативной памяти

• memreserved — Зарезервировано памяти, MiB

• stat — Состояние

• vmminiver — Версия vmmini

• version_libvirt_str — Версия libvirt

• version_qemu_str — Версия QEMU

• priority — Приоритет

• uptime — Продолжительность работы

Редактирование узла кластера

Функция: vmhostnode.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vmhostnode)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vmhostnode)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование узла кластера

• addlocal — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выберите, чтобы добавить локальный сервер в качестве узла кластера

• localip — Адрес для доступа VMmanager. Выберите IP-адрес, по которому будет подключен локальный сервер

• ip — IP-адрес. IP-адрес узла кластера

• port — Порт ihttpd. Номер порта, по которому VMmanager KVM связывается с сервисом VMmini узла кластера

• sshkey — Публичный ключ. Публичный ssh ключ, который необходимо положить на сервер

• has_pwd — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если известен пароль для root, можно ввести его, и публичный ключ будет автоматически добавлен на сервер

• passwd — Пароль. Пароль для пользователя root

• maxvmcount — Максимальное количество VM. Максимальное количество VM, при превышении которого автоматическое размещение на данный узел будет приостановлено

• priority — Приоритет. Приоритет узла кластера. При возникновении проблем с основным узлом новым основным узлом становится узел с наибольшим приоритетом

• online — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выключенный узел не участвует в работе кластера и полностью игнорируется панелью. Виртуальные машины, находящиеся на выключенном узле кластера, отображаются в списке с соответствующей иконкой в строке статуса. Состояние таких виртуальных машин неизвестно.

• status — Автоматическое размещение VM. Выберите, каким образом узел участвует в автоматическом размещении. Для версии Cloud пункт 'запрещено для всех' сделает узел недоступным для любого автоматического размещения VM, в том числе при переносе с узла, вышедшего из кворума

• configuration — Примечание. Какая-либо информация о сервере

Нагрузка кластера

Функция: reporttop

Результат: отчёт

Отчет о нагрузке кластера

Уровень доступа: admin

Список виртуальных машин по выбранному узлу

Функция: vmhostnode.vm

Список виртуальных машин по выбранному узлу

Уровень доступа: admin

Наименование

Функция: vmhostnode.info

Результат: список элементов

Информация об узле кластера

Уровень доступа: admin

• type — Ресурс

• info — Информация

Наименование

Функция: vmhostnode.pool

Результат: список элементов

Список хранилищ на узле кластера

Уровень доступа: admin

• metapool — Шаблон хранилища

• capacity — Ёмкость

• available — Свободно

Обновить информацию о занятом пространстве в хранилище

Функция: vmhostnode.pool.refresh

Обновить информацию о занятом пространстве в хранилище

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент metapool из функции vmhostnode.pool.

Результат: успешное выполнение операции или сообщение об ошибке

Разрешить автоматичеcкое размещение VM на выбранном узле

Функция: vmhostnode.enable

Разрешить автоматичеcкое размещение VM на выбранном узле

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vmhostnode.

Результат: успешное выполнение операции или сообщение об ошибке

Запретить автоматичеcкое размещение новых VM на выбранном узле

Функция: vmhostnode.disable

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vmhostnode.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vmhostnode.net

Результат: список элементов

Список сетей на узле кластера

Уровень доступа: admin

• name — Наименование

• type — Тип

• bridge — Сетевой мост

• forward — Forward

• ipaddr — IP-адрес

Вернуть узел в кворум. Выполнить действия по восстановлению узла кластера в автоматическом режиме

Функция: vmhostnode.join

Вернуть узел в кворум. Выполнить действия по восстановлению узла кластера в автоматическом режиме

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vmhostnode.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: vmhostnode.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vmhostnode.

Результат: успешное выполнение операции или сообщение об ошибке

Роли узла кластера

Функция: role.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vmhostnode)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vmhostnode)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Брандмауэр

Функция: firewall

Результат: список элементов

Настройка брандмауэра

Уровень доступа: admin

• id — Имя файла

• name — Наименование

• proto — Протокол

• prio — Приоритет

Удалить

Функция: firewall.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции firewall.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование правил

Функция: firewall.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции firewall)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции firewall)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• proto — Протокол. Протокол для фильтрации пакетов (IPv4 или IPv6)

• prio — Приоритет. Приоритет выполнения скриптов с фильтром. Чем меньше это значение — тем раньше выполнится скрипт

• name — Наименование. Наименование скрипта. Файл будет сформирован с именем: NN_NAME.rule, где NN — приоритет, а NAME — значение данного поля

• rule — Правила. Каждая строка правила будет передана iptables в качестве параметра.

Пример:
-A INPUT -p tcp -m tcp --dport

49152:49261 -j ACCEPT

будет выполнено
iptables -A INPUT -p tcp -m tcp --dport 49152:49261 -j ACCEPT

Виртуальные машины

Функция: vm

Результат: список элементов

Виртуальные машины

Уровень доступа: admin user

• id — Id

• name — Наименование

• domain — Доменное имя

• hostnode — Узел кластера

• user — Владелец

• ip — Адрес IPv4

• ip6 — Адрес IPv6

• vmi — Шаблон ОС

• osname — ОС

• mem — Память, MiB

• vcpu — Количество ядер

• vdsize — Размер дисков, MiB

• status — Состояние

Резервные копии виртуальной машины

Функция: vm.backup

Резервные копии виртуальной машины

Уровень доступа: admin user

Запустить виртуальную машину

Функция: vm.start

Запустить виртуальную машину

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vm.snapshot

Результат: список элементов

Снимки виртуальной машины

Уровень доступа: admin user

• id — Id

• name — Наименование

• date — Время создания

• stype — Тип

• status — Состояние

Редактировать описание снимка VM

Функция: vm.snapshot.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.snapshot)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.snapshot)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование снимка, проверяется уникальность для отдельной виртуальной машины

• description — Описание. Описание снимка, произвольный текст

Удалить

Функция: vm.snapshot.delete

Удалить

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.snapshot.

Результат: успешное выполнение операции или сообщение об ошибке

Запустить процесс возврата к выбранному снимку

Функция: vm.snapshot.revert

Запустить процесс возврата к выбранному снимку

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.snapshot.

Результат: успешное выполнение операции или сообщение об ошибке

Изменение пароля виртуальной машины

Функция: vm.chpasswd

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• password — Новый пароль. Новый пароль для root

• confirm — Подтверждение. Подтверждение нового пароля

Параметр

Функция: vm.sysinfo

Результат: список элементов

Информация о виртуальной машине

Уровень доступа: admin user

• name — Параметр

• value — Значение

Установка фильтра.

vm.portfilter

Редактирование VM

Функция: vm.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• id — Идентификатор VM. Уникальный идентификатор виртуальной машины. Присваивается автоматически

• name — Наименование. Наименование виртуальной машины. После создания изменить нельзя

• user — Владелец. Владелец виртуальной машины

• hostnode — Узел кластера. Узел кластера, на котором будет создана виртуальная машина

• preset — Шаблон VM. Шаблон виртуальной машины. В нем заданы основные ресурсы

• installtype — Тип установки. Тип начальной установки: из шаблона ОС или с ISO-диска

• iso — Список ISO. Выберите образ ISO, чтобы подключить к новой виртуальной машине

• vmi — Шаблон ОС. Шаблон операционной системы

• recipe — Рецепт. Выполнить указанный рецепт (скрипт) в вирутальной машине после установки ОС

• osname — Операционная система. Произвольное наименование операционной системы, установленной на этой машине

• iptype — Тип IP-адреса. Публичный — с доступом из сети Internet, приватный — без, NAT — для использования с сетями NAT

• family — IP-адрес. Основной IP-адрес

• ipsource — Источник IP-адресов. Укажите источник для получения IP-адресов

• network — Имя сети. Имя сети NAT, для которой требуется выделить IP-адрес

• ip — IP-адрес. Введите IP-адрес который будет основным

• netmask — Маска сети. Маска сети в виде префикса (0..32 для IPv4, 0..128 для IPv6) или в виде '255.255.255.0' для IPv4

• gateway — IP-адрес шлюза. IP-адрес шлюза по умолчанию

• add_ipaliases — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Нужно добавить дополнительные IP адреса

• ipaliases — Дополнительные IP адреса в формате 192.168.0.1/24 192.168.0.254. Дополнительные IP адреса в формате ip/mask gateway. Каждый адрес с новой строки

• amount_ipv4 — Количество IPv4. Требуемое количество адресов IPv4

• ipv4_pool — Пул адресов IPv4. Получить адреса IPv4 из указанного пула

• amount_ipv6 — Количество IPv6. Требуемое количество адресов IPv6

• ipv6_pool — Пул адресов IPv6. Получить адреса IPv6 из указанного пула

• special_ipv4 — Определенные адреса IPv4. Введите адреса IPv4, разделяя их пробелом. Первый адрес из списка станет основным

• special_ipv6 — Определенные адреса IPv6. Введите вдреса IPv6, разделяя их пробелом. Первый адрес из списка станет основным

• main_ipv4 — Основной адрес IPv4. IPv4-адрес, отображаемый в списке виртуальных машин

• main_ipv6 — Основной адрес IPv6. IPv6-адрес, отображаемый в списке виртуальных машин

• domain — Домен. Доменное имя виртуальной машины

• vsize — Размер основного диска. Размер основного диска в мебибайтах. После создания изменить нельзя

• mem — Оперативная память. Объем оперативной памяти в мебибайтах. При изменении необходим перезапуск виртуальной машины

• vcpu — Количество процессоров. Количество виртуальных процессоров доступных виртуальной машине. При изменении необходим перезапуск виртуальной машины

• password — Пароль. Пароль суперпользователя, так же для доступа по VNC. Для доступа по VNC используются только первые 8 символов пароля

• confirm — Подтверждение пароля. Подтверждение пароля

• blocked — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции VM заблокирована от деструктивных действий. Ее нельзя остановить, запустить, удалить, переустановить, отобрать IP-адреса

• cpu_mode — Режим эмуляции процессора. При эмуляции процессора "по умолчанию" используется виртуальный процессор QEMU. При эмуляции в режиме 'host-model' используется описание процессора, определенное libvirt на основе процессора узла кластера. В режиме 'host-passthrough' в точности эмулируется процессор узла кластера. Настройка режима эмуляции может потребоваться для запуска ОС Windows 2016. Не изменяйте режим эмуляции без необходимости

• custom_cpu — Модель процессора. Перечень моделей доступен в файле /usr/share/libvirt/cpu_map.xml на узле кластера. Допустимо указывать модели, соответствующие вендору, архитектуре и набору возможностей процессора узла кластера

• custom_cpu_features — Перечень возможностей процессора. Возможности процессора, включаемые в обязательном порядке. Перечень всех возможностей процессора доступен в выводе консольной команды 'virsh capabilities' на узле кластера

• mac — MAC-адрес. MAC-адрес для виртуальной машины

• allowspoof — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении данной опции антиспуфинг для виртуальной машины отключается

• clock_offset — Установка времени. Способ синхронизации часов виртуальной машины с часами сервера

• cputune — Вес CPU. Вес cgroups для CPU. Виртуальная машина с весом 1024 получит приоритет в два раза выше на использование CPU по сравнению с виртуальной машиной с весом 512

• blkiotune — Вес использования I/O. Вес cgroups на дисковые операции. Позволяет понизить либо повысить приоритет по сравнению с остальными виртуальными машинами

• inbound — Входящий трафик, KiB/sec. Ограничение скорости передачи входящего трафика, KiB/sec

• outbound — Исходящий трафик, KiB/sec. Ограничение скорости передачи исходящего трафика, KiB/sec

• snapshot_limit — Количество снимков. Максимальное количество снимков, которые может создать пользователь для этой виртуальной машины

• vnchost — Сервер. IP-адрес VNC сервера

• vncport — Порт. Порт для доступа по VNC

• vncpassword — Пароль. Пароль для доступа по VNC. Максимальная длина пароля — 8 символов

• sshpubkey — Публичные SSH ключи. Публичные SSH ключи
• vmnote — Примечания. Дополнительные сведения о VM

Открыть VNC клиент в браузере

Функция: vm.novnc

Открыть VNC клиент в браузере

Уровень доступа: admin user

Наименование

Функция: vm.bandwidth

Результат: отчёт

Использование канала связи

Уровень доступа: user+

Установка фильтра.

vm.filter

Переустановка операционной системы

Функция: vm.reinstall

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• vmi — Шаблон ОС. Шаблон операционной системы

• recipe — Рецепт. Выполнить указанный рецепт (скрипт) в вирутальной машине после установки ОС

• osname — Операционная система. Произвольное наименование операционной системы, установленной на этой машине

• new_password — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Позволяет при переустановке операционной системы изменить пароль

• password — Пароль. Пароль для пользователя root

• confirm — Подтверждение.

• sshpubkey — Публичные SSH ключи. Публичные SSH ключи

Просмотреть историю изменений

Функция: vm.history

Просмотреть историю изменений

Уровень доступа: admin user

Остановить виртуальную машину

Функция: vm.stop

Остановить виртуальную машину

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.

Результат: успешное выполнение операции или сообщение об ошибке

Удаление виртуальной машины

Функция: vm.extdelete

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Виртуальная машина. Наименование виртуальной машины, которая будет удалена

• confirm — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При установленном признаке "игнорировать ошибки" виртуальная машина будет удалена в любом случае

Наименование

Функция: iplist

Результат: список элементов

Список IP-адресов

Уровень доступа: admin user

• id — Id

• ip — IP адрес

• domain — Домен

• gateway — Адрес шлюза

• netmask — Маска сети

Вернуться к предыдущему списку

Функция: '

Вернуться к предыдущему списку

Уровень доступа: admin user

Изменение IP-адреса

Функция: iplist.edit

Уровень доступа: new: admin ;edit: admin user ;

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции iplist)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции iplist)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• ipsource — Источник IP-адресов. Укажите источник для получения IP-адресов

• iptype — Тип IP-адреса. Публичный — с доступом из сети Internet, приватный — без доступа, NAT — с доступупом через NAT

• family — IP-адрес. Выберите предпочитаемый IP-адрес

• network — Имя сети. Имя сети NAT, для которой требуется выделить IP-адрес

• ip — IP. IP-адрес

• netmask — Маска сети. Маска сети в виде префикса (0..32 для IPv4, 0..128 для IPv6) или в виде '255.255.255.0' для IPv4

• gateway — IP-адрес шлюза. IP-адрес шлюза по умолчанию

• amount_ipv4 — Количество IPv4. Требуемое количество адресов IPv4

• ipv4_pool — Пул адресов IPv4. Получить адреса IPv4 из указанного пула

• amount_ipv6 — Количество IPv6. Требуемое количество адресов IPv6

• ipv6_pool — Пул адресов IPv6. Получить адреса IPv6 из указанного пула

• domain — Домен. Доменное имя, закрепленное за указанным IP-адресом

Удалить IP-адрес

Функция: iplist.delete

Удалить IP-адрес

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции iplist.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vm.volume

Результат: список элементов

Диски виртуальной машины

Уровень доступа: admin user

• id — Id

• name — Наименование

• metapool — Хранилище

• bus — Шина

• dev — Устройство

• size — Размер, MiB

• bootorder — Порядок загрузки

• vmstatus — Статус VM

Редактирование виртуального диска

Функция: vm.volume.edit

Уровень доступа: new: admin+ ;edit: admin user ;

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.volume)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.volume)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• volume — Виртуальный диск. Не привязанный ни к одной машине виртуальный диск

• isoname — Файл с ISO-образом. Выберите файл с ISO-образом для подключения к виртуальной машине

• bus — Шина. Тип виртуального устройства

• dev — Виртуальное устройство. Наименование устройства которое будет видно внутри виртуальной машины

• priority — Порядок загрузки. В данном порядке будет выбираться устройство для загрузки операционной системы

• size — Размер диска. Размер виртуального диска, мебибайт

Отсоединить диск от виртуальной машины. Отсоединение возможно только при выключенной VM

Функция: vm.volume.delete

Отсоединить диск от виртуальной машины. Отсоединение возможно только при выключенной VM

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.volume.

Результат: успешное выполнение операции или сообщение об ошибке

Подключение ISO-образа

Функция: vm.volume.iso

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.volume)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.volume)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• isoname — Имя образа. Имя файла с образом

• bus — Шина. Тип виртуального устройства

• dev — Виртуальное устройство. Наименование устройства, которое будет видно внутри виртуальной машины

• priority — Порядок загрузки. В данном порядке будет выбираться устройство для загрузки операционной системы

Понизить приоритет загрузки

Функция: vm.volume.boot.down

Понизить приоритет загрузки

Уровень доступа: admin user

Повысить приоритет загрузки

Функция: vm.volume.boot.up

Повысить приоритет загрузки

Уровень доступа: admin user

Миграция виртуальной машины

Функция: vm.migrate

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• destination — Сервер назначения. Узел кластера, на который мигрирует виртуальная машина

• live — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Во время миграции виртуальная машина будет работать. Такой тип миграции медленнее и требует больше ресурсов. Живая миграция рекомендуется только для переноса виртуальных машин небольших по размеру и неактивно используемых.

Жесткий перезапуск виртуальной машины

Функция: vm.restart

Жесткий перезапуск виртуальной машины

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.

Результат: успешное выполнение операции или сообщение об ошибке

Нагрузка VM

Функция: reportvm

Результат: отчёт

Отчет о нагрузке виртуальной машины

Уровень доступа: user+

Наименование

Функция: vm.netinterface

Результат: список элементов

Список сетевых интерфейсов

Уровень доступа: admin user

• id — Id

• network — Связанная сеть

• mac — MAC-адрес

• model — Модель сетевого устройства

Редактирование сетевого интерфейса

Функция: vm.netinterface.edit

Уровень доступа: new: admin+ ;edit: admin user ;

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.netinterface)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции vm).
  • elid — уникальный идентификатор (элемент id из функции vm.netinterface)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• network — Связанная сеть. Выберите связанную сеть

• macgenerate — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, если вы хотите сгенерировать (перегенерировать) MAC-адрес автоматически

• mac — MAC-адрес. MAC-адрес сетевого интерфейса

• model — Модель сетевого устройства. Модель эмулируемого сетевого устройства

Удалить

Функция: vm.netinterface.delete

Удалить

Уровень доступа: admin+

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.netinterface.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель управления с правами владельца виртуальной машины

Функция: vm.su

Войти в панель управления с правами владельца виртуальной машины

Уровень доступа: admin+

Шаблоны ОС

Функция: osmgr

Результат: список элементов

Управление шаблонами ОС

Уровень доступа: admin

• name — Шаблон

• tags — Тэги

• type — Тип

• state — Состояние

• repo — Источник

• date — Дата

Свойства шаблона ОС

Функция: osmgr.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции osmgr)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции osmgr)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• autoupdate — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить/выключить автообновление шаблона. Если обновление включено, система проверяет версию шаблона раз в сутки и обновляет в случае необходимости

• restrict — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если ограничение включено, то использование шаблона возможно только администраторами

Обновить список шаблонов

Функция: osmgr.fetch

Обновить список шаблонов

Уровень доступа: admin

Удалить выбранные шаблоны

Функция: osmgr.delete

Удалить выбранные шаблоны

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции osmgr.

Результат: успешное выполнение операции или сообщение об ошибке

Репозиторий

Функция: osmgr.repo

Результат: список элементов

Репозитории шаблонов ОС

Уровень доступа: admin

• name — Репозиторий

• location — Ссылка

Удалить репозиторий

Функция: osmgr.repo.delete

Удалить репозиторий

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции osmgr.repo.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование репозитория шаблонов ОС

Функция: osmgr.repo.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • elid — уникальный идентификатор (элемент name из функции osmgr.repo)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • elid — уникальный идентификатор (элемент name из функции osmgr.repo)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Репозиторий. Наименование репозитория

• location — Ссылка. Ссылка на репозиторий

Установить/Обновить выбранные шаблоны

Функция: osmgr.install

Установить/Обновить выбранные шаблоны

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции osmgr.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: osmgr.macros

Результат: список элементов

Параметры шаблона ОС

Уровень доступа: admin

• name — Наименование

• value — Значение

Параметр шаблона

Функция: osmgr.macros.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • elid — уникальный идентификатор (элемент name из функции osmgr.macros)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции osmgr).
  • elid — уникальный идентификатор (элемент name из функции osmgr.macros)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• value — Значение. Значение параметра, передаваемое в скрипт установки ОС

Установить значение по умолчанию

Функция: osmgr.macros.delete

Установить значение по умолчанию

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции osmgr.macros.

Результат: успешное выполнение операции или сообщение об ошибке

Запустить процесс обновления списка шаблонов

Функция: osmgr.update

Запустить процесс обновления списка шаблонов

Уровень доступа: admin

Шаблоны хранилищ

Функция: metapool

Результат: список элементов

Шаблоны хранилищ

Уровень доступа: admin

• id — Id

• name — Наименование

• type — Тип

• status — Состояние

Редактирование шаблона хранилища

Функция: metapool.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции metapool)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции metapool)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование шаблона

• type — Тип. Тип хранилища

• srchostname — Сетевое хранилище. Адрес сетевого хранилища (ip или hostname)

• srcdevpath — Устройства, на которых будет создана группа томов. Provides the source for pools backed by physical devices (pool types fs, logical, disk, iscsi). May be repeated multiple times depending on backend driver. Contains a single attribute path which is the fully qualified path to the block device node

• srcvolume — Имя тома. Имя тома на удаленном сервере

• srcdirpath — Директория на сетевом хранилище. Директория хранения образов дисков на сервере сетевого хранилища

• srchostport — Порт. Порт для доступа к сетевому хранилищу

• sshkey — Публичный ключ. Публичный ssh ключ, который необходимо положить на сервер

• has_pwd — Есть пароль для root. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)

• password — Пароль root. Пароль для root сервера с установленным open-iscsi

• srcname — Имя источника. Имя сетевого хранилища на удаленном сервере

• source_format_type — source/format@type. Тип формата хранилища

• srcvendorname — source/vendor@name. Provides optional information about the vendor of the storage device

• srcfmtname — source/format@name. Provides information about the format of the pool

• srcprodname — source/product@name. Provides an optional product name of the storage device

• tgtpath — Директория на узле кластера. Путь к директории, в которой будут храниться образы виртуальных дисков

• format — Формат диска. Формат диска

• reserved_percent — Зарезервировано, %%. Часть хранилища, зарезервированная для системных нужд. Размер определяется в процентах от общего объема. Значения от 0 до 100

• reserved_mib — Зарезервировано, MiB. Часть хранилища, зарезервированная для системных нужд. Размер определяется в мегабайтах

• reserved_gib — Зарезервировано, GiB. Часть хранилища, зарезервированная для системных нужд. Размер определяется в гигабайтах

• reserved_unit — Единицы измерения. Единицы измерения, в которых указано зарезервированное место

• cache_mode — Тип кэширования. Метод кэширования, используемый для VM, диски которых находятся в этом хранилище

• qemu_aio — Режим AIO. Режим работы асинхронного ввода-вывода. Для файловых хранилищ рекомендуется использовать 'threads', для блочных — 'native'. Режим 'native' требует отключения кэширования на хост-сервере (тип кэширования 'none' или 'directsync')

• description — Описание.

Удаление шаблона хранилища

Функция: metapool.extdelete

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции metapool)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции metapool)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Шаблон хранилища. Наименование объекта, который будет удален

• confirm — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При установленном признаке "игнорировать ошибки" объект будет удален в любом случае

Настройки

Функция: backup.plan

Результат: список элементов

Планы резервного копирования

Уровень доступа: admin

• name — Имя

• type — Тип

• state — Статус

• cron — Расписание

Настройки модуля резервного копирования

Функция: backup.settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• backuptmpdir — Временный каталог. Рабочий каталог модуля резервного копирования. В нем хранятся временные файлы: архивы, листинги и прочие

• backuptimeout — Таймаут. Максимальное время ожидания подготовки данных (виртуальных машин)

Удалить планы резервного копирования

Функция: backup.plan.delete

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• clean_storages — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Нужно ли удалять архивы и листинги из хранилищ

Запустить резервное копирование

Функция: backup.plan.run

Запустить резервное копирование

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции backup.plan.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

backup.plan.datafilter

Установка фильтра.

backup.plan.filter

План резервного копирования

Функция: backup.plan.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backup.plan)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Имя. Наименование плана резервного копирования

• id — Внутреннее имя. Имя, используемое в именах архивов и для связей в базе данных

• backup_type — Тип. Тип резервного копирования: Полный, Инкрементальный, Дифференциальный

• archiver — Архиватор. Чем архивировать данные

• storage — Хранилище. Список хранилищ, в которые будут сохранены резервные копии

• rewrite_today — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет храниться только одна последняя копия за сегодняшний день

• max_file_size — Макс. размер файла.. Максимальный размер файла в мебибайтах. Файлы больше этого размера не будут добавлены в резервную копию

• max_dir_size — Макс. размер файла директории.. Максимальный размер файла директории в мебибайтах. Директории, размер файла которых больше заданного значения не будут добавлены в резервную копию. На размер файла директории влияет количество файлов в этой директории.

• autostart — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Вы можете задать рассписание, согласно которому резервное копирование будет делаться автоматически. Или же запускать задание вручную

• run_every — Выполнять. Период выполнения задания

• full_period — Период. Период проведения полного копирования

• full_weekday — День недели. День недели, в который будет запускаться полное резервное копирование

• full_monthday — День месяца. День месяца, в который будет запускаться полное резервное копирование

• dlimit — Ежедневных копий. Будет сохранено по одной резервной копии за n последних дней, где n — заданное число

• wlimit — Еженедельных копий. Будет сохранено по одной резервной копии за n последних недель, где n — заданное число

• mlimit — Ежемесячных копий. Будет сохранено по одной резервной копии за n последних месяцев, где n — заданное число

Резервные копии

Функция: backups

Результат: список элементов

Резервные копии

Уровень доступа: admin

• plan — План

• plan_type — Тип плана

• date — Дата

• size — Размер, MiB

• storage — Хранилище

• backup_type — Тип копии

Создание полной резервной копии

Функция: backups.new

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backups)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backups)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• storage — Хранилище. Выберите одно из хранилищ, предоставленных администратором

Скачать архив, содержащий резервную копию

Функция: backups.download

Скачать архив, содержащий резервную копию

Уровень доступа: admin

Восстановление

Функция: backups.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backups)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backups)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• behavior — Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть веб-домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Сохраненные данные

Функция: backupdata

Результат: список элементов

Сохраненные данные

Уровень доступа: admin

• type — Тип данных

Имя данных

Функция: backupdata.names

Результат: список элементов

Содержимое

Уровень доступа: admin

• name — Имя данных

• owner — Владелец

Восстановление

Функция: backupdata.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
  • elid — уникальный идентификатор (элемент id из функции backupdata.names)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
  • elid — уникальный идентификатор (элемент id из функции backupdata.names)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• version — Версия. Выбрать дату резервной копии

• behavior — Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть web домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Наименование

Функция: backupdata.files

Результат: список элементов

Файлы

Уровень доступа: admin

• dname — Имя

Восстановление

Функция: backupdata.files.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
  • elid — уникальный идентификатор (элемент name из функции backupdata.files)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
  • elid — уникальный идентификатор (элемент name из функции backupdata.files)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• version — Версия. Выбрать дату резервной копии

Закачать резервную копию

Функция: backups.upload

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backups)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backups)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• type — Тип файла. Укажите, откуда вы хотите закачать файл: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере

• url — URL. Укажите ссылку на файл, который вы хотите закачать в текущий каталог, например, http://example.com/dir/file.html

• name — Имя файла. Укажите, с каким именем файл должен быть сохранён в текущем каталоге. Если вы оставите это поле пустым, имя файла будет выделено из URL

• storage — Хранилище. Выберите хранилище, в которое будет загружена резервная копия

Удаление резервной копии

Функция: backups.delete

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backups)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backups)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• clean_storages — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Нужно ли удалять архивы и листинги из хранилищ

Сохраненные данные

Функция: backupdata

Результат: список элементов

Сохраненные данные

Уровень доступа: admin

• type — Тип данных

Правила размещения

Функция: allocationrule

Результат: список элементов

Правила размещения виртуальных машин

Уровень доступа: admin

• id — Идентификатор

• priority — Приоритет

• ruletype — Тип признака

• operand — Операнд

• value — Значение

• hostnode — Узел кластера

• proc — Действие

Изменить правило размещения виртуальной машины

Функция: allocationrule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции allocationrule)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции allocationrule)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• priority — Приоритет. Порядок выполнения правил. Чем меньше значение — тем раньше будет выполнено правило

• ruletype — Тип признака. Данное поле указывает признак, который будет проверяться при обработки правила. Это может быть либо наименование шаблона виртуальной машины, либо наименование шаблона операционной системы

• operand — Операнд. Операция, с помощью которой определяется факт срабатывания правила.

"Содержит" — проверка того, что поле "значение" входит в признак. "Не содержит" — проверка того, что поле "значение" не входит в признак

• value — Значение. Поле, с которым сравнивается признак виртуальной машины

• host — Узел кластера. Узел кластера (или все узлы), который добавится или удалится из списка узлов при срабатывании правила (зависит от поля "действие")

• action — Действие. В зависимости от этого поля узел кластера будет либо добавлен в список, либо удален из него

• stop — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если это правило отработало, можно прекратить дальнейшую обработку правил

Удалить

Функция: allocationrule.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции allocationrule.

Результат: успешное выполнение операции или сообщение об ошибке

Повысить приоритет правила

Функция: allocationrule.up

Повысить приоритет правила

Уровень доступа: admin

Понизить приоритет правила

Функция: allocationrule.down

Понизить приоритет правила

Уровень доступа: admin

Настройки пользователя

Функция: usrparam

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

• Результат: список параметров

Изменение данных:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

• notify_vm_stop — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять на указанный email уведомления о нештатной остановке виртуальных машин

• notify_vm_stop_crashed — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять на указанный email уведомления об аварийном завершении виртуальных машин

• notify_backup_fail — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять на указанный email уведомления об ошибках создания резервных копий

• notify_node_locked — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять на указанный email уведомления о недоступности узла кластера

• notify_pool_over_space — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять на указанный email уведомления о нехватке места в хранилище

Импорт VM

Функция: remotenode

Результат: список элементов

Серверы или кластеры для импорта VM

Уровень доступа: admin

• id — ID

• ip — IP

• vmcount — Количество VM

• imported — Импортировано

• fail — Ошибки импорта

Удалить

Функция: remotenode.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции remotenode.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: remotenode.vm

Результат: список элементов

Список виртуальных машин на сервере

Уровень доступа: admin

• id — Id

• name — Наименование

• ip — IP-адрес

• vsize — Объем дисков

• mem — Объем оперативной памяти, MiB

• hostname — Узел кластера

• externalip — IP-адрес узла

• status — Состояние

Запустить импорт виртуальной машины

Функция: remotenode.vm.import

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • elid — уникальный идентификатор (элемент id из функции remotenode.vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • elid — уникальный идентификатор (элемент id из функции remotenode.vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• hostnode — Узел кластера. Выберите узел кластера, на который будет произведен импорт

• import_owner — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет выполнен импорт владельца виртуальной машины

• user — Пользователь. Выбрать пользователя-владельца

• pool — Хранилище. В случае, если при импорте не будет найдено хранилище, будет использовано указанное.

• check_not_exists_pool — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Не проверять наличие хранилища совпадающего с хранилищем импортируемой виртуальной машины

• default_network — Сеть по умолчанию. Будет произведена попытка подключения к той же сети, что на сервере-источнике. Если это невозможно, то будет использована указанная сеть по умолчанию.

• new_domain — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если вы хотите сменить доменное имя для основного IP-адреса

• domain — Домен. Домен для IP-адреса

• new_ip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Во время импорта, виртуальной машине выделяется новый ip-адрес

• iptype — Тип IP-адреса. Публичный — с доступом из сети Internet, приватный — без доступа, NAT — с доступупом через NAT

• family — IP-адрес. Основной IP-адрес

• ipsource — Источник IP-адресов. Укажите источник для получения IP-адресов

• network — Имя сети. Имя сети NAT, для которой требуется выделить IP-адрес

• ip — IP. IP-адрес

• netmask — Маска сети. Маска сети в виде префикса (0..32 для IPv4, 0..128 для IPv6) или в виде '255.255.255.0' для IPv4

• gateway — IP-адрес шлюза. IP-адрес шлюза по умолчанию

• ipaliases — Дополнительные IP адреса. Можно указать несколько дополнительных IP-адресов

• amount_ipv4 — Количество IPv4. Требуемое количество адресов IPv4

• ipv4_pool — Пул адресов IPv4. Получить адреса IPv4 из указанного пула

• amount_ipv6 — Количество IPv6. Требуемое количество адресов IPv6

• ipv6_pool — Пул адресов IPv6. Получить адреса IPv6 из указанного пула

Выбор IP-адреса сервера с виртуальной машиной

Функция: remotenode.fixconnection

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • elid — уникальный идентификатор (элемент id из функции remotenode.vm)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции remotenode).
  • elid — уникальный идентификатор (элемент id из функции remotenode.vm)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• ip — IP-адрес. Выберите внешний IP-адрес физического узла, с которого будет произведен импорт

Наименование

Функция: remotenode.vm.info

Результат: список элементов

Информация о виртуальной машине

Уровень доступа: admin

• fieldname — Параметр

• value — Значение

Обновить список виртуальных машин на удаленном кластере

Функция: remotenode.refresh

Обновить список виртуальных машин на удаленном кластере

Уровень доступа: admin

Изменить информацию о сервере с libvirt или с установленным VMmanager

Функция: remotenode.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции remotenode)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции remotenode)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• ip — IP-адрес. IP-адрес сервера с libvirt или с установленным VMmanager KVM

• sshkey — .

• has_pwd — Есть пароль для пользователя. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если известен пароль для пользователя, можно ввести его, и публичный ключ будет автоматически добавлен на сервер

• login — Имя пользователя ssh. Укажите имя пользователя для подключения по ssh

• passwd — . Пароль для пользователя

• port — Порт ssh. Номер порта, по которому будет подключаться панель

• type — Тип подключаемого сервера. Выберите тип сервера. Libvirt — на сервере установлен libvirt,

VMmanager — на сервере установлен VMmanager

• mgrpath — Путь к VMmanager. Директория, где установлен VMmanager KVM (обычно /usr/local/mgr5)

Импорт VDS

Функция: import

Результат: список элементов

Серверы с VDSmanager

Уровень доступа: admin

• ip — IP

• name — Наименование

• vdscount — Количество VDS

• status — Статус

Остановить процесс импортирования

Функция: import.stop

Остановить процесс импортирования

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции import.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить информацию о сервере

Функция: import.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции import)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции import)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• sshkey — Публичный ключ. Публичный ssh ключ, который необходимо положить на сервер

• has_pwd — Есть пароль для root. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если известен пароль для root, можно ввести его, и публичный ключ будет автоматически добавлен на сервер

• passwd — Пароль. passwd

• ip — IP-адрес. IP-адрес сервера, с которого будет производится импорт VDS

• name — Наименование. Наименование сервера

Начать импорт всех VDS

Функция: import.start

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции import)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции import)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• user — Владелец. Пользователь, который будет являться владельцем VM. Если выбран auto — то новый пользователь будет создан автоматически

• admin — Администратор. Пользователь с правами создания виртуальных дисков

• preset — Шаблон VM. Шаблон виртуальной машины, с которым будет создан VM

• pool — Хранилище. Хранилище, в котором будет созданы виртуальные диски импортируемой VDS

Обновить информацию о доступных для импорта VDS

Функция: import.refresh

Обновить информацию о доступных для импорта VDS

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции import.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить сервер из списка

Функция: import.delete

Удалить сервер из списка

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции import.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: import.vdslist

Результат: список элементов

Список VDS на сервере

Уровень доступа: admin

• id — Id

• ip — IP-адрес

• name — Наименование

• status — Состояние

• mem — Оперативная память

• disk — Размер диска

Начать импорт VDS

Функция: import.vdslist.start

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции import).
  • elid — уникальный идентификатор (элемент id из функции import.vdslist)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции import).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции import).
  • elid — уникальный идентификатор (элемент id из функции import.vdslist)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Вы можете указать с каким наименованием будет создана виртуальная машина

• user — Владелец. Пользователь, который будет являться владельцем VM. Если выбран auto — то новый пользователь будет создан автоматически

• admin — Администратор. Пользователь с правами создания виртуальных дисков

• preset — Шаблон VM. Шаблон виртуальной машины, с которым будет создан VM

• pool — Хранилище. Хранилище, в котором будет созданы виртуальные диски импортируемой VDS

• new_ip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Во время импорта, виртуальной машине выделяется новый ip-адрес

• iptype — Тип IP-адреса.

• family — IP-адрес. Основной IP-адрес

• ip — IP-адрес.

Обновить список VDS и состояние

Функция: import.vdslist.check

Обновить список VDS и состояние

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции import.vdslist.

Результат: успешное выполнение операции или сообщение об ошибке

Остановить импортирование

Функция: import.vdslist.stop

Остановить импортирование

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции import.vdslist.

Результат: успешное выполнение операции или сообщение об ошибке

Сети

Функция: net

Результат: список элементов

Cети

Уровень доступа: admin

• id — Id

• name — Наименование

• type — Тип сети

• fdev — Интерфейс

Редактирование сети

Функция: net.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции net)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции net)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование сети. После создания изменить нельзя

• type — Тип сети. Тип сети

• bridge — Сетевой мост. Наименование сетевого моста

• ipaddr — IP-адрес (шлюз). Шаблон адреса (IPv4 или IPv6)

• netmask — Маска сети. Маска сети (например, 255.255.255.0 или префикс 24)

• plug_iface — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает подключение указанного сетевого интерфейса к сетевому мосту. Если опция отмечена, то необходимо указать имя интерфейса. Все IP-адреса будут переназначены на сетевой мост.

• fdev — Внешний интерфейс. Сетевой интерфейс к которому будет подключена сеть. auto — автовыбор

Удалить

Функция: net.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции net.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: net.mac

Результат: список элементов

Привязка MAC-адресов к сети

Уровень доступа: admin

• id — Идентификатор

• mac — MAC-адрес

• type — Тип привязки

• value — Значение

Удалить MAC-адрес

Функция: net.mac.delete

Удалить MAC-адрес

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции net.mac.

Результат: успешное выполнение операции или сообщение об ошибке

Редактировать привязку MAC-адреса

Функция: net.mac.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции net).
  • elid — уникальный идентификатор (элемент id из функции net.mac)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции net).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции net).
  • elid — уникальный идентификатор (элемент id из функции net.mac)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• mac — MAC-адрес. MAC-адрес, который будет привязан к объекту

• type — Тип объекта. Тип объекта, по которому будет привязан MAC-адрес

• ipaddress — IP-адрес. IP-адрес, по которому будет устанавливаться MAC-адрес

• vmname — Виртуальная машина. Виртаульная машина, для которой будет выдаваться данный MAC-адрес

• my_vmname — Наименование VM. Наименование VM. Если VM уже существует — его можно выбрать из списка. Если нет — то можно ввести имя вручную и тогда при создании VM MAC-адрес будет выбран автоматически

Нагрузка VM

Функция: reportvmtop

Результат: отчёт

Отчет о нагрузке виртуальных машин

Уровень доступа: admin

Нагрузка VM

Функция: reportvm

Результат: отчёт

Отчет о нагрузке виртуальной машины

Уровень доступа: user+

Виртуальные диски

Функция: volume

Результат: список элементов

Виртуальные диски

Уровень доступа: admin user

• id — Id

• name — Наименование

• user — Владелец

• host — Узел кластера

• pool — Хранилище

• type — Тип хранилища

• size — Размер, MiB

• attached — Виртуальная машина

• state — Состояние

Переместить виртуальный диск

Функция: volume.relocate

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции volume)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции volume)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• host — Узел кластера. Узел кластера, на котором будет создан виртуальный диск

• pool — Хранилище. Хранилище, на которое будет перемещен виртуальный диск

Изменение размера виртуального диска

Функция: volume.edit

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции volume)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции volume)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• user — Владелец. Владелец виртуального диска

• host — Узел кластера. Узел кластера на котором будет создан виртуальный диск

• pool — Хранилище. Хранилище на котором будет создан виртуальный диск

• name — Наименование. Наименование виртуального диска

• size — Размер. Размер виртуального диска в мебибайтах

Удаление виртуального диска

Функция: volume.extdelete

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции volume)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции volume)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Виртуальный диск. Наименование виртуального диска, который будет удален

• confirm — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При установленном признаке "игнорировать ошибки" виртуальный диск будет удален в любом случае

Установка фильтра.

volume.filter

Репликация

Функция: replication

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

• Результат: список параметров

Изменение данных:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

• host — Адрес сервера. Доменное имя или IP-Адрес MySQL сервера на который будет производиться репликация

• user — Пользователь. MySQL пользователь с правами на 'change master', 'start/stop slave' и 'show slave status'

• password — Пароль. Пароль MySQL пользователя

• ostemplbkpip — Сервер. Доменное имя или IP-Адрес сервера, на который по ssh будут создаваться резервные копии шаблонов ОС

• ostemplbkpdir — Директория. Директория на сервере, в которой будут храниться резервные копии

• has_pwd — Есть пароль root. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Проверить подключение и положить ключи ssh, имея пароль root

• ostemplbkppass — Пароль. Пароль root пользователя для доступа по ssh

• cloudip — IP-Адрес лицензии. Укажите IP-адрес лицензии

Шаблоны VM

Функция: preset

Результат: список элементов

Шаблоны виртуальных машин

Уровень доступа: admin

• id — Id

• name — Наименование

• mem — Память, MiB

• vcpu — Процессоры, Шт

• cputune — Вес cgroups для CPU

Наименование

Функция: preset.resource

Результат: список элементов

Ресурсы шаблона

Уровень доступа: admin

• id — Id

• type — Тип

• info — Информация

Редактирование ресурса шаблона

Функция: preset.resource.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции preset).
  • elid — уникальный идентификатор (элемент id из функции preset.resource)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции preset).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции preset).
  • elid — уникальный идентификатор (элемент id из функции preset.resource)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• type — Тип. Тип ресурса

• metapool — Хранилище. Шаблон хранилища на котором будут создаваться виртуальные диски

• vsize — Размер диска. Размер диска в мебибайтах

• network — Сеть. Сеть

• model — Модель карты. Выберите модель виртуальной сетевой карты

Удалить

Функция: preset.resource.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции preset.resource.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: preset.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции preset.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование шаблона VM

Функция: preset.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции preset)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции preset)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование шаблона

• mem — Оперативная память. Оперативная память в мебибайтах

• cpu_mode — Режим эмуляции процессора. При эмуляции процессора "по умолчанию" используется виртуальный процессор QEMU. При эмуляции в режиме 'host-model' используется описание процессора, определенное libvirt на основе процессора узла кластера. В режиме 'host-passthrough' в точности эмулируется процессор узла кластера. Настройка режима эмуляции может потребоваться для запуска ОС Windows 2016. Не изменяйте режим эмуляции без необходимости

• custom_cpu — Модель процессора. Перечень моделей доступен в файле /usr/share/libvirt/cpu_map.xml на узле кластера. Допустимо указывать модели, соответствующие вендору, архитектуре и набору возможностей процессора узла кластера

• custom_cpu_features — Перечень возможностей процессора. Возможности процессора, включаемые в обязательном порядке. Перечень всех возможностей процессора доступен в выводе консольной команды 'virsh capabilities' на узле кластера

• vcpu — Количество процессоров. Количество виртуальных процессоров, доступных виртуальной машине

• cputune — Вес CPU. Вес cgroups для CPU. Виртуальная машина с весом 2000 получит приоритет в два раза выше на использование CPU по сравнению с виртуальной машиной с весом 1000. Стандартное значение — 1000

• blkiotune — Вес использования I/O. Вес cgroup на дисковые операции. Позволяет понизить либо повысить приоритет по сравнению с остальными виртуальными машинами. Стандартное значение — 500

• metapool — Шаблон хранилища. Шаблон хранилища на котором будут создаваться виртуальные диски

• vsize — Размер основного диска. Размер основного диска в мебибайтах

• network — Сеть. Основная сеть

• model — Модель сетевой карты. Выберите модель сетевой карты, используемую по умолчанию

• inbound — Входящий трафик, KiB/sec. Ограничение скорости передачи входящего трафика, KiB/sec

• outbound — Исходящий трафик, KiB/sec. Ограничение скорости передачи исходящего трафика, KiB/sec

• snapshot_limit — Количество снимков. Максимальное количество снимков, которые может создать пользователь для виртуальной машины

Пользователи

Функция: user

Результат: список элементов

Пользователи

Уровень доступа: root admin

• id — Id

• name — Логин

• level — Уровень доступа

• vmcount — Количество VM

• status — Состояние

Редактирование пользователя

Функция: user.edit

Уровень доступа: admin root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции user)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции user)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• level — Уровень доступа. Уровень доступа пользователя

• name — Логин. Логин для входа

• passwd — Пароль. Пароль доступа

• confirm — Подтверждение пароля. Подтверждение пароля

• allowcreatevm — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, чтобы разрешить пользователю создавать и удалять виртуальные машины самостоятельно

• vm_limit — Количество виртуальных машин. Количество виртуальных машин, которые может создавать пользователь

• isolimitsize — Объем ISO, MiB. Ограничение по суммарному объему ISO-образов

• isolimitnum — Количество ISO. Ограничение по количеству ISO-образов, доступных для закачивания пользователем

• snapshot_limit — Количество снимков VM. Максимально возможное количество снимков виртуальной машины

Установка фильтра.

user.filter

Права пользователей

Функция: userrights

Результат: список элементов

Права

Уровень доступа: root admin

• caption — Наименование

• access — Доступ

Ограничить доступ к элементам списка

Функция: userrights.filter

Ограничить доступ к элементам списка

Уровень доступа: root admin

Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма

Функция: userrights.delete

Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: userrights.fields

Результат: список элементов

Список полей (столбцов)

Уровень доступа: root admin

• caption — Наименование

• access — Доступ

Включить

Функция: userrights.fields.resume

Включить

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.

Результат: успешное выполнение операции или сообщение об ошибке

Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма

Функция: userrights.fields.delete

Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: userrights.fields.suspend

Выключить

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.

Результат: успешное выполнение операции или сообщение об ошибке

Права на поле

Функция: userrights.fields.edit

Уровень доступа: admin root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
  • elid — уникальный идентификатор (элемент name из функции userrights.fields)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
  • elid — уникальный идентификатор (элемент name из функции userrights.fields)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• inhereted — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Не задавать явно права на поле. Права будут взяты из прав групп, в которые входит пользователь

• read — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить чтение поля

• write — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить редактирование поля

• new — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить редактирование поля во время создания объекта

Доступ к функции

Функция: userrights.edit

Уровень доступа: root admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • elid — уникальный идентификатор (элемент name из функции userrights)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • elid — уникальный идентификатор (элемент name из функции userrights)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• inhereted — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Не задавать права явно. В этом случае права определяются согласно другим правилам

• access — Доступ. Разрешить/запретить доступ к функции

• inherit — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Распространяет права на все функции группы

Политики

Функция: userrights.policy

Уровень доступа: root admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

• Параметры:
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • elid — уникальный идентификатор (элемент name из функции userrights)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • elid — уникальный идентификатор (элемент name из функции userrights)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• policy — Политика по умолчанию. Укажите, какой доступ будет у пользователя к функциям, для которых ограничения не заданы явно. При изменении значения сбрасывает существующие настройки доступа. Если пользователь входит в какую-либо группу, групповые настройки доступа сохраняются

Включить

Функция: userrights.resume

Включить

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: userrights.suspend

Выключить

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить пользователя

Функция: user.disable

Выключить пользователя

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: user.delete

Удалить

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Включить пользователя

Функция: user.enable

Включить пользователя

Уровень доступа: root admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель управления с правами пользователя

Функция: user.su

Войти в панель управления с правами пользователя

Уровень доступа: root admin

Нагрузка кластера

Функция: reporttop

Результат: отчёт

Отчет о нагрузке кластера

Уровень доступа: admin

Настройка политик

Функция: settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

• Результат: список параметров

Изменение данных:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

• mainip — IP-адрес основного узла. Укажите IP-адрес основного узла, который будет использоваться для связи с другими узлами. Данный IP-адрес должен быть из той же сети, что и остальные узлы кластера.

• oversell_mem — Величина оверселлинга. Доля оперативной памяти, которую можно использовать для виртуальных машин (50%-500%). Оверселлинг работает только когда достаточно свободной памяти. Если по факту памяти не хватает при создании вирт. машины, то машина не будет создана.. Значения от 50 до 500

• vmtimezone — Часовой пояс VM. Часовой пояс по умолчанию для создаваемых гостевых машин

• vmregion — Регион VM. Регион, в котором находится часовой пояс

• vmlocation — Местоположение VM. Географическое местоположение по умолчанию для создаваемых гостевых машин

• own_netfilter — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отключение создания правил для антиспуфинга

• mac_prefix — Префикс MAC-адреса. Укажите первые два байта генерируемых панелью MAC-адресов сетевых интерфейсов виртуальных машин в шестнадцатиричной системе счисления. Первый октет в двоичном представлении должен заканчиваться на '10' (locally administered, unicast)

• vnc_iface — Сетевой интерфейс VNC. Укажите сетевой интерфейс, на котором будет доступен VNC-сервер виртуальной машины. Автоматическое определение интерфейса означает, что VNC-сервер будет доступен на интерфейсе сетевого моста, к которому подключен сетевой интерфейс виртуальной машины. Предупреждение: при смене интерфейса будет изменена конфигурация всех виртуальных машин кластера.

• novnc_ssl — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить использование защищенного протокола HTTPS для консоли VNC. <a href="http://doc.ispsystem.ru/index.php/VNC" target="_blank">Подробнее</a>

• check_unique_ip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Всегда выполнять проверку на дублирование IP-адреса при создании VM с явно указанным IP-адресом или добавлении явно указанного IP-адреса

• nameservers — Серверы имен. Список IP-адресов серверов имен, разделенных пробелами. Список серверов имен на виртуальных машинах при установке из шаблона будет настраиваться по этому списку, или если список пуст, по списку серверов имен узла кластера, на котором расположена панель

• http_proxy_v4 — HTTP proxy для IPv4. Используется для кэширования пакетов при установке из шаблонов ОС

• http_proxy_v6 — HTTP proxy для IPv6. Используется для кэширования пакетов при установке из шаблонов ОС

• iso_lifetime — Время жизни ISO, час. Количество часов, через которое будет удален пользовательский ISO-образ. По умолчанию 24

• globiso_sizelimit — Глобальный лимит размера, MiB. Максимальное значение объема ISO-образов для любого пользователя. По умолчанию 0. (В панели вы сможете выставить значение выше указанного, но применяться будут максимальные значения из конфигурационного файла).

• globiso_countlimit — Глобальный лимит количества. Максимальное количество ISO-образов для любого пользователя. Имеет приоритет перед лимитами учетной записи пользователя (если в настройках учетной записи указано значение выше глобального, оно будет проигнорировано)

• iso_sizelimit — Пользователький лимит размера, MiB. Ограничение на суммарный размер ISO-образов пользователя. При создании пользователя, если не указано соответствующее ограничение, используется значение данного параметра.

• iso_countlimit — Пользовательский лимит количества. Ограничение на количество ISO-образов пользователя. При создании пользователя, если не указано соответствующее ограничение, используется значение данного параметра

• user_history — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить пользователю просматривать историю операций с виртуальной машиной

• recipe — Рецепт. Выполнять указанный рецепт после установки или переустановки VM по шаблону ОС. Указанный рецепт будет выполняться независимо от того, выбран ли рецепт при создании VM. Выбор подходящего рецепта осуществляется перебором всех доступных рецептов с проверкой совпадения имени и любого из тэгов с тэгами шаблона ОС

• user_recipes — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить доступ пользователям к редактированию рецептов

• snapshot_timeout — Таймаут при создании снапшота. Сколько секунд будет ожидать VMmanager завершения процесса создания снимка виртуальной машины

• snapshot_limit — Максимальное количество снапшотов. Ограничение на количество снимков виртуальной машины, которые может сделать пользователь. Глобальный лимит применяется, если заданное значение меньше значения лимита снимков, установленного для виртуальной машины.

• health_monitor — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Периодическая проверка активности сети и жесткого диска, неактивные машины будут отмечены иконкой в колонке 'Состояние' списка VM. В списке VM будет доступен фильтр 'Нет активности'

• disable_rebootondemand — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При изменении конфигурации виртуальной машины регистрируется отложенное задание на ее принудительную перезагрузку для применения новой конфигурации. Принудительная перезагрузка выполняется через сутки, если в течение этих суток машина не была перезагружена или остановлена из панели управления. Для отключения принудительной перезагрузки установите этот флаг

Неизвестные VM

Функция: vm.unknown

Результат: список элементов

Список виртуальных машин, не найденных в базе данных

Уровень доступа: admin

• id — Id

• name — Наименование

• hostnode — Узел кластера

• status — Состояние

Удаление виртуальной машины. Внимание! Виртуальные диски не будут удалены

Функция: vm.unknown.delete

Удаление виртуальной машины. Внимание! Виртуальные диски не будут удалены

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.unknown.

Результат: успешное выполнение операции или сообщение об ошибке

Остановить виртуальную машину

Функция: vm.unknown.stop

Остановить виртуальную машину

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vm.unknown.

Результат: успешное выполнение операции или сообщение об ошибке

Поиск неизвестных виртуальных машин

Функция: vm.unknown.search

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции vm.unknown)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции vm.unknown)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• all_nodes — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Произвести поиск на всех узлах кластера

• hostnode — Узел кластера. Узел кластера, на котором необходимо произвести поиск

SSH keys

Функция: sshpubkey

Результат: список элементов

SSH keys

Уровень доступа: admin user

• name — Key name

SSH keys

Функция: sshpubkey.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции sshpubkey)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции sshpubkey)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Key name. Key name

• pubkey — Public SSH key. Public SSH key

Удалить

Функция: sshpubkey.delete

Удалить

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sshpubkey.

Результат: успешное выполнение операции или сообщение об ошибке

ISO-образы

Функция: iso

Результат: список элементов

Список ISO-образов

Уровень доступа: admin user

• id — Id

• name — Имя образа

• deletetime — Время удаления

• size — Размер

• status_col — Состояние

Удалить

Функция: iso.delete

Удалить

Уровень доступа: admin user

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции iso.

Результат: успешное выполнение операции или сообщение об ошибке

Восстановление

Функция: iso.upload

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции iso)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции iso)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• target_vm — Целевая VM. Укажите виртуальную машину, к которой будет подключаться загружаемый образ ISO. Это необходимо для оптимизации процесса загрузки

• target_node — Целевой узел кластера. Укажите узел кластера, на котором образ ISO должен быть доступен сразу после загрузки

• type — Тип файла. Укажите, откуда вы хотите закачать ISO-образ: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере

• url — URL. Укажите ссылку на ISO-образ, который вы хотите закачать, например, http://example.com/dir/file.iso

• name — Имя файла. Укажите, с каким именем ISO-образ должен быть сохранён. Если вы оставите это поле пустым, имя файла будет выделено из URL

• shared — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Этот ISO-образ будет доступен всем пользователям

• hourstodelete — Время до удаления, час.. Время в часах, через которое образ автоматически удалится

• description — Описание.

ISO-образ

Функция: iso.edit

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции iso)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции iso)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Наименование. Наименование iso-образа

• shared — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Этот ISO-образ будет доступен всем пользователям

• delete — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Добавить задание на автоматическое удаление ISO-образа

• hourstodelete — Новое время до удаления, час.. Изменить время в часах, через которое образ автоматически удалится. При заполнении данного поля время удаления будет автоматически пересчитано

• description — Описание. Произвольный текст с описанием. Пользователи видят этот текст в списке ISO-образов

Трафик

Функция: traffilter

Результат: список элементов

Фильтр для трафика

Уровень доступа: admin

• id — Id

• object — Наименование объекта

• direction — Направление трафика

• ip — IP-адрес

Удалить

Функция: traffilter.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции traffilter.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

traffilter.edit

Хранилища

Функция: backup.storages

Результат: список элементов

Хранилища

Уровень доступа: admin

• name — Имя

• destination — Назначение

• type — Тип

Редактирование хранилища

Функция: backup.storages.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

• Параметры:
  • elid — уникальный идентификатор (элемент id из функции backup.storages)
• Результат: список параметров объекта

Создание объекта:

• Параметры:
  • sok- значение параметра должно быть не пустым, обычно "ok".
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

• Параметры:
  • sok — значение параметра должно быть не пустым, обычно "ok".
  • elid — уникальный идентификатор (элемент id из функции backup.storages)
  • дополнительные параметры запроса ...
• Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

• name — Имя. Название хранилища. Будет отображаться в интерфейсе под этим именем

• search_backups — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет произведен поиск резервных копий в хранилище и импорт lst файлов в панель. Поиск производится на основании readme-файлов

• userlevel — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Дать пользователям возможность использовать хранилище для создания своих резервных копий

• missed_archives_list — Список недостающих архивов:. Список недостающих в новом хранилище архивов . Вы не сможете восстановить данные из архивов, находящихся в этом списке

• missed_archives_agree — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)

Установка фильтра.

backup.storages.filter

Создать

Функция: backup.storages.add

Создать

Уровень доступа: admin

Удалить

Функция: backup.storages.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции backup.storages.

Результат: успешное выполнение операции или сообщение об ошибке

Ресурсы кластера

Функция: vmhostnode.resource

Результат: список элементов

Расход ресурсов кластера

Уровень доступа: admin

• name — Имя

• memused — Оперативная память, MiB

• capacity — Хранилища

• cpu — Использование CPU

Удалить

Функция: vmhostnode.resource.delete

Удалить

Уровень доступа: admin

Параметры:

• elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vmhostnode.resource.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: vmhostnode.resource.edit

Создать

Уровень доступа: admin