Команда onevnet

Метод XML-RPC

Требуемые разрешения

addar

one.vn.add_ar

NET:ADMIN

rmar

one.vn.rm_ar

NET:ADMIN

free

one.vn.free_ar

NET:MANAGE

reserve

one.vn.reserve

NET:USE

updatear

one.vn.update_ar

NET:MANAGE

hold

one.vn.hold

NET:MANAGE

release

one.vn.release

NET:MANAGE

update

one.vn.update

NET:MANAGE

create

one.vn.allocate

NET:CREATE

[CLUSTER:ADMIN]

delete

one.vn.delete

NET:MANAGE

show

one.vn.info

NET:USE

chown

chgrp

one.vn.chown

NET:MANAGE

[USER:MANAGE]

[GROUP:USE]

chmod

one.vn.chmod

NET:<MANAGE/ADMIN>

rename

one.vn.rename

NET:MANAGE

list

one.vnpool.info

NET:USE

lock

one.vn.lock

NET:MANAGE

unlock

one.vn.unlock

NET:MANAGE

one.vn.add_ar 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Шаблон диапазона адресов для добавления. Синтаксис может быть стандартным  attribute=value или в формате XML

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.rm_ar 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Идентификатор диапазона адресов для удаления

IN

Boolean

Необязательный флаг для принудительного удаления

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.free_ar 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Идентификатор диапазона адресов для освобождения

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.reserve 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Виртуальная сеть для резервирования

IN

Int

Шаблон

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

Параметр шаблон должен соответствовать стандартному синтаксису со следующими значениями:

Параметр

Описание

Обязательный

SIZE

Размер резервирования

Да

NAME

Имя, если этот параметр задан будет создана новая виртуальная сеть с этим именем

Нет

AR_ID

Идентификатор диапазона адресов для резервирования

Нет

NETWORK_ID

Идентификатор виртуальной сети для резервирования, если не задан параметр NAME

Нет

MAC

Первый MAC-адрес , с которого начинается диапазон резервирования [MAC, MAC+SIZE)

Нет

IP

Первый IP-адрес , с которого начинается диапазон резервирования [IP, IP+SIZE)

Нет

one.vn.update_ar 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Шаблон диапазона адресов для обновления. Синтаксис может быть стандартным  attribute=value или в формате XML

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.hold

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Шаблон диапазона адресов для удержания, например LEASES=[IP=192.168.0.5]

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.release

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Шаблон диапазона адресов для освобождения, например LEASES=[IP=192.168.0.5]

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.update

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Содержание нового шаблона. Синтаксис может быть стандартным  attribute=value или в формате XML

IN

Int

Типы обновления шаблона: 

  • 0 — перезаписать весь шаблон; 
  • 1 — объединить новый шаблон с существующим

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.allocate 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

String

Содержание шаблона новой виртуальной сети. Синтаксис может быть стандартным  attribute=value или в формате XML

IN

Int

Идентификатор кластера. Если установить значение -1, будет выбран кластер по умолчанию

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.delete

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор виртуальной сети, вызвавшей ошибку

one.vn.info 

Правила ACL не применяются к резервированию в виртуальной сети таким же образом, как к обычным виртуальным сетям и другим объектам.


Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

OUT

Boolean

Необязательный флаг для расшифровки скрытой информации, доступен только для администратора

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Строка с информацией / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.vn.chown 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Идентификатор нового владельца. Если установить значение -1, владелец не меняется

IN

Int

Идентификатор новой группы. Если установить значение -1, группа не меняется

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.vn.chmod

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Бит прав владельца типа USE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прав владельца типа MANAGE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прав владельца типа ADMIN. Если установить значение -1, этот бит не меняется

IN

Int

Бит прав группы типа USE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прав группы типа MANAGE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прав группы типа ADMIN. Если установить значение -1, этот бит не меняется

IN

Int

Бит прочих прав типа USE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прочих прав типа MANAGE. Если установить значение -1, этот бит не меняется

IN

Int

Бит прочих прав типа ADMIN.. Если установить значение -1, этот бит не меняется

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.vn.rename 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Новое имя виртуальной сети

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.vnpool.info 

Можно вывести диапазон из всего списка идентификаторов от первого до последнего. Для того чтобы вывести весь диапазон необходимо задать (-1, -1), для извлечения диапазона от заданного идентификатора до конца списка задать (<id>, 1), для извлечения диапазона от начала списка до заданного идентификатора, необходимо задать (0, <id>), где <id> — заданный идентификатор.


Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Фильтр:

  • -4 — ресурсы, принадлежащие к основной группе пользователя; 

  • -3 — ресурсы, принадлежащие пользователю; 

  • -2 — все ресурсы;

  • -1 — ресурсы, принадлежащие пользователю и любой его группе; 

  • больше или равно 0 — ресурсы, принадлежащие пользователю, идентифицированному по заданному UID

IN

Int

Если следующий параметр больше или равен -1, это начало диапазона. Значения меньше -1, используются для определения с какой записи будет выводиться информация

IN

Int

Для значений больше или равных -1, это последний идентификатор диапазона. Значения меньше -1, используются для определения сколько записей будет выводиться на странице

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Строка с информацией / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.vn.lock 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Уровень блокировки:

  • 1 — использование;
  • 2 — управление;
  • 3 — администрирование;
  • 4 — все

IN

Boolean

test - проверка блокировки объекта для возвращения сообщения об ошибке

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int

Идентификатор ресурса 

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

OUT

String

Если test = true - выдача сообщения об ошибке с указанием временной метки блокировки шаблона

one.vn.unlock 

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

OUT

Boolean

В зависимости от выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int

Идентификатор ресурса 

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку