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

ActionCode

Код действия, уникальный в рамках одного объекта (мин. длина: 3; макс. длина: 256)

Тип: string

Пример: view

AllowedRolePermission

Разрешение роли.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Уникальный код объекта

configurations

actions

Да

string

Код действия, уникальный в рамках одного объекта. Включает параметр ActionCode

view

Architecture

Архитектура процессора.

Имя поля Обязательное Тип Описание Пример

architectureId

Да

string

Уникальный внутренний идентификатор архитектуры процессора

x86_64

name

Да

string

Наименование архитектуры процессора

x86-64

BasicError

Информация об ошибке.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Код ошибки. Включает параметр ErrorCode. Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка

validation_failed

message

Да

string

Сообщение об ошибке

Template contains not resolved variables

BootableImageBootMode

Поддерживаемые режимы загрузки на целевом устройстве.

Возможные значения: BIOS, UEFI, ALL.

Тип: string.

Пример: BIOS.

BootableImageCreateRequest

Параметры для создания загрузочного образа.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование загрузочного образа

generic x64 bios/uefi cdrom/usb

description

Нет

string

Описание загрузочного образа, комментарии (мин. длина: 1)

Универсальный ISO-образ для установки на x64 машины

imageFileName

Нет

string

Имя ISO-файла загрузочного образа (мин. длина: 1; макс. длина: 255)

generic_bootdisk

BootableImagesPagedResponse

Атрибуты загрузочного образа.

Имя поля Обязательное Тип Описание Пример

bootableImages

Да

Список загрузочных образов. Включает параметр: bootableImageResponse

meta

Да

Метаданные постраничного вывода

BootableImageResponse

Атрибуты загрузочного образа.

Имя поля Обязательное Тип Описание Пример

bootableImageId

Да

string($uuid)

Уникальный внутренний идентификатор загрузочного образа

e750fe40-5902-4e4d-9fd2-b587139946f5

name

Да

string

Наименование загрузочного образа

generic x64 bios/uefi cdrom/usb

bootableImageType

Нет

string

Тип установочного образа. Включает параметр bootableImageType

status

Да

string

Статусы подготовки загрузочного образа. Включает параметр BootableImageStatus

CREATED

imageFileName

Нет

string

Имя ISO-файла загрузочного образа (мин. длина: 1; макс. длина: 255)

generic_bootdisk

description

Нет

string

Описание загрузочного образа, комментарии (мин. длина: 1)

Универсальный ISO-образ для установки на x64 машины

architecture

Да

Архитектура процессора. Включает параметр Architecture

installationRecipes

Нет

Список планов развертываний, на базе которых был сформирован загрузочный образ Включает параметр InstallationRecipePreview

bootMode

Да

string

Поддерживаемые режимы загрузки на целевом устройстве. Включает параметр BootableImageBootMode

BIOS

createdAt

Да

string($date-time)

Дата и время создания загрузочного образа

2024-03-18T14:53:08.865312Z

createdBy

Да

string

Пользователь, создавший загрузочный образ

vivanov@domain.local

updatedAt

Нет

string($date-time)

Дата и время последнего изменения загрузочного образа

2024-03-18T14:53:08.865312Z

updatedBy

Нет

string

Пользователь, совершивший последнее изменения загрузочного образа

vivanov@domain.local

BootableImagesSearchRequest

Параметры для поиска загрузочных образов.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Наименование загрузочного образа, контекстный поиск

generic x64 bios/uefi cdrom/usb

imageFileName

Нет

string

Имя ISO-файла загрузочного образа (мин. длина: 3; макс. длина: 255)

generic_bootdisk

statuses

Нет

string

Статусы подготовки загрузочного образа. Включает параметр BootableImageStatus

CREATED

bootableImagesTypeIds

Нет

string

Список идентификаторов типов загрузочных образов (мин. длина: 1)

genericbootimage

architectureIds

Нет

string

Список идентификаторов архитектур процессора (мин. длина: 1)

x86_64

installationRecipeIds

Нет

string($uuid)

Список идентификаторов планов развертываний

a7e0ab48-f954-48c9-89bb-7f343ccb60e2

bootModes

Нет

string

Поддерживаемые режимы загрузки на целевом устройстве. Включает параметр BootableImageBootMode

BIOS

BootableImageStatus

Статусы подготовки загрузочного образа.

Возможные значения: CREATED, STARTED, READY, FAILED.

Тип: string.

Пример: CREATED.

BootableImageType

Тип загрузочного образа.

