Описание параметров схемы
Architecture
Архитектура процессора.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор архитектуры процессора |
|
|
Да |
|
Наименование архитектуры процессора |
|
BasicError
Информация об ошибке.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Код ошибки. Включает параметр
|
|
|
Да |
|
Сообщение об ошибке |
|
BootableImageBootMode
Поддерживаемые режимы загрузки на целевом устройстве.
Возможные значения: BIOS, UEFI, ALL.
Тип: string.
Пример: BIOS.
BootableImageCreateRequest
Параметры для создания загрузочного образа.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование загрузочного образа |
|
|
Нет |
|
Описание загрузочного образа, комментарии (мин. длина: 1) |
|
|
Нет |
|
Имя ISO-файла загрузочного образа (мин. длина: 1; макс. длина: 255) |
|
BootableImagesPagedResponse
Атрибуты загрузочного образа.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
Список загрузочных образов. Включает параметр: |
||
|
Да |
Метаданные постраничного вывода |
BootableImageResponse
Атрибуты загрузочного образа.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор загрузочного образа |
|
|
Да |
|
Наименование загрузочного образа |
|
|
Нет |
|
Тип установочного образа. Включает параметр |
|
|
Да |
|
Статусы подготовки загрузочного образа. Включает параметр |
|
|
Нет |
|
Имя ISO-файла загрузочного образа (мин. длина: 1; макс. длина: 255) |
|
|
Нет |
|
Описание загрузочного образа, комментарии (мин. длина: 1) |
|
|
Да |
Архитектура процессора. Включает параметр |
||
|
Нет |
Список планов развертываний, на базе которых был сформирован загрузочный образ
Включает параметр |
||
|
Да |
|
Поддерживаемые режимы загрузки на целевом устройстве. Включает параметр |
|
|
Да |
|
Дата и время создания загрузочного образа |
|
|
Да |
|
Пользователь, создавший загрузочный образ |
|
|
Нет |
|
Дата и время последнего изменения загрузочного образа |
|
|
Нет |
|
Пользователь, совершивший последнее изменения загрузочного образа |
|
BootableImagesSearchRequest
Параметры для поиска загрузочных образов.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Нет |
|
Наименование загрузочного образа, контекстный поиск |
|
|
Нет |
|
Имя ISO-файла загрузочного образа (мин. длина: 3; макс. длина: 255) |
|
|
Нет |
|
Статусы подготовки загрузочного образа. Включает параметр |
|
|
Нет |
|
Список идентификаторов типов загрузочных образов (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов архитектур процессора (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов планов развертываний |
|
|
Нет |
|
Поддерживаемые режимы загрузки на целевом устройстве. Включает параметр |
|
BootableImageStatus
Статусы подготовки загрузочного образа.
Возможные значения: CREATED, STARTED, READY, FAILED.
Тип: string.
Пример: CREATED.
BootableImageType
Тип загрузочного образа.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор типа загрузочного образа |
|
|
Да |
|
Наименование типа загрузочного образа |
|
DeploymentMode
Режим развертывания ОС, например, установка с нуля или переустановка
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор режима развертывания |
|
|
Да |
|
Наименование режима развертывания |
|
ErrorCode
Код ошибки.
Тип: string.
Допустимые значения:
-
object_already_exists— объект уже существует; -
object_not_found— объект не найден; -
validation_failed— ошибка валидации; -
authorization_failed— ошибка авторизации; -
internal_error— внутренняя ошибка.
InstallationDistroCreateRequest
Параметры для создания установочного дистрибутива.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование установочного дистрибутива |
|
|
Нет |
|
Описание установочного дистрибутива, комментарии |
|
|
Да |
|
URL репозитория, где размещается установочный дистрибутив (мин. длина: 1) |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы |
|
|
Да |
Семейство ОС. Включает параметр |
||
|
Да |
|
Идентификатор архитектуры процессора, которую поддерживает создаваемый установочный дистрибутив (мин. длина: 1) |
|
|
Да |
|
Версия ОС |
|
InstallationDistrosPagedResponse
Список установочных дистрибутивов с метаданными постраничного вывода.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
Список установочных дистрибутивов. Включает параметр: |
||
|
Да |
Метаданные постраничного вывода |
InstallationDistroPreview
Предпросмотр установочного дистрибутива.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор установочного дистрибутива |
|
|
Да |
|
Наименование установочного дистрибутива |
|
|
Да |
|
URL репозитория, где размещается установочный дистрибутив |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы |
|
InstallationDistroResponse
Атрибуты установочного дистрибутива.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор установочного дистрибутива |
|
|
Да |
|
Наименование установочного дистрибутива |
|
|
Нет |
|
Описание установочного дистрибутива, комментарии |
|
|
Да |
|
URL репозитория, где размещается установочный дистрибутив |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы |
|
|
Да |
Семейство ОС. Включает параметр |
||
|
Да |
Архитектура процессора. Включает параметр |
||
|
Да |
|
Версия ОС |
|
|
Да |
|
Дата и время создания установочного дистрибутива |
|
|
Да |
|
Пользователь, создавший установочный дистрибутив |
|
|
Нет |
|
Дата и время последнего изменения установочного дистрибутива |
|
|
Нет |
|
Пользователь, совершивший последнее изменение установочного дистрибутива |
|
InstallationDistrosSearchRequest
Параметры для поиска установочных дистрибутивов.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Нет |
|
Наименование установочного дистрибутива (мин. длина: 3; макс. длина: 255) |
|
|
Нет |
|
Список идентификаторов семейств ОС |
|
|
Нет |
|
Список идентификаторов архитектур процессора |
|
|
Нет |
|
Версия ОС (мин. длина: 3; макс. длина: 255) |
|
InstallationDistroUpdateRequest
Список установочных дистрибутивов с метаданными постраничного вывода.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование установочного дистрибутива (мин. длина: 1) |
|
|
Нет |
|
Описание установочного дистрибутива, комментарии |
|
|
Да |
|
URL репозитория, где размещается установочный дистрибутив (мин. длина: 1) |
`http://mirror.centos.org/centos-7/7/os/x86_64/` |
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС (мин. длина: 1) |
|
|
Да |
|
Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы (мин. длина: 1) |
|
|
Да |
|
Идентификатор семейства ОС, к которому принадлежит создаваемый установочный дистрибутив (мин. длина: 1) |
|
|
Да |
|
Идентификатор семейства ОС, к которому принадлежит создаваемый установочный дистрибутив (мин. длина: 1) |
|
|
Да |
|
Версия ОС (мин. длина: 1) |
|
InstallationProfileCreateRequest
Параметры для создания профиля установки.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование профиля установки (мин. длина: 1) |
|
|
Нет |
|
Описание профиля установки, комментарии |
|
|
Да |
|
Идентификатор установочного дистрибутива |
|
|
Нет |
|
Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1) |
|
|
Да |
|
Список идентификаторов поддерживаемых методов установки ОС (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов шаблонов скриптов пост-установки |
|
|
Да |
|
Идентификатор шаблона файла ответов |
|
InstallationProfilePagedResponse
Список профилей установки с метаданными постраничного вывода.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
Список установочных дистрибутивов. Включает параметр: |
||
|
Да |
Метаданные постраничного вывода |
InstallationProfilePreview
Предпросмотр профиля установки.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор профиля установки |
|
|
Да |
|
Наименование профиля установки |
|
InstallationProfileResponse
Атрибуты профиля установки.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор профиля установки |
|
|
Да |
|
Наименование профиля установки |
|
|
Нет |
|
Описание профиля установки, комментарии |
|
|
Да |
Предпросмотр установочного дистрибутива. Включает параметр |
||
|
Нет |
|
Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1) |
|
|
Да |
Список поддерживаемых методов установки ОС. Включает параметр |
||
|
Нет |
Список шаблонов скриптов пост-установки. Включает параметр |
||
|
Да |
Предпросмотр шаблона. Включает параметр |
||
|
Да |
|
Дата и время создания профиля установки |
|
|
Да |
|
Пользователь, создавший создавший профиль установки |
|
|
Нет |
|
Дата и время последнего изменения профиля установки |
|
|
Нет |
|
Пользователь, совершивший последнее изменение профиля установки |
|
InstallationProfileSearchRequest
Параметры для поиска профилей установки.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Нет |
|
Наименование профиля установки (мин. длина: 3; макс. длина: 255) |
|
|
Нет |
|
Список идентификаторов установочных дистрибутивов |
|
|
Нет |
|
Список идентификаторов методов установки ОС (мин. длина: 1) |
|
InstallationProfileUpdateRequest
Параметры для изменения профиля установки.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование профиля установки (мин. длина: 1) |
|
|
Нет |
|
Описание профиля установки, комментарии |
|
|
Да |
|
Идентификатор установочного дистрибутива |
|
|
Нет |
|
Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1) |
|
|
Да |
|
Список поддерживаемых методов установки ОС (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов шаблонов скриптов пост-установки |
|
|
Да |
|
Идентификатор шаблона файла ответов |
|
InstallationRecipeCreateRequest
Параметры для создания способа развертывания.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование способа развертывания (мин. длина: 1) |
|
|
Нет |
|
Описание способа развертывания, комментарии |
|
|
Да |
|
Идентификатор профиля установки, который используется при установке ОС на устройства |
|
|
Да |
|
Идентификатор метода установки, по которому производится установка ОС на устройства (мин. длина: 1) |
|
|
Нет |
|
Идентификатор конфигурации, на которую производится установка ОС |
|
|
Нет |
|
Версия конфигурации, на которую производится установка ОС |
|
|
Да |
|
Идентификатор режима развертывания ОС (мин. длина: 1) |
|
|
Нет |
|
Хеш пароля суперпользователя (мин. длина: 1) |
|
|
Нет |
|
Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: |
|
|
Нет |
|
Признак необходимости создания локального пользователя |
|
|
Нет |
Данные локального пользователя. Включает параметр: |
||
|
Нет |
|
Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1) |
|
InstallationRecipePagedResponse
Список профилей установки с метаданными постраничного вывода.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
Список установочных дистрибутивов. Включает параметр: |
||
|
Да |
Метаданные постраничного вывода |
InstallationRecipePreview
Предпросмотр способа развертывания.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор способа развертывания |
|
|
Да |
|
Наименование способа развертывания |
|
InstallationRecipeResponse
Атрибуты способа развертывания.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор способа развертывания |
|
|
Да |
|
Наименование способа развертывания |
|
|
Нет |
|
Описание способа развертывания, комментарии |
|
|
Да |
Предпросмотр профиля установки. Включает параметр |
||
|
Да |
Список поддерживаемых методов установки ОС. Включает параметр |
||
|
Нет |
|
Идентификатор конфигурации, на которую производится установка ОС |
|
|
Нет |
|
Версия конфигурации, на которую производится установка ОС |
|
|
Да |
|
Режим развертывания ОС, например, установка с нуля или переустановка. Включает параметр: |
|
|
Нет |
|
Хеш пароля суперпользователя |
|
|
Нет |
|
Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: |
|
|
Нет |
|
Признак необходимости создания локального пользователя |
|
|
Нет |
Данные локального пользователя. Включает параметр: |
||
|
Нет |
|
Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1) |
|
|
Да |
|
Дата и время создания способа развертывания |
|
|
Да |
|
Пользователь, создавший план развертывания |
|
|
Нет |
|
Дата и время последнего изменения способа развертывания |
|
|
Нет |
|
Пользователь, совершивший последнее изменение способа развертывания |
|
InstallationRecipeSearchRequest
Параметры для поиска способа развертывания.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Нет |
|
Наименование способа развертывания, контекстный поиск (мин. длина: 3; макс. длина: 255) |
|
|
Нет |
|
Список идентификаторов профилей установки |
|
|
Нет |
|
Список идентификаторов методов установки ОС (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов режимов развертывания ОС (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов конфигураций |
|
InstallationRecipeUpdateRequest
Параметры для изменения способа развертывания.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование способа развертывания (мин. длина: 1) |
|
|
Нет |
|
Описание способа развертывания, комментарии |
|
|
Да |
|
Идентификатор профиля установки, который будет использоваться при установке ОС на устройства |
|
|
Да |
Идентификатор метода установки, по которому будет производиться установка ОС на устройства (мин. длина: 1) |
|
|
|
Нет |
|
Идентификатор конфигурации, на которую производится установка ОС |
|
|
Нет |
|
Версия конфигурации, на которую производится установка ОС |
|
|
Да |
|
Режим развертывания ОС, например, установка с нуля или переустановка |
|
|
Нет |
|
Хеш пароля суперпользователя |
|
|
Нет |
|
Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: |
|
|
Нет |
|
Признак необходимости создания локального пользователя |
|
|
Нет |
Данные локального пользователя. Включает параметр: |
||
|
Нет |
|
Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1) |
|
OsFamily
Семейство ОС.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор семейства ОС |
|
|
Да |
|
Наименование семейства ОС |
|
ProvisioningMethod
Метод установки ОС, определяющий, каким образом будет производиться установка, например, полностью по сети с использованием технологии PXE или с автономного носителя.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор метода установки |
|
|
Да |
|
Наименование метода установки |
|
TemplateCategory
Категория шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор категории шаблона |
|
|
Да |
|
Наименование категории шаблона |
|
TemplateCreateRequest
Параметры для создания шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование шаблона (мин. длина: 1) |
|
|
Нет |
|
Описание шаблона, комментарии |
|
|
Нет |
|
Идентификатор семейства ОС, к которому применим создаваемый шаблон (мин. длина: 1) |
|
|
Да |
|
Идентификатор категории шаблона (мин. длина: 1) |
|
|
Да |
|
Содержимое шаблона (мин. длина: 1) |
|
TemplatePagedResponse
Список шаблонов с метаданными постраничного вывода.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
Список установочных дистрибутивов. Включает параметр: |
||
|
Да |
Метаданные постраничного вывода |
TemplatePreview
Предпросмотр шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор шаблона |
|
|
Да |
Категория шаблона. Включает параметр |
||
|
Да |
|
Наименование шаблона |
|
TemplateResponse
Атрибуты шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Уникальный внутренний идентификатор шаблона |
|
|
Да |
|
Наименование шаблона |
|
|
Нет |
|
Описание шаблона, комментарии |
|
|
Нет |
Семейство ОС. Включает параметр |
||
|
Да |
Категория шаблона. Включает параметр |
||
|
Да |
|
Содержимое шаблона |
|
|
Да |
|
Дата и время создания шаблона |
|
|
Да |
|
Пользователь, создавший шаблон |
|
|
Нет |
|
Дата и время последнего изменения шаблона |
|
|
Нет |
|
Пользователь, совершивший последнее изменение шаблона |
|
TemplateSearchRequest
Параметры для поиска шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Нет |
|
Наименование шаблона (мин. длина: 3; макс. длина: 255) |
|
|
Нет |
|
Список идентификаторов семейств ОС (мин. длина: 1) |
|
|
Нет |
|
Список идентификаторов категорий шаблонов (мин. длина: 1) |
|
TemplateUpdateRequest
Параметры для изменения шаблона.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Наименование шаблона (мин. длина: 1) |
|
|
Нет |
|
Описание шаблона, комментарии |
|
|
Нет |
|
Идентификатор семейства операционных систем, к которому применим создаваемый шаблон (мин. длина: 1) |
|
|
Да |
|
Идентификатор категории шаблона (мин. длина: 1) |
|
|
Да |
|
Содержимое шаблона (мин. длина: 1) |
|
UserAccount
Данные локального пользователя.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Полное имя пользователя (мин. длина: 1) |
|
|
Да |
|
Имя пользователя (мин. длина: 1) |
|
|
Да |
|
Хеш пароля пользователя (мин. длина: 1) |
|