VMmanager OVZ API

Материал из ISPWiki
Перейти к: навигация, поиск

Содержание

Нагрузка контейнера

Функция: reportvm

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

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

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

Ресурсы кластера

Функция: reportresources

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

Расход ресурсов кластера

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

  • hostnode - Узел кластера
  • ram_usage - Оперативная память, %
  • hdd_usage - Жесткий диск, %
  • cpu_usage - Процессор, %
  • status - Состояние

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

Функция: vmhostnode

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

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

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

  • id - Id
  • name - Наименование
  • ip - IP-адрес
  • vmcount - Количество контейнеров
  • maxvmcount - MAX количество контейнеров
  • configuration - Комментарий
  • status - Состояние

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

Функция: vmhostnode.resume

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

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

Параметры:

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

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

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

Функция: vmhostnode.edit

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

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

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

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

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

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

  • sshkey - Публичный ключ. Публичный ssh ключ, который необходимо положить на сервер
  • has_pwd - Есть пароль для root. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если известен пароль для root, можно ввести его и публичный ключ будет автоматически добавлен на сервер
  • passwd - Пароль. Пароль для пользователя root
  • ip - IP-адрес. IP-адрес узла кластера
  • name - Наименование. Наименование узла кластера
  • maxvmcount - MAX количество контейнеров. Максимальное количество контейнеров, при превышении которого автоматическое размещение на данный узел будет приостановлено
  • configuration - Комментарий. Какая-либо информация о сервере
  • port - Порт. Номер порта ihttpd. При изменении порта необходимо вручную внести изменения в ihttpd.conf на стороне узла кластера

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

Функция: vmhostnode.info

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

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

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

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

Функция: vmhostnode.info.seltype

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

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

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

Функция: vmhostnode.suspend

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

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

Параметры:

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

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

Фильтр

Функция: vmhostnode.filter

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

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

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

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

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

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

  • name - Наименование. Наименование узла кластера
  • ip - IP-адрес. IP-адрес узла кластера

Обновить системное ПО

Функция: vmhostnode.refresh

Обновить системное ПО

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

Параметры:

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

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

Удалить узел кластера

Функция: vmhostnode.delete

Удалить узел кластера

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

Параметры:

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

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

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

Функция: reporthostnode

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

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

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

Брандмауэр

Функция: firewall

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

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

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

  • id - Имя файла
  • name - Наименование
  • proto - Протокол
  • prio - Приоритет

Удалить выделенные записи

Функция: firewall.delete

Удалить выделенные записи

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

Параметры:

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

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

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

Функция: firewall.edit

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

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

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

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

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

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

  • proto - Протокол. Протокол для фильтрации пакетов (IPv4 или IPv6)
  • prio - Приоритет. Приоритет выполнения скриптов с фильтром. Чем меньше это значение - тем раньше выполнится скрипт
  • name - Наименование. Наименование скрипта. Файл будет сформирован с именем: NN_NAME.rule, где NN - приоритет, а NAME - значение данного поля
  • rule - Правила.

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

Функция: usrparam

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

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

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