Имя поля Обязательное Тип Описание Пример

bootableImageTypeId

Да

string

Уникальный внутренний идентификатор типа загрузочного образа

genericbootimage

name

Да

string

Наименование типа загрузочного образа

Универсальный загрузочный образ

Bootloader

Загрузчик.

Имя поля Обязательное Тип Описание Пример

bootloaderId

Да

string

Уникальный идентификатор загрузчика

ipxe

name

Да

string

Наименование загрузчика

IPXE

BootloadersResponse

Список загрузчиков.

Имя поля Обязательное Тип Описание Пример

bootloaderId

Да

string

Уникальный идентификатор загрузчика

ipxe

name

Да

string

Наименование загрузчика

IPXE

DeploymentMode

Режим развертывания ОС, например, установка с нуля или переустановка

Имя поля Обязательное Тип Описание Пример

deploymentModeId

Да

string

Уникальный внутренний идентификатор режима развертывания

installation

name

Да

string

Наименование режима развертывания

Installation

ErrorCode

Код ошибки.

Тип: string.

Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка.

HashAlgorithm

Поддерживаемые алгоритмы хеширования.

Тип: string.

Допустимые значения:

  • MD5;

  • SHA512.

InstallationDistroCreateRequest

Параметры для создания установочного дистрибутива.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование установочного дистрибутива

debian-bookworm-x86-84

description

Нет

string

Описание установочного дистрибутива, комментарии

Description or commentary

repositoryUrl

Да

string

URL репозитория, где размещается установочный дистрибутив (мин. длина: 1)

http://mirror.centos.org/centos-7/7/os/x86_64/

kernel

Да

string

Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС

images/pxeboot/vmlinuz

initrd

Да

string

Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы

images/pxeboot/initrd.img

osFamily

Да

Семейство ОС. Включает параметр OsFamily

architectureId

Да

string

Идентификатор архитектуры процессора, которую поддерживает создаваемый установочный дистрибутив (мин. длина: 1)

x86_64

osVersion

Да

string

Версия ОС

20.04.6

InstallationDistrosPagedResponse

Список установочных дистрибутивов с метаданными постраничного вывода.

Имя поля Обязательное Тип Описание Пример

installationDistros

Да

Список установочных дистрибутивов. Включает параметр: InstallationDistrosResponse

meta

Да

Метаданные постраничного вывода

InstallationDistroPreview

Предпросмотр установочного дистрибутива.

Имя поля Обязательное Тип Описание Пример

installationDistroId

Да

string($uuid)

Уникальный внутренний идентификатор установочного дистрибутива

e750fe40-5902-4e4d-9fd2-b587139946f4

name

Да

string

Наименование установочного дистрибутива

debian-bookworm-x86-84

repositoryUrl

Да

string

URL репозитория, где размещается установочный дистрибутив

http://mirror.centos.org/centos-7/7/os/x86_64/

kernel

Да

string

Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС

images/pxeboot/vmlinuz

initrd

Да

string

Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы

images/pxeboot/initrd.img

InstallationDistroResponse

Атрибуты установочного дистрибутива.

Имя поля Обязательное Тип Описание Пример

installationDistroId

Да

string($uuid)

Уникальный внутренний идентификатор установочного дистрибутива

e750fe40-5902-4e4d-9fd2-b587139946f4

name

Да

string

Наименование установочного дистрибутива

debian-bookworm-x86-84

description

Нет

string

Описание установочного дистрибутива, комментарии

Description or commentary

repositoryUrl

Да

string

URL репозитория, где размещается установочный дистрибутив

http://mirror.centos.org/centos-7/7/os/x86_64/

kernel

Да

string

Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС

images/pxeboot/vmlinuz

initrd

Да

string

Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы

images/pxeboot/initrd.img

osFamily

Да

Семейство ОС. Включает параметр OsFamily

architecture

Да

Архитектура процессора. Включает параметр Architecture

osVersion

Да

string

Версия ОС

20.04.6

createdAt

Да

string($date-time)

Дата и время создания установочного дистрибутива

2024-03-18T14:53:08.865312Z

createdBy

Да

string

Пользователь, создавший установочный дистрибутив

vivanov@domain.local

updatedAt

Нет

string($date-time)

Дата и время последнего изменения установочного дистрибутива

2024-03-18T14:53:08.865312Z

updatedBy

Нет

string

Пользователь, совершивший последнее изменение установочного дистрибутива

vivanov@domain.local

InstallationDistrosSearchRequest

