Команда onetemplate

Метод XML-RPC

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

update

one.template.update

TEMPLATE:MANAGE

instantiate

one.template.instantiate

TEMPLATE:USE

[IMAGE:USE]

[NET:USE]

create

one.template.allocate

TEMPLATE:CREATE

clone

one.template.clone

TEMPLATE:CREATE

TEMPLATE:USE

delete

one.template.delete

TEMPLATE:MANAGE

show

one.template.info

TEMPLATE:USE

chown

chgrp

one.template.chown

TEMPLATE:MANAGE

[USER:MANAGE]

[GROUP:USE]

chmod

one.template.chmod

TEMPLATE:<MANAGE/ADMIN>

rename

one.template.rename

TEMPLATE:MANAGE

list

top

one.templatepool.info

TEMPLATE:USE

lock

one.template.lock

TEMPLATE:MANAGE

unlock

one.template.unlock

TEMPLATE:MANAGE

one.template.allocate

Тип

Тип данных

Описание

IN

String

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

IN

String

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

OUT

Boolean

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

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

OUT

Int/String

Идентификатор выделяемого ресурса/ Строка с ошибкой

OUT

Int

Код ошибки

one.template.clone

Тип

Тип данных

Описание

IN

String

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

IN

Int

Идентификатор тиражируемого шаблона 

IN

String

Имя нового шаблона

IN

Boolean

true - тиражирование шаблона вместе с образом, заданным в блоке DISK.

Каждому новому образу присваивается новый идентификатор

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.delete

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

Boolean

true - удаление шаблона вместе с образом, заданным в блоке DISK

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.instantiate

Объявление блока перезаписывает шаблон. Например, при объявлении DISK=[...] параметры блока DISK будут перезаписаны, и поэтому должны содержать полное определение блока DISK.


Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

String

Имя нового экземпляра виртуальной машины. Если имя не задано, ПК СВ присвоит имя автоматически

IN

Boolean

  • false - создание виртуальной машины в режиме ожидания (по умолчанию);
  • true - создание виртуальной машины в режиме удержания

IN

String

Строка, содержащая дополнительный шаблон, который должен быть объединен с создаваемым экземпляром. Она может быть пустой. 

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

IN

Boolean

true - создание персональной постоянной копии шаблона вместе с образом, заданным в блоке DISK, с ее последующим развертыванием

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

one.template.update

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

String

Содержание нового шаблона.

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

IN

Int

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

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

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

one.template.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, этот бит не меняется

IN

Boolean

true - изменение разрешения шаблона вместе с образом, заданным в блоке DISK

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.chown

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

Int

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

IN

Int

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

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.rename

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

String

Новое имя шаблона

OUT

Boolean

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

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

OUT

Int/String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.info

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

IN

Boolean

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

IN

Boolean

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

OUT

Boolean

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

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

OUT

String

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

OUT

Int

Код ошибки

OUT

Int

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

one.templatepool.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

String

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

OUT

Int

Код ошибки

OUT

Int

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

one.template.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.template.unlock

Тип

Тип данных

Описание

IN

String

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

IN

Int

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

OUT

Boolean

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

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

OUT

Int

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

OUT

Int

Код ошибки

OUT

Int

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