Изменение данных:

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

  • name - Имя пользователя. Текущее имя пользователя, для которого вы изменяете настройки панели управления
  • theme - Тема. Тема панели управления
  • lang - Язык. Язык панели управления
  • password - Пароль. Пароль для панели управления. Оставьте это поле пустым, если не хотите менять пароль
  • confirm - Подтверждение. Повторите тот же пароль, чтобы убедиться, что ввели его правильно
  • atype - Доступ к панели управления. Укажите, с каких IP-адресов вы хотите разрешить доступ к панели управления.
    Будьте предельно внимательны! Допустив ошибку, возможно, вы не сможете больше попасть в панель управления
  • addr - Список IP-адресов. Укажите список IP-адресов, с которых вы хотите разрешить доступ к панели управления. Можно указать отдельные адреса (123.45.67.89), адреса по маске (123.45.67.0/24), либо диапазон адресов (123.45.67.89-123.45.67.98)
  • startpage - Стартовая страница. Страница, которая будет отображаться первой после того, как вы войдете в систему.
  • rows - Строк на странице. Количество строк таблицы, которые будут отображаться на каждой странице, по умолчанию
  • recordlimit - Количество записей. Максимальное количество записей, которое будет выведено в список. Ограничение нужно для предотвращения длительного формирования результата на больших объемах данных. Зачастую удобнее воспользоваться фильтром, нежели ожидать формирования большого списка, а потом просматривать его.
  • buttonview - Вид кнопок. Выберите предпочитаемое отображение кнопок на панели инструментов
  • hintview - Подсказки. Активные подсказки появляются, когда поле получает фокус ввода. Пассивные, только при наведении курсора на значок подсказки
  • checkunsaved - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Предупреждать о несохраненных полях на форме
  • experience - Уровень опыта пользователя. Укажите предпочитаемый уровень опыта пользователя. Уровень опыта влияет на количество отображаемых полей и на сложность настройки системы.
  • developer_mode - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) В данном режиме у вас появляется возможность менять элементы интерфейса панели, используя web интерфейс

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

Функция: backups

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

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

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

  • plan - План
  • plan_type - Тип плана
  • date - Дата
  • size - Размер, MiB
  • storage - Хранилище
  • backup_type - Тип копии

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

Функция: backupdata

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

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

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

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

Имя данных

Функция: backupdata.names


Содержимое

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

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

Функция: backups.upload

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

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

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

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

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

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

  • type - Тип файла. Укажите, откуда вы хотите закачать файл: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере
  • url - URL. Укажите ссылку на файл, который вы хотите закачать в текущий каталог, например, http://example.com/dir/file.html
  • name - Имя файла. Укажите, с каким именем файл должен быть сохранён в текущем каталоге. Если вы оставите это поле пустым, имя файла будет выделено из URL
  • storage - Хранилище. Выберите хранилище, в которое будет загружена резервная копия

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

Функция: backups.restore

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

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

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

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

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

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

  • behavior - Поведение. Выбор поведения при восстановлении существующих данных

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

Функция: backups.download

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

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

Настройка политик

Функция: settings

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

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

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

Изменение данных:

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

  • tc_enabled - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции для каждого контейнера можно задать ограничение скорости канала
  • sync_enabled - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Автоматическая синхронизация состояния и параметров контейнеров. Синхронизация состояния выполняется раз в 15 минут. Синхронизация параметров выполняется раз в сутки в полночь. Синхронизируемые параметры: объем оперативной памяти, размер жесткого диска, частота процессора, количество процессоров.
  • oversell_enabled - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При создании контейнеров будет проверяться доступность свободных ресурсов
  • oversell_mem - Величина оверселлинга ОЗУ. Доля оперативной памяти, которую можно использовать для контейнеров (50%-1000%). Значения от 50 до 1000
  • oversell_hdd - Величина оверселлинга HDD. Доля размера жесткого диска, которую можно использовать для контейнеров (50%-500%). Значения от 50 до 500
  • oversell_cpu - Величина оверселлинга CPU. Доля мощности процессора, которую можно использовать для контейнеров (50%-1000%). Значения от 50 до 1000
  • cpulimit - Режим ограничения частоты процессора. Без ограничения - максимальная частота процессора не ограничивается; лимитированный режим - максимальная частота жестко ограничена параметрами контейнера; адаптивный режим - динамическое изменение частоты процессора
  • migratemethod - Способ миграции. Задает способ миграции: стандартный - используется утилита zmigrate, поддерживается "живая" миграция; алгоритм VEmanager - используется собственный алгоритм, только "неживая" миграция
  • useswaplimit - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении данной опции появляется возможность указывать лимиты на файл подкачки (swap) для каждого контейнера
  • swapratio - Соотношение Swap/Ram. Укажите соотношение размера файла подкачки к размеру памяти. Рекомендуется использовать значение 200%, что будет означать, что размер swap выделяется в 2 раза больший, чем объем памяти. Значения от 0 до 300
  • applyexists - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция включена, то при сохранении "Соотношение Swap/Ram" будет применено ко всем существующим контейнерам