Параметры для поиска установочных дистрибутивов.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Наименование установочного дистрибутива (мин. длина: 3; макс. длина: 255)

Astra Linux

osFamilyIds

Нет

string

Список идентификаторов семейств ОС

0201b593-59ef-4eec-9ed9-00376b6637f0

architectureIds

Нет

string

Список идентификаторов архитектур процессора

45a93cd5-0922-4014-a45e-f8281b176447

osVersion

Нет

string

Версия ОС (мин. длина: 3; макс. длина: 255)

20.04.6

InstallationDistroUpdateRequest

Список установочных дистрибутивов с метаданными постраничного вывода.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование установочного дистрибутива (мин. длина: 1)

debian-bookworm-x86-84

description

Нет

string

Описание установочного дистрибутива, комментарии

Description or commentary

repositoryUrl

Да

string

URL репозитория, где размещается установочный дистрибутив (мин. длина: 1)

`http://mirror.centos.org/centos-7/7/os/x86_64/`

kernel

Да

string

Путь и имя файла внутри репозитория с указанным URL, в котором содержится ядро ОС (мин. длина: 1)

images/pxeboot/vmlinuz

initrd

Да

string

Путь и имя файла внутри репозитория с указанным URL, содержащего образ временной корневой системы (мин. длина: 1)

images/pxeboot/initrd.img

osFamilyId

Да

string

Идентификатор семейства ОС, к которому принадлежит создаваемый установочный дистрибутив (мин. длина: 1)

debian

architectureId

Да

string

Идентификатор семейства ОС, к которому принадлежит создаваемый установочный дистрибутив (мин. длина: 1)

x86_64

osVersion

Да

string

Версия ОС (мин. длина: 1)

20.04.6

InstallationProfileCreateRequest

Параметры для создания профиля установки.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование профиля установки (мин. длина: 1)

Installation profile name example

description

Нет

string

Описание профиля установки, комментарии

Description or commentary

installationDistroId

Да

string($uuid)

Идентификатор установочного дистрибутива

kernelOptions

Нет

string

Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1)

netcfg/choose_interface=auto

provisioningMethodIds

Да

string

Список идентификаторов поддерживаемых методов установки ОС (мин. длина: 1)

pxe

postInstallTemplateIds

Нет

string($uuid)

Список идентификаторов шаблонов скриптов пост-установки

bbd48136-54ad-469b-9409-e2276ab2a7ee

autoinstallTemplateId

Да

string($uuid)

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

2806b75f-1b46-4529-b978-84c713b09dbf

InstallationProfilePagedResponse

Список профилей установки с метаданными постраничного вывода.

Имя поля Обязательное Тип Описание Пример

installationProfiles

Да

Список установочных дистрибутивов. Включает параметр: InstallationProfileResponse

meta

Да

Метаданные постраничного вывода

InstallationProfilePreview

Предпросмотр профиля установки.

Имя поля Обязательное Тип Описание Пример

installationProfileId

Да

string($uuid)

Уникальный внутренний идентификатор профиля установки

a480re55-9988-7a7d-9fd2-b587139946f5

name

Да

string

Наименование профиля установки

Installation profile

InstallationProfileResponse

Атрибуты профиля установки.

Имя поля Обязательное Тип Описание Пример

installationProfileId

Да

string($uuid)

Уникальный внутренний идентификатор профиля установки

4371c2ca-5f3d-46cc-959a-a4daa8581434

name

Да

string

Наименование профиля установки

Installation profile name example

description

Нет

string

Описание профиля установки, комментарии

Description or commentary

installationDistro

Да

Предпросмотр установочного дистрибутива. Включает параметр InstallationDistroPreview

kernelOptions

Нет

string

Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1)

netcfg/choose_interface=auto

provisioningMethodIds

Да

Список поддерживаемых методов установки ОС. Включает параметр ProvisioningMethod

postInstallTemplates

Нет

Список шаблонов скриптов пост-установки. Включает параметр TemplatePreview

autoinstallTemplate

Да

Предпросмотр шаблона. Включает параметр TemplatePreview

createdAt

Да

string($date-time)

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

2024-03-18T14:53:08.865312Z

createdBy

Да

string

Пользователь, создавший создавший профиль установки

vivanov@domain.local

updatedAt

Нет

string($date-time)

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

2024-03-18T14:53:08.865312Z

updatedBy

Нет

string

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

vivanov@domain.local

InstallationProfileSearchRequest

