Updated 07.2 Resource функция decort_kvmvm: управление виртуальными машинами на базе KVM. (markdown)
@@ -3,20 +3,20 @@ _Resource_ функция **decort_kvmvm** служит для управлен
|
|||||||
## Аргументы
|
## Аргументы
|
||||||
_Resource_ функция **decort_kvmvm** принимает следующие аргументы:
|
_Resource_ функция **decort_kvmvm** принимает следующие аргументы:
|
||||||
|
|
||||||
| Аргумент | Тип | Описание |
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| driver | string | Обязательный параметр, не пустой.<br/>Аппаратная архитектура виртуальной машины.<br/>Может принимать одно из следующих значений:<br/> * "KVM_X86" - виртуальная машина KVM на аппаратной платформе x86.<br/> * "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. |
|
| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.<br/>Может принимать одно из следующих значений:<br/> * "KVM_X86" - виртуальная машина KVM на аппаратной платформе x86.<br/> * "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. |
|
||||||
| cpu | int | Обязательный параметр, не равен 0.<br/>Количество процессоров. |
|
| cpu | int | :heavy_check_mark: | Количество процессоров. |
|
||||||
| name | string | Обязательный параметр, не пустой.<br/>Имя виртуальной машины. Обратите внимание, что имя должно быть уникальным в рамках ресурсной группы. |
|
| name | string | :heavy_check_mark: | Имя виртуальной машины. Обратите внимание, что имя должно быть уникальным в рамках ресурсной группы. |
|
||||||
| rg_id | int | Обязательный параметр, не равен 0.<br/>Идентификатор ресурсной группы, которой принадлежит данная виртуальная машина. |
|
| rg_id | int | Обязательный параметр, не равен 0.<br/>Идентификатор ресурсной группы, которой принадлежит данная виртуальная машина. |
|
||||||
| ram | int | Обязательный параметр, не равен 0.<br/>Объём оперативной памяти в МБ.<br/> |
|
| ram | int | :heavy_check_mark: | Объём оперативной памяти в МБ.<br/> |
|
||||||
| image_id | int | Обязательный параметр, не равен 0.<br/>Идентификатор образа, на базе которого создаётся загрузочный диск виртуальной машины.<br/> |
|
| image_id | int | :heavy_check_mark: | Идентификатор образа, на базе которого создаётся загрузочный диск виртуальной машины.<br/> |
|
||||||
| boot_disk_size | int | Обязательный параметр.<br/>Размер загрузочного диска виртуальной машины в ГБ. |
|
| boot_disk_size | int | :heavy_check_mark: | Размер загрузочного диска виртуальной машины в ГБ. |
|
||||||
| extra_disks | []int | Опциональный параметр.<br/>Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. |
|
| extra_disks | []int | :x: | Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. |
|
||||||
| cloud_init | string | Опциональный параметр,<br/>используется на этапе создания вм.<br/>Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. |
|
| cloud_init | string | :x: | Используется на этапе создания вм.<br/>Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. |
|
||||||
| network | dict | Опциональный параметр.<br/>Параметры сетевого подключения. Структура словаря:<br/> * (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины.<br/>Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение. |
|
| network | dict | :x: | Параметры сетевого подключения. Структура словаря:<br/> * (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины.<br/>Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение. |
|
||||||
| description | string | Опциональный параметр.<br/>Текстовое описание виртуальной машины. |
|
| description | string | :x: | Текстовое описание виртуальной машины. |
|
||||||
| started | bool | Опциональный параметр, флаг запуска машины,<br/>по-умолчанию - true.<br/>Если true - машина включена,<br/>если false - выключена. |
|
| started | bool | :x: | Флаг запуска машины,<br/>по-умолчанию - true.<br/>Если true - машина включена,<br/>если false - выключена. |
|
||||||
|
|
||||||
## Возвращаемые значения
|
## Возвращаемые значения
|
||||||
В случае успешного выполнения _resource_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения:
|
В случае успешного выполнения _resource_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения:
|
||||||
|
|||||||
Reference in New Issue
Block a user