Контейнеры

Функция: vm

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

Контейнеры

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

  • id - Id
  • name - Наименование
  • hostnode - Узел кластера
  • user - Владелец
  • ip - Основной IP-адрес
  • domain - Доменное имя
  • ostemplate - Шаблон ОС
  • fstype - Файловая система
  • mem - Память, MiB
  • status - Состояние
  • vmnote - Примечание
  • vmnoteu - Примечание

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

Функция: vm.start

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

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

Параметры:

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

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

Удалить контейнер

Функция: vm.delete

Удалить контейнер

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

Параметры:

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

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

Параметр

Функция: vm.sysinfo

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

Информация о системе

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

  • name - Параметр
  • value - Значение

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

Функция: vm.edit

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

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

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

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

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

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

  • id - Id. Уникальный идентификатор
  • name - Наименование. Наименование контейнера
  • user - Владелец. Владелец контейнера
  • hostnode - Узел кластера. Узел кластера, на котором будет создан контейнер
  • preset - Шаблон контейнера. Шаблон контейнера. В нем заданы основные ресурсы
  • ostemplate - Шаблон ОС. Шаблон операционной системы
  • fstype - Файловая система. simfs - файловая система контейнера является частью файловой системы узла кластера, ploop - для размещения файловой системы контейнера создается специальный образ диска
  • iptype - Тип IP-адреса. Публичный - с доступом из сети Internet, приватный - без
  • family - IP-адрес. Основной IP-адрес
  • ip - Определенный IP-адрес. Введите IP-адрес который будет основным
  • domain - Доменное имя. Доменное имя контейнера
  • hdd - Размер основного диска. Размер основного диска в мегабайтах.
  • mem - Оперативная память. Объем оперативной памяти в мебибайтах.
  • swapratio - Соотношение Swap/Ram. Укажите соотношение размера файла подкачки к размеру памяти. Рекомендуется использовать значение 200%, что будет означать, что размер swap выделяется в 2 раза больший, чем объем памяти. Значения от 0 до 300
  • cpu - Процессоры. Количество виртуальных процессоров доступных контейнеру
  • cpufreq - Частота процессора. Относительная частота процессора. Для подробностей смотрите документацию.
  • numfile - Дескрипторы файлов. Ограничение на количество одновременно открытых дескрипторов файлов
  • numproc - Процессы. Ограничение на количество процессов в рамках контейнера
  • chratein - Входящий трафик. Максимальная скорость входящего трафика
  • chrateout - Исходящий трафик. Максимальная скорость исходящего трафика
  • iolimit - Скорость диска (iolimit). Ограничение на максимальную сокрость обмена данными с дисковым устройством
  • iopslimit - I/O-пераций в секунду (iopslimit). Ограничение на максимальное количество операций ввода-вывода в секунду (IOPS - input/output operation per second)
  • password - Пароль. Пароль суперпользователя
  • confirm - Подтверждение пароля. Подтверждение пароля
  • blocked - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции контейнер заблокирован от деструктивных действий. Его нельзя остановить, запустить, удалить, переустановить, отобрать IP-адреса
  • sshpubkey - Публичные SSH ключи. Публичные SSH ключи
  • vmnote - Примечания. Дополнительные сведения о контейнере
  • vmnoteu - Примечания пользователя.

Миграция контейнера

Функция: vm.migrate

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

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

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

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

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

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

  • hostnode - Сервер назначения. Укажите сервер, на который будет произведена миграция выбранного контейнера
  • live - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Миграция без остановки контейнера. Такой тип миграции медленнее и требует больше ресурсов. При стандартной миграции (с отключенной опцией) контейнер на короткое время останавливается. Опция доступна только для включенных контейнеров