Параметры для поиска профилей установки.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Наименование профиля установки (мин. длина: 3; макс. длина: 255)

installationProfileNameExample

installationDistroIds

Нет

string($uuid)

Список идентификаторов установочных дистрибутивов

provisioningMethodIds

Нет

string

Список идентификаторов методов установки ОС (мин. длина: 1)

pxe

InstallationProfileUpdateRequest

Параметры для изменения профиля установки.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование профиля установки (мин. длина: 1)

Installation profile name example

description

Нет

string

Описание профиля установки, комментарии

Description or commentary

installationDistroId

Да

string($uuid)

Идентификатор установочного дистрибутива

kernelOptions

Нет

string

Список дополнительных опций, с которыми будет запускаться ядро из установочного дистрибутива (мин. длина: 1)

netcfg/choose_interface=auto

provisioningMethodIds

Да

string

Список поддерживаемых методов установки ОС (мин. длина: 1)

pxe

postInstallTemplateIds

Нет

string($uuid)

Список идентификаторов шаблонов скриптов пост-установки

bbd48136-54ad-469b-9409-e2276ab2a7ee

autoinstallTemplateId

Да

string($uuid)

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

2806b75f-1b46-4529-b978-84c713b09dbf

InstallationRecipeCreateRequest

Параметры для создания способа развертывания.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование способа развертывания (мин. длина: 1)

Пример имени развёртывания

description

Нет

string

Описание способа развертывания, комментарии

Пример комментария к развёртыванию

installationProfileId

Да

string($uuid)

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

e120fe40-1102-4e4d-9fd2-b587139946f5

provisioningMethodId

Да

string

Идентификатор метода установки, по которому производится установка ОС на устройства (мин. длина: 1)

e120fe40-1102-4e4d-9fd2-b587139946f5

configurationId

Нет

integer($int64)

Идентификатор конфигурации, на которую производится установка ОС

101

configurationVersionId

Нет

integer($int64)

Версия конфигурации, на которую производится установка ОС

102

deploymentModeId

Да

string

Идентификатор режима развертывания ОС (мин. длина: 1)

installation

rootHashPassword

Нет

string

Хеш пароля суперпользователя (мин. длина: 1)

8743b52063cd84097a65d1633f5c74f5

hashAlgorithm

Нет

string

Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: HashAlgorithm

MD5

isCreateUser

Нет

boolean

Признак необходимости создания локального пользователя

false

userAccount

Нет

Данные локального пользователя. Включает параметр: UserAccount

domainName

Нет

string

Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1)

inno.local

InstallationRecipePagedResponse

Список профилей установки с метаданными постраничного вывода.

Имя поля Обязательное Тип Описание Пример

installationProfiles

Да

Список установочных дистрибутивов. Включает параметр: InstallationProfileResponse

meta

Да

Метаданные постраничного вывода

InstallationRecipePreview

Предпросмотр способа развертывания.

Имя поля Обязательное Тип Описание Пример

installationRecipeId

Да

string($uuid)

Уникальный внутренний идентификатор способа развертывания

a7e0ab48-f954-48c9-89bb-7f343ccb60e2

name

Да

string

Наименование способа развертывания

План развертывания Astra

InstallationRecipeResponse

Атрибуты способа развертывания.

Имя поля Обязательное Тип Описание Пример

installationRecipeId

Да

string($uuid)

Уникальный внутренний идентификатор способа развертывания

a550fe40-1102-4e4d-9fd2-b587131246f5

name

Да

string

Наименование способа развертывания

Пример имени развёртывания

description

Нет

string

Описание способа развертывания, комментарии

Installation recipe description

installationProfile

Да

Предпросмотр профиля установки. Включает параметр InstallationProfilePreview

provisioningMethodIds

Да

Список поддерживаемых методов установки ОС. Включает параметр ProvisioningMethod

configurationId

Нет

integer($int64)

Идентификатор конфигурации, на которую производится установка ОС

101

configurationVersionId

Нет

integer($int64)

Версия конфигурации, на которую производится установка ОС

102

deploymentModeId

Да

string

Режим развертывания ОС, например, установка с нуля или переустановка. Включает параметр: DeploymentMode

installation

rootHashPassword

Нет

string

Хеш пароля суперпользователя

8743b52063cd84097a65d1633f5c74f5

hashAlgorithm

Нет

string

Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: HashAlgorithm

MD5

isCreateUser

Нет

boolean

Признак необходимости создания локального пользователя

false

userAccount

Нет

Данные локального пользователя. Включает параметр: UserAccount