Войти в панель управления ISPmanager как администратор выбранного сервера

Функция: vm.isp

Войти в панель управления ISPmanager как администратор выбранного сервера

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

Фильтр

Функция: vm.filter

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

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

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

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

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

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

  • id - Id. Уникальный идентификатор
  • name - Наименование. Наименование контейнера
  • hostnode - Узел кластера. Узел кластера, на котором будет создан контейнер
  • user - Владелец. Владелец контейнера
  • ip - IP-адрес. Введите IP-адрес который будет основным
  • domain - Доменное имя. Доменное имя контейнера
  • ostemplate - Шаблон ОС. Шаблон операционной системы
  • fstype - Файловая система. simfs - файловая система контейнера является частью файловой системы узла кластера, ploop - для размещения файловой системы контейнера создается специальный образ диска
  • status - Состояние.
  • mem - Оперативная память. Объем оперативной памяти в мебибайтах.
  • note - Примечания.
  • noteu - Примечание.

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

Функция: vm.reinstall

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

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

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

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

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

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

  • ostemplate - Шаблон ОС. Шаблон операционной системы
  • sshpubkey - Публичные SSH ключи. Публичные SSH ключи
  • passwd - Пароль. Пароль суперпользователя
  • confirm - Подтверждение пароля. Подтверждение пароля

Остановить контейнер

Функция: vm.stop

Остановить контейнер

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

Параметры:

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

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

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

Функция: vm.su

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

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

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

Функция: vm.snapshot

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

Снимки контейнера

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

  • id - Id
  • guid - UID
  • name - Наименование
  • date - Время создания
  • status - Состояние

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

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

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

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

Сделать снимок контейнера

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

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

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

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

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

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

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

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


  • name - Наименование. Произвольное наименование снимка
  • description - Описание. Описание снимка, произвольный текст
  • memdump - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Возможно только при включенном контейнере. Если опция отключена, то при переключении на данный снимок контейнер будет остановлен

Удалить выделенные записи

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

Удалить выделенные записи

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

Параметры:

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

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

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

Функция: iplist

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

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

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

  • id - Id
  • ip - IP адрес
  • domain - Домен

Назад к предыдущему списку

Функция: '

Назад к предыдущему списку

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

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

Функция: iplist.edit

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

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

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

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

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

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

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


  • iptype - Тип IP-адреса. Публичный - с доступом из сети Internet, приватный - без
  • family - IP-адрес. Выберите предпочитаемый IP-адрес
  • ip - IP адрес. IP-адрес
  • domain - Домен. Доменное имя, закрепленное за указанным IP-адресом

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

Функция: iplist.delete

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

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

Параметры:

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

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

Перезапуск контейнера

Функция: vm.restart

Перезапуск контейнера

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

Параметры:

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

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

Конвертировать в ploop

Функция: vm.convert

Конвертировать в ploop

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

Параметры:

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

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

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

Функция: backupdata

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

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

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

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

Шаблоны ОС

Функция: osmgr

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

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

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

  • name - Шаблон
  • type - Тип
  • state - Состояние
  • repo - Источник
  • date - Дата

Изменить параметры шаблона ОС

Функция: osmgr.edit

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

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

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

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

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

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

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


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

Функция: osmgr.fetch

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

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

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

Функция: osmgr.delete

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

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

Параметры:

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

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

Репозиторий

Функция: repo

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

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

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

  • name - Репозиторий
  • location - Ссылка

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

Функция: repo.delete

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

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

Параметры:

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

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

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

Функция: repo.edit

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

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

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

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

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

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

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

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


  • name - Репозиторий. Наименование репозитория
  • location - Ссылка. Ссылка на репозиторий

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

Функция: osmgr.install

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

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

Параметры:

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

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

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

Функция: osmgr.update

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

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

Шаблоны контейнеров

Функция: preset

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

Шаблоны контейнеров

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

  • id - Id
  • name - Наименование
  • hdd - Объем диска, MB
  • mem - Память, MB
  • swapratio - Соотношение Swap/Ram, %
  • cpu - Процессоры, Шт
  • cpufreq - Частота процессора, MHz
  • numfile - Дескрипторы файлов
  • numproc - Процессы

Фильтр

Функция: preset.filter

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

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

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

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

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

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

  • name - Наименование шаблона контейнера. Наименование шаблона
  • hdd - Размер основного диска. Размер основного диска в мегабайтах
  • mem - Оперативная память. Оперативная память в мегабайтах
  • cpu - Процессоры. Количество процессоров, доступных контейнеру
  • cpufreq - Частота процессора. Относительная частота процессора. Для подробностей смотрите документацию
  • numfile - Дескрипторы файлов. Ограничение на количество одновременно открытых дескрипторов файлов
  • numproc - Процессы. Ограничение на количество процессов в рамках контейнера

Удалить шаблон контейнера

Функция: preset.delete

Удалить шаблон контейнера

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

Параметры:

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

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

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

Функция: preset.edit

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

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

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

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

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

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

  • name - Наименование шаблона контейнера. Наименование шаблона
  • mem - Оперативная память. Оперативная память в мегабайтах
  • swapratio - Соотношение Swap/Ram. Данный параметр учитывается только при активной политике "Персональные лимиты на swap". Укажите соотношение размера файла подкачки к размеру памяти. Рекомендуется использовать значение 200%, что будет означать, что размер swap выделяется в 2 раза больший, чем объем памяти. Значения от 0 до 300
  • cpu - Процессоры. Количество процессоров, доступных контейнеру
  • cpufreq - Частота процессора. Относительная частота процессора. Для подробностей смотрите документацию
  • hdd - Размер основного диска. Размер основного диска в мегабайтах
  • numfile - Дескрипторы файлов. Ограничение на количество одновременно открытых дескрипторов файлов
  • numproc - Процессы. Ограничение на количество процессов в рамках контейнера
  • chratein - Входящий трафик. Максимальная скорость входящего трафика
  • chrateout - Исходящий трафик. Максимальная скорость исходящего трафика
  • iolimit - Скорость диска (iolimit). Ограничение на максимальную сокрость обмена данными с дисковым устройством
  • iopslimit - I/O-пераций в секунду (iopslimit). Ограничение на максимальное количество операций ввода-вывода в секунду (IOPS - input/output operation per second)

Пользователи

Функция: user

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

Пользователи

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

  • id - Id
  • name - Логин
  • level - Уровень доступа
  • ctcount - Количество контейнеров
  • status - Состояние

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

Функция: user.edit

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

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

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

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

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

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

  • level - Уровень доступа. Уровень доступа пользователя
  • name - Логин. Логин для входа
  • snapshot_limit - Лимит снимков. Максимальное количество снимков контейнеров, которые может создать пользователь
  • passwd - Пароль. Пароль доступа
  • confirm - Подтверждение пароля. Введите пароль, чтобы убедиться, что ввели его верно

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

Функция: user.filter

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

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

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

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

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

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

  • name - Логин. Логин для входа
  • level - Уровень доступа. Уровень доступа пользователя

Выключить пользователя

Функция: user.suspend

Выключить пользователя

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

Параметры:

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

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

Удалить пользователя

Функция: user.delete

Удалить пользователя

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

Параметры:

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

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

Войти в панель управления с правами пользователя

Функция: user.su

Войти в панель управления с правами пользователя

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

Включить пользователя

Функция: user.resume

Включить пользователя

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

Параметры:

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

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

Импорт VDS

Функция: import

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

Серверы с VDSmanager

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

  • id - Id
  • ip - IP-адрес
  • name - Наименование
  • vdscount - Количество VDS
  • status - Состояние