domainName

Нет

string

Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1)

inno.local

createdAt

Да

string($date-time)

Дата и время создания способа развертывания

2024-03-18T14:53:08.865312Z

createdBy

Да

string

Пользователь, создавший план развертывания

vivanov@domain.local

updatedAt

Нет

string($date-time)

Дата и время последнего изменения способа развертывания

2024-03-18T14:53:08.865312Z

updatedBy

Нет

string

Пользователь, совершивший последнее изменение способа развертывания

vivanov@domain.local

InstallationRecipeSearchRequest

Параметры для поиска способа развертывания.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Наименование способа развертывания, контекстный поиск (мин. длина: 3; макс. длина: 255)

installationRecipeNameExample

installationProfileIds

Нет

string($uuid)

Список идентификаторов профилей установки

018fc943-f767-76aa-a340-2e7015bd90e3

provisioningMethodIds

Нет

string

Список идентификаторов методов установки ОС (мин. длина: 1)

bootdisknetinst

deploymentModeIds

Нет

string

Список идентификаторов режимов развертывания ОС (мин. длина: 1)

installation

configurationIds

Нет

integer($int64)

Список идентификаторов конфигураций

101

InstallationRecipeUpdateRequest

Параметры для изменения способа развертывания.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование способа развертывания (мин. длина: 1)

Пример имени развёртывания

description

Нет

string

Описание способа развертывания, комментарии

Пример комментария к развёртыванию

installationProfileId

Да

string($uuid)

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

e120fe40-1102-4e4d-9fd2-b587139946f5

provisioningMethodId

Да

Идентификатор метода установки, по которому будет производиться установка ОС на устройства (мин. длина: 1)

bootdisknetinst

configurationId

Нет

integer($int64)

Идентификатор конфигурации, на которую производится установка ОС

101

configurationVersionId

Нет

integer($int64)

Версия конфигурации, на которую производится установка ОС

102

deploymentModeId

Да

string

Режим развертывания ОС, например, установка с нуля или переустановка

installation

rootHashPassword

Нет

string

Хеш пароля суперпользователя

8743b52063cd84097a65d1633f5c74f5

hashAlgorithm

Нет

string

Поддерживаемые алгоритмы хеширования (MD5, SHA512). Включает параметр: HashAlgorithm

MD5

isCreateUser

Нет

boolean

Признак необходимости создания локального пользователя

false

userAccount

Нет

Данные локального пользователя. Включает параметр: UserAccount

domainName

Нет

string

Имя домена по умолчанию; используется, если для устройства не указан домен (мин. длина: 1)

inno.local

OsFamily

Семейство ОС.

Имя поля Обязательное Тип Описание Пример

osFamilyId

Да

string

Уникальный внутренний идентификатор семейства ОС

redhat

name

Да

string

Наименование семейства ОС

Red Hat

PermissionAction

Действие над объектом.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Код действия, уникальный в рамках одного объекта (мин. длина: 3; макс. длина: 256)

view

allowed

Да

boolean

Признак разрешения действия для данной роли

RolePermission

Разрешение роли.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Уникальный код объекта

configurations

actions

Да

Разрешение роли. Включает параметр PermissionAction

ProvisioningMethod

Метод установки ОС, определяющий, каким образом будет производиться установка, например, полностью по сети с использованием технологии PXE или с автономного носителя.

Имя поля Обязательное Тип Описание Пример

provisioningMethodId

Да

string

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

bootdisknetinst

name

Да

string

Наименование метода установки

Boot disk and network

TemplateCategory

Категория шаблона.

Имя поля Обязательное Тип Описание Пример

templateCategoryId

Да

string

Уникальный внутренний идентификатор категории шаблона

autoinstall

name

Да

string

Наименование категории шаблона

Файл ответов

TemplateCreateRequest

Параметры для создания шаблона.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование шаблона (мин. длина: 1)

debian-bookworm-x86-84 preseed file

templateSlug

Да

string

Уникальное системное наименование шаблона (мин. длина: 1; шаблон: ^[A-Za-z-_0-9]*$)

TEMPLATE-unique_name1

description

Нет

string

Описание шаблона, комментарии

Description or commentary

osFamilyId

Нет

string

Идентификатор семейства ОС, к которому применим создаваемый шаблон (мин. длина: 1)

debian

templateCategoryId

Да

string

Идентификатор категории шаблона (мин. длина: 1)

autoinstall

bootloaderId

Нет

string