Фильтр

Функция: import.filter

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

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

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

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

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

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

  • ip - IP-адрес. IP-адрес сервера, с которого будет производится импорт VDS
  • name - Наименование. Наименование сервера

Остановить процесс импортирования

Функция: import.stop

Остановить процесс импортирования

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

Параметры:

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

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

Изменить информацию о сервере

Функция: import.edit

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

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

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

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

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

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

  • sshkey - Публичный ключ. Публичный ssh ключ, который необходимо положить на сервер
  • has_pwd - Есть пароль для root. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если известен пароль для root, можно ввести его, и публичный ключ будет автоматически добавлен на сервер
  • passwd - Пароль. passwd
  • ip - IP-адрес. IP-адрес сервера, с которого будет производится импорт VDS
  • name - Наименование. Наименование сервера

Начать импорт всех VDS

Функция: import.start

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

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

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

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

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

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

  • user - Владелец. Пользователь, который будет являться владельцем контейнера. Если выбран пункт 'Создать нового' - для каждого контейнера автоматически будет создан новый пользователь
  • fstype - Файловая система. simfs - файловая система контейнера является частью файловой системы узла кластера, ploop - для размещения файловой системы контейнера создается специальный образ диска

Обновить список VDS сервера

Функция: import.refresh

Обновить список VDS сервера

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

Параметры:

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

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

Удалить сервер из списка

Функция: import.delete

Удалить сервер из списка

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

Параметры:

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

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

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

Функция: import.vdslist

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

Список VDS на сервере

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

  • id - Id
  • ctid - Id VDSmgr
  • vectid - Id VEmgr
  • ip - IP-адрес
  • name - Наименование
  • mem - Оперативная память
  • disk - Размер диска
  • cpufreq - Частота процессора
  • cpucount - Процессоры
  • ostemplate - Шаблон ОС
  • status - Состояние

Начать импорт VDS

Функция: import.vdslist.start

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

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

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

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

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

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

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

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


  • changename - Изменить имя VDS. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • name - Наименование. Вы можете указать с каким наименованием будет создана виртуальная машина
  • user - Владелец. Пользователь, который будет являться владельцем контейнера. Если выбран пункт 'Создать нового' - новый пользователь будет создан автоматически
  • fstype - Файловая система. simfs - файловая система контейнера является частью файловой системы узла кластера, ploop - для размещения файловой системы контейнера создается специальный образ диска

Обновить список VDS и состояние

Функция: import.vdslist.check

Обновить список VDS и состояние

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

Параметры:

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

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

Остановить импортирование

Функция: import.vdslist.stop

Остановить импортирование

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

Параметры:

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

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

Фильтр

Функция: import.vdslist.filter

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

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

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

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

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

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

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

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


  • ctid - Id VDSmgr.
  • vectid - Id VEmgr.
  • ip - IP-адрес.
  • name - Наименование.

Настройки

Функция: backup.plan

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

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

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

  • name - Имя
  • cron - Расписание
  • type - Тип
  • state - Статус

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

Функция: backup.settings

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

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

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

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

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

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

  • backuptmpdir - Временный каталог. Рабочий каталог модуля резервного копирования. В нем хранятся временные файлы: архивы, листинги и прочие
  • backuptimeout - Таймаут. Максимальное время ожидания подготовки данных (виртуальных машин)

Будет раскомментирована строка в crontab, отвечающая за запуск задачи. Если строка в crontab отсутствует, то создастся новая со значением по умолчанию

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

Будет раскомментирована строка в crontab, отвечающая за запуск задачи. Если строка в crontab отсутствует, то создастся новая со значением по умолчанию

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

Параметры:

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

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

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

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

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

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

Параметры:

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

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

Будет закомментирована строка в crontab, отвечающая за запуск задачи. Останется возможность ручного запуска плана

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

Будет закомментирована строка в crontab, отвечающая за запуск задачи. Останется возможность ручного запуска плана

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

Параметры:

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

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

Имя данных

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

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

Настройка фильтрации плана

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

  • num - Номер
  • type - Тип данных
  • owner - Владелец
  • name - Имя данных
  • filename - Файлы
  • comment - Комментарий
  • include - Статус

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

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

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

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

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

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

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

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

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

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


  • include - Статус. Включить или исключить данные из резервного копирования
  • comment - Комментарий. Пояснение, для чего нужен данный фильтр
  • type - Тип данных. Тип данных для фильтрации
  • owner - Владелец. Пользователь, которому принадлежат данные
  • allnames - Данные. Конкретизировать данные для фильтрации на основе их имен
  • pattern - Шаблон. Шаблон фильтрации по именам данных. Можно использовать символы * и ?
  • name - Выбор данных. Выбрать конкретные данные по имени
  • ft_files - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Фильтр накладывается только на файлы выбранного типа данных.
  • filename - Файл или директория. Путь до файла или директории на который нужно наложить данный фильтр. Может быть как абсолютным так и относительным

Удалить выделенные записи

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

Удалить выделенные записи

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

Параметры:

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

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

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

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

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

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

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

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

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

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

  • name - Имя. Наименование плана резервного копирования
  • id - Внутреннее имя. Имя, используемое в именах архивов и для связей в базе данных
  • backup_type - Тип. Тип резервного копирования: Полный, Инкрементальный, Дифференциальный
  • archiver - Архиватор. Чем архивировать данные
  • storage - Хранилище. Список хранилищ, в которые будут сохранены резервные копии
  • rewrite_today - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет храниться только одна последняя копия за сегодняшний день
  • max_file_size - Макс. размер файла.. Максимальный размер файла в мибибайтах. Файлы больше этого размера не будут добавлены в резервную копию
  • max_dir_size - Макс. размер файла директории.. Максимальный размер файла директории в мибибайтах. Директории, размер файла которых больше заданного значения не будут добавлены в резервную копию. На размер файла директории влияет количество файлов в этой директории.
  • run_every - Выполнять. Период выполнения задания
  • full_period - Период. Период проведения полного копирования
  • full_weekday - День недели. День недели, в который будет запускаться полное резервное копирование
  • full_monthday - День месяца. День месяца, в который будет запускаться полное резервное копирование
  • dlimit - Ежедневных копий. Будет сохранено по одной резервной копии за n последних дней, где n - заданное число
  • wlimit - Еженедельных копий. Будет сохранено по одной резервной копии за n последних недель, где n - заданное число
  • mlimit - Ежемесячных копий. Будет сохранено по одной резервной копии за n последних месяцев, где n - заданное число

SSH ключи

Функция: sshpubkey

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

SSH ключи

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

  • name - Наименование ключа

SSH ключи

Функция: sshpubkey.edit

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

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

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

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

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

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

  • name - Наименование ключа. Наименование ключа
  • pubkey - Публичный SSH ключ. Публичный SSH ключ

Удалить выделенные записи

Функция: sshpubkey.delete

Удалить выделенные записи

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

Параметры:

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

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

Хранилища

Функция: backup.storages

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

Хранилища

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

  • name - Имя
  • destination - Назначение
  • type - Тип

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

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

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

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

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

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

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

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

  • name - Имя. Название хранилища. Будет отображаться в интерфейсе под этим именем
  • search_backups - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет произведен поиск резервных копий в хранилище и импорт lst файлов в панель
  • missed_archives_list - Список недостающих архивов:. Список недостающих в новом хранилище архивов . Вы не сможете восстановить данные из архивов, находящихся в этом списке
  • missed_archives_agree - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)

Создать

Функция: backup.storages.add

Создать

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

Удалить выделенные записи

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

Удалить выделенные записи

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

Параметры:

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

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

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

Функция: reporthostnode

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

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

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