Идентификатор программы-загрузчика (мин. длина: 1)

ipxe

template

Да

string

Содержимое шаблона (мин. длина: 1)

# Preseeding only locale sets language, country and locale. d-i debian-installer/locale string ru_RU

TemplatePagedResponse

Список шаблонов с метаданными постраничного вывода.

Имя поля Обязательное Тип Описание Пример

templates

Да

Список установочных дистрибутивов. Включает параметр: TemplateResponse

meta

Да

Метаданные постраничного вывода

TemplatePreview

Предпросмотр шаблона.

Имя поля Обязательное Тип Описание Пример

templateId

Да

string($uuid)

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

a480re55-9988-7a7d-9fd2-b587139946f5

templateCategory

Да

Категория шаблона. Включает параметр TemplateCategory

name

Да

string

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

Template name

TemplateResponse

Атрибуты шаблона.

Имя поля Обязательное Тип Описание Пример

templateId

Да

string($uuid)

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

e750fe40-5902-4e4d-9fd2-b587139946f5

name

Да

string

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

debian-bookworm-x86-84 preseed file

templateSlug

Да

string

Уникальное системное наименование шаблона

TEMPLATE-unique_name1

description

Нет

string

Описание шаблона, комментарии

Description or commentary

osFamilyId

Нет

Семейство ОС. Включает параметр OsFamily

bootloader

Нет

Загрузчик. Включает параметр Bootloader

templateCategory

Да

Категория шаблона. Включает параметр TemplateCategory

template

Да

string

Содержимое шаблона

# Preseeding only locale sets language, country and locale. d-i debian-installer/locale string ru_RU

createdAt

Да

string($date-time)

Дата и время создания шаблона

2024-03-18T14:53:08.865312Z

createdBy

Да

string

Пользователь, создавший шаблон

vivanov@domain.local

updatedAt

Нет

string($date-time)

Дата и время последнего изменения шаблона

2024-03-18T14:53:08.865312Z

updatedBy

Нет

string

Пользователь, совершивший последнее изменение шаблона

vivanov@domain.local

TemplatesSearchRequest

Параметры для поиска шаблона.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Наименование шаблона (мин. длина: 3; макс. длина: 255)

preseed

osFamilyIds

Нет

string($uuid)

Список идентификаторов семейств ОС (мин. длина: 1)

debian

bootloaderIds

Нет

string

Список идентификаторов программ-загрузчиков (мин. длина: 1)

ipxe

templateCategoryIds

Нет

string

Список идентификаторов категорий шаблонов (мин. длина: 1)

autoinstall

TemplateUpdateRequest

Параметры для изменения шаблона.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Наименование шаблона (мин. длина: 1)

debian-bookworm-x86-84 preseed file

templateSlug

Да

string

Уникальное системное наименование шаблона (мин. длина: 1; шаблон: ^[A-Za-z-_0-9]*$)

TEMPLATE-unique_name1

description

Нет

string

Описание шаблона, комментарии

Description or commentary

osFamilyId

Нет

string

Идентификатор семейства операционных систем, к которому применим создаваемый шаблон (мин. длина: 1)

debian

templateCategoryId

Да

string

Идентификатор категории шаблона (мин. длина: 1)

autoinstall

bootloaderId

Нет

string

Идентификатор программы-загрузчика (мин. длина: 1)

ipxe

template

Да

string

Содержимое шаблона (мин. длина: 1)

# Preseeding only locale sets language, country and locale. d-i debian-installer/locale string ru_RU

UserAccount

Данные локального пользователя.

Имя поля Обязательное Тип Описание Пример

userFullName

Да

string

Полное имя пользователя (мин. длина: 1)

Ivanov Ivan Ivanovich

userName

Да

string

Имя пользователя (мин. длина: 1)

Ivan

userHashPassword

Да

string

Хеш пароля пользователя (мин. длина: 1)

5f4dcc3b5aa765d61d8327deb882cf99

UserAllowedPermissionsResponse

Разрешенные назначения конкретного пользователя.

Имя поля Обязательное Тип Описание Пример

expiresIn

Да

integer

Время в секундах, через которое информация о назначениях становится неактуальной

60

permissions

Да

Разрешение роли. Включает параметр AllowedRolePermission

UserPermissionsResponse

Назначения пользователя.

Имя поля Обязательное Тип Описание Пример

expiresIn

Да

integer

Время в секундах, через которое информация о назначениях становится неактуальной

60

permissions

Да

Разрешение роли. Включает параметр RolePermission