diff --git a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md index fbdb7db..2f9da72 100644 --- a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md +++ b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md @@ -118,7 +118,7 @@ _Data source_ функция **decort_kvmvm** принимает следующ ### Описание структуры disks | Параметр | Тип | Описание | | --- | --- | --- | -| \_ckey | string | ckey | +| _ckey | string | ckey | | acl | string | Acces Control List | | account_id | int | ID аккаунта | | boot_partition | int | Загрузочный раздел | diff --git a/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md b/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md index 45273ba..884dccc 100644 --- a/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md +++ b/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md @@ -45,15 +45,15 @@ _Data source_ функция **decort_disk_list_deleted** принимает с | purge_time | int | Время удаления | | res_id | string | Идентификатор ресурса | | res_name | string | Наименование ресурсов | -| role | string | Роль диска +| role | string | Роль диска | | sep_id | int | id sep | | sep_type | string | Тип sep | | size_max | int | Максимальный размер диска | | shareable | bool | Разрешено ли делиться диском | | snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Информация о снимках состояний диска
guid снимка
Наименование снимка
id ресурса снимка
Установленный guid снимка
Установленное время снимка
Время снимка
 
| -| status | string | Статус диска +| status | string | Статус диска | | tech_status | string | Технический статус диска | -| type | string | Тип диска +| type | string | Тип диска | | vmid | int | id виртуальной машины | ## Пример использования diff --git a/06.01.72-Data-функция-decort_rg_usage-информация-об-использовании-rg.md b/06.01.72-Data-функция-decort_rg_usage-информация-об-использовании-rg.md index 65496df..debff79 100644 --- a/06.01.72-Data-функция-decort_rg_usage-информация-об-использовании-rg.md +++ b/06.01.72-Data-функция-decort_rg_usage-информация-об-использовании-rg.md @@ -7,10 +7,10 @@ _Data source_ функция **decort_rg_usage** служит для получ ## Аргументы _Data source_ функция **decort_rg_usage** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | -| reason | :x: | string | Причина вызова | +| Аргумент | Тип | Обязательный | Описание | +| --- |--------|---------------------|--------------------------------| +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| reason | string | :x: | Причина вызова | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. diff --git a/06.02.01-Data-функция-decort_cb_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.02.01-Data-функция-decort_cb_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md new file mode 100644 index 0000000..e209622 --- /dev/null +++ b/06.02.01-Data-функция-decort_cb_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md @@ -0,0 +1,262 @@ +Функция доступна в версии провайдера 3.0 и выше. + +_Data source_ функция **decort_cb_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM. + +## Аргументы +_Data source_ функция **decort_cb_kvmvm** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| compute_id | int | :heavy_check_mark:| Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). | +| reason | string | :x: | Причина вызова | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| anti_affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила анти аффинити для компьютов | +| arch | string | Архитектура | +| boot_order | []string | Boot order | +|cd_image_id| int | cd image id | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | +| computeci_id | int | ID вычислительного ресурса | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кем создан _compute_ | +| created_time | int | Время создания _compute_ | +| custom_fields | string | Кастомные поля | +| deleted_by | string | Кем удален _compute_ | +| deleted_time | int | Время удаления _compute_ | +| desc | string | Текстовое описание виртуальной машины. | +| devices | string | Девайсы | +| disks | []Struct [см. ниже](#описание-структуры-disks) | информация о дисках компьюта | +| driver | string | Аппаратная архитектура данной виртуальной машины. | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| interfaces | []Struct [см. ниже](#описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | +| name | string | Имя компьюта | +| need_reboot | bool | Флаг перезапуска | +| os_users | []Struct [см. ниже](#описание-структуры-os-users) | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. | +| pinned | bool | добавлен ли компьют на стек | +| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID ссылки | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Наименование ресурса | +| rg_id | int | Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | +| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| snap_sets | []Struct [см. ниже](#описание-структуры-snap-sets) | Snap sets | +| stack_id | int | id стэка | +| stack_name | string | Название стэка | +| stateless_sep_id | int | ID сеп | +| stateless_sep_type | string | Тип сеп | +| status | string | Статус компьюта | +| tags | []Struct [см. ниже](#описание-структуры-tags) | Тэги | +| tech_status | string | Технический статус компьюта в составе группы | +| updated_by | string | Кем компьют был обновлен | +| updated_time | int | Время последнего обновления | +|user_data| string | Данные пользователя | +| user_managed | bool | Флаг, показывает управление пользователем вычислительной мощностью | +| vgpus | []int | Список vgpu | +| virtual_image_id | int | ID виртуального образа | +| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | +| boot_disk_size | int | Размер загрузочного диска в ГБ. | +| sep_id | int | ID sep | +| pool | string | Pool | +| extra_disks | []int | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. | +| network | []Struct [см. ниже](#описание-структуры-network) | Характеристики сетевых сегментов, к которым подключен данный сервер. | + +### Описание структуры network +| Параметр | Тип | Описание | +| --- | --- | --- | +| net_id | int | ID сети | +| net_type | string | Тип сети | +| ip_address | string | IP адрес | +| mac | string | MAC адрес | + +### Описание структуры os users +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | GUID | +| login | string | Логин | +| password | string | Пароль | +| public_key | string | Публичный ssh ключ | + +### Описание структуры tags +| Параметр | Тип | Описание | +| --- | --- | --- | +| key | string | Ключ тэга | +| val | string | Значение тэга | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +### Описание структуры disks +| Параметр | Тип | Описание | +| --- | --- | --- | +| ckey | string | ckey | +| meta | []string | Мета информация | +| account_id | int | ID аккаунта | +| boot_partition | int | Загрузочный раздел | +| created_time | int | Время создания диска | +| deleted_time | int | Время удаления диска | +| desc | string | Описание | +| destruction_time | int | Время удаления | +| disk_path | string | Путь диска | +| gid | int | GID | +| guid | int | GUID | +| disk_id | int | ID диска | +| image_id | int | ID образа | +| images | []int | Список образов | +| iotune | []Struct [см. ниже](#описание-структуры-iotune)| Ограничения диска | +| iqn | string | iqn диска | +| login | string | Логин для доступа к диску | +| milestones | int | Вехи | +| name | string | Наименование диска | +| order | int | Номер диска | +| params | string | Параметры диска | +| parent_id | int | id родительского диска | +| passwd | string | Пароль для доступа к диску | +| pci_slot | int | id pci слота, к которому подключен диск | +| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | +| present_to | []int | Список ID ресурсов, которым предоставлен диск | +| purge_attempts | int | Кол-во попыток удаления | +| purge_time | int | Время последней попытки | +| reality_device_number | int | Реальный номер устройства | +| reference_id | string | ID ссылки | +| res_id | int | id ресурса | +| res_name | string | Наименование ресурсов | +| role | string | Роль диска | +| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| shareable | bool | Флаг, отвечающий за доступность диска дургим ресурсам | +| size_max | int | Размер диска в ГБ | +| size_used | float | Кол-во используемого места, в ГБ | +| snapshots | []Struct{}[см. ниже](#описание-структуры-snapshots)| Снимки состояния диска| +| status | string | Статус диска | +| tech_status | string | Технический статус диска | +| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | +| vmid | int | Идентификатор виртуальной машины (устаревшее) | + +### Описание структуры iotune +| Параметр | Тип | Описание | +| --- | --- | --- | +| read_bytes_sec | int | Кол-во байт для чтения в секунду | +| read_bytes_sec_max | int | Максимальное кол-во байт для чтения | +| read_iops_sec | int | Кол-во операций чтения io в секунду | | +| read_iops_sec_max | int | Максимальное число io операций чтения | +| size_iops_sec | int | Размер io операций | +| total_bytes_sec | int | Общий размер байт в секунду | +| total_bytes_sec_max | int | Максимальный общий размер байт в секунду | +| total_iops_sec | int | Общее кол-во io операций в секунду | +| total_iops_sec_max | int | Максимальное общее кол-во io операций в секунду | +| write_bytes_sec | int | Кол-во байт для записи в секунду | +| write_bytes_sec_max | int | Максимальное кол-во байт для записи в секунду | +| write_iops_sec | int | Кол-во операций записи в секунду | +| write_iops_sec_max | int | Максимальное число операций записей | + +### Описание структуры snapshots +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | id снимка | +| label | string | Наименование снимка | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | Установленный id снимка | +| snap_set_time | int | Установленное время снимка | +| timestamp | int | Время снимка | + +## Пример использования +В нижеприведённом примере посредством вызова _data source_ функции **decort_cb_kvmvm** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками: + +```terraform +data "decort_cb_kvmvm" "existing_vm" { + # id виртуальной машины + # обязательный параметр + # тип - число + compute_id = 11346 + + # прична запроса + # опциональный параметр + # тип - строка + #reason = "test" +} +# Once the above directive completes, VM ID will be accessible +# as data.decort_cb_kvmvm.existing_vm.id +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +После успешного завершения такого вызова **decort_cb_kvmvm** в переменной `data.decort_cb_kvmvm.existing_vm` будут сохранены возвращаемые значения. Так, например: +* пароль для доступа в гостевую ОС, назначенный по умолчанию при создании VM - `"data.decort_cb_kvmvm.existing_vm.os_users.0.password` +* идентификатор образа ОС, на базе которого была создана данная VM - `data.decort_cb_kvmvm.existing_vm.image_id` +* текущий объём ОЗУ - `data.decort_cb_kvmvm.existing_vm.ram` diff --git a/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md deleted file mode 100644 index ee84a18..0000000 --- a/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md +++ /dev/null @@ -1,65 +0,0 @@ -Функция доступна в версии провайдера 3.0 и выше. - -_Data source_ функция **decort_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM. - -## Аргументы -_Data source_ функция **decort_kvmvm** принимает следующие аргументы: - -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| name | string | :x: | Имя виртуальной машины. Для идентификации виртуальной машины по её имени также необходимо указать идентификатор ресурсной группы, которой она принадлежит (`rg_id`).
Обратите внимание, что имя виртуальной машины уникально только в рамках одной и той же ресурсной группы и не может быть пустым.
Альтернативным способом идентификации виртуальной машины является задание параметра `compute_id`. | -| rg_id | int | :x: | Идентификатор ресурсной группы, которой принадлежит данный виртуальный сервер.
Данный аргумент является обязательным, если идентификация виртуальной машины выполняется по её имени. | -| compute_id | int | :x: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. | - -Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа. - -Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | -| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | -| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | -| boot_disk_size | int | Размер загрузочного диска в ГБ. | -| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | -| cloud_init | string | Параметры cloud_init | -| cpu | int | Количество виртуальных CPU, выделенных данному серверу. | -| description | string | Текстовое описание виртуальной машины. | -| driver | string | Аппаратная архитектура данной виртуальной машины. | -| extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. | -| id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. | -| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| name | string | Имя виртуального сервера.
Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. | -| network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:
* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.
* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`
* (string) `ip_address` - IP адрес, выделенный данному подключению.
* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. | -| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:
* (string) `login` - учётная запись в гостевой ОС.
* (string) `password` - пароль к этой учётной записи. | -| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | -| rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | -| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | - - -## Пример использования -В нижеприведённом примере посредством вызова _data source_ функции **decort_kvmvm** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками: -* Имя сервера _MyOldVM_; -* Идентификатор ресурсной группы, в которой находится данный сервер - 123. - -```terraform -data "decort_kvmvm" "existing_vm" { - name = "MyOldVM" # this is the name of pre-existing virtual machine - rg_id = 123 # this is the ID of resource group, where VM named "MyOldVM" is found -} -# Once the above directive completes, VM ID will be accessible -# as data.decort_kvmvm.existing_vm.id -``` - -Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). - -Чтобы получить идентификатор ресурсной группы (аргумент `rg_id`), можно воспользоваться _data source_ функцией [decort_resgroup](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.1-Data-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D1%8F-decs_resgroup:-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%B8-%D0%BE-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BD%D0%BE%D0%B9-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B5.). - -После успешного завершения такого вызова **decort_kvmvm** в переменной `data.decort_kvmvm.existing_vm` будут сохранены возвращаемые значения. Так, например: -* пароль для доступа в гостевую ОС, назначенный по умолчанию при создании VM - `"data.decort_kvmvm.existing_vm.os_users.0.password` -* идентификатор образа ОС, на базе которого была создана данная VM - `data.decort_kvmvm.existing_vm.image_id` -* текущий объём ОЗУ - `data.decort_kvmvm.existing_vm.ram` diff --git a/06.02.82-Data-функция-decort_cb_kvmvm_affinity_relations-получение-словаря-ВМ-разделенного-по-правилам-affinity-и-anti-affinity.md b/06.02.82-Data-функция-decort_cb_kvmvm_affinity_relations-получение-словаря-ВМ-разделенного-по-правилам-affinity-и-anti-affinity.md new file mode 100644 index 0000000..727f143 --- /dev/null +++ b/06.02.82-Data-функция-decort_cb_kvmvm_affinity_relations-получение-словаря-ВМ-разделенного-по-правилам-affinity-и-anti-affinity.md @@ -0,0 +1,45 @@ +Функция доступна в версии провайдера 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_affinity_relations** служит для получения словаря ВМ разделенного по правилам affinity и anti-affinity. + +## Аргументы +_Data source_ функция **decort_cb_kvmvm_affinity_relations** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| compute_id | int | :heavy_check_mark:| Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_affinity_relations** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- |----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| compute_id | int | ID виртуальной машины | +| other_node | []string | Спсиок other node | +| other_node_indirect | []string | Список other node indirect | +| other_node_indirect_soft | []string | Список other node indirect soft | +| other_node_soft | []string | Список other node soft| +| same_node | []string | Список same node| +| same_node_soft | []string | Список same node soft| + +## Пример использования +В нижеприведённом примере посредством вызова _data source_ функции **decort_cb_kvmvm_affinity_relations** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками: + +```terraform +data "decort_cb_kvmvm_affinity_relations" "relations" { + # id виртуальной машины + # обязательный параметр + # тип - число + compute_id = 11346 +} +# Once the above directive completes, VM affinity relations will be accessible +# as data.decort_cb_kvmvm_affinity_relations.relations +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +После успешного завершения такого вызова **decort_cb_kvmvm_affinity_relations** в переменной `data.decort_cb_kvmvm_affinity_relations.relations` будут сохранены возвращаемые значения. diff --git a/06.02.83-Data-функция-decort_cb_kvmvm_audits-получения-информации-о-аудитах-компьюта.md b/06.02.83-Data-функция-decort_cb_kvmvm_audits-получения-информации-о-аудитах-компьюта.md new file mode 100644 index 0000000..4b7f996 --- /dev/null +++ b/06.02.83-Data-функция-decort_cb_kvmvm_audits-получения-информации-о-аудитах-компьюта.md @@ -0,0 +1,33 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_audits** служит для получения аудитов компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_audits** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_audits** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| call | string | Какая команда была выполнена | +| responsetime | float | Время выполнения | +| statuscode | int | Статус выполнения | +| timestamp | float | Точное время исполнения | +| user | string | Кем была выполнена команда | + +## Пример использования +```terraform +data "decort_cb_kvmvm_audits" "kvmvm_audits" { + compute_id = 10154 +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_audits** в переменной `data.decort_cb_kvmvm_audits.kvmvm_audits` будут сохранены возвращаемые значения. diff --git a/06.02.84-Data-функция-decort_cb_kvmvm_boot_order_get-получение-информации-о-текущем-порядке-загрузки-компьюта.md b/06.02.84-Data-функция-decort_cb_kvmvm_boot_order_get-получение-информации-о-текущем-порядке-загрузки-компьюта.md new file mode 100644 index 0000000..8a46378 --- /dev/null +++ b/06.02.84-Data-функция-decort_cb_kvmvm_boot_order_get-получение-информации-о-текущем-порядке-загрузки-компьюта.md @@ -0,0 +1,29 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_boot_order_get** служит для получения информации о текущем порядке загрузки компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_boot_order_get** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_boot_order_get** возвращает в указанную при вызове переменную следующий параметр: + +| Параметр | Тип | Описание | +| --- |----------|----------------------------| +| boot_order | []string | Порядок загрузки | + +## Пример использования +```terraform +data "decort_cb_kvmvm_boot_order_get" "order" { + compute_id = 10154 +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_boot_order_get** в переменной `data.decort_cb_kvmvm_boot_order_get.order` будут сохранены возвращаемые значения. diff --git a/06.02.85-Data-функция-decort_cb_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md b/06.02.85-Data-функция-decort_cb_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md new file mode 100644 index 0000000..d136fe4 --- /dev/null +++ b/06.02.85-Data-функция-decort_cb_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md @@ -0,0 +1,32 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_cb_kvmvm_get_audits** служит для получения аудитов компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_get_audits** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | +| reason | string | :x: | Причина вызова | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_get_audits** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| epoch | float | Время | +| message | string | Сообщение, которое несет в себе информацию о команде и том, кто ее исполнил | + +## Пример использования +```terraform +data "decort_cb_kvmvm_get_audits" "kvmvm_get_audits" { + compute_id = 10154 + #reason = "test" +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_get_audits** в переменной `data.decort_cb_kvmvm_get_audits.kvmvm_get_audits` будут сохранены возвращаемые значения. diff --git a/06.02.86-Data-функция-decort_cb_kvmvm_get_console_url-получение-url-консоли-компьюта.md b/06.02.86-Data-функция-decort_cb_kvmvm_get_console_url-получение-url-консоли-компьюта.md new file mode 100644 index 0000000..0bb11d6 --- /dev/null +++ b/06.02.86-Data-функция-decort_cb_kvmvm_get_console_url-получение-url-консоли-компьюта.md @@ -0,0 +1,29 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_get_console_url** служит для получения url консоли компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_get_console_url** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_get_console_url** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| console_url | string | url консоли компьюта | + +## Пример использования +```terraform +data "decort_cb_kvmvm_get_console_url" "console_url" { + compute_id = 10154 +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_get_console_url** в переменной `data.decort_cb_kvmvm_get_console_url.console_url` будут сохранены возвращаемые значения. diff --git a/06.02.87-Data-функция-decort_cb_kvmvm_get_log-получение-логов-по-заданному-пути.md b/06.02.87-Data-функция-decort_cb_kvmvm_get_log-получение-логов-по-заданному-пути.md new file mode 100644 index 0000000..f24742d --- /dev/null +++ b/06.02.87-Data-функция-decort_cb_kvmvm_get_log-получение-логов-по-заданному-пути.md @@ -0,0 +1,31 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_get_log** служит для получения логов по заданному пути компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_get_log** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | +| path | string | :heavy_check_mark: | путь до файла | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_get_log** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| log | string | логи | + +## Пример использования +```terraform +data "decort_cb_kvmvm_get_log" "get_log" { + compute_id = 10154 + path = "/var/log/file.log" +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_get_log** в переменной `data.decort_cb_kvmvm_get_log.get_log` будут сохранены возвращаемые значения. diff --git a/06.02.88-Data-функция-decort_cb_kvmvm_list-получение-информации-о-списке-компьютов.md b/06.02.88-Data-функция-decort_cb_kvmvm_list-получение-информации-о-списке-компьютов.md new file mode 100644 index 0000000..9cee428 --- /dev/null +++ b/06.02.88-Data-функция-decort_cb_kvmvm_list-получение-информации-о-списке-компьютов.md @@ -0,0 +1,249 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_list** служит для получения информации о списке компьютов. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID ресурсной группы | +| rg_name | string | :x: | Фильтр по имени рес. группы | +| tech_status | string | :x: | Фильтр по тех.статусу | +| status | string | :x: | Фильтр по статусу | +| ip_address | string | :x: | Фильтр по IP адресу | +| extnet_name | string | :x: | Фильтр по имени внешней сети | +| extnet_id | int | :x: | Фильтр по extnet ID | +| includedeleted | bool| :x: | Включить в результат удаленные ресурсы | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | +| ignore_k8s | bool | :x: | При значении true - показать все ВМ, не относящиеся к любому из кластеров k8s | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| anti_affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила анти аффинити для компьютов | +| arch | string | Архитектура | +| boot_order | []string | Boot order | +| bootdisk_size | int | Размер загрузочного диска в ГБ. | +|cd_image_id| int | cd image id | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | +| computeci_id | int | ID вычислительного ресурса | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кем создан _compute_ | +| created_time | int | Время создания _compute_ | +| custom_fields | string | Кастомные поля | +| deleted_by | string | Кем удален _compute_ | +| deleted_time | int | Время удаления _compute_ | +| desc | string | Текстовое описание виртуальной машины. | +| devices | string | Девайсы | +| disks | []Struct [см. ниже](#описание-структуры-disks) | информация о дисках компьюта | +| driver | string | Аппаратная архитектура данной виртуальной машины. | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| interfaces | []Struct [см. ниже](#описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | +| name | string | Имя компьюта | +| need_reboot | bool | Флаг перезапуска | +| os_users | []Struct [см. ниже](#описание-структуры-os-users) | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. | +| pinned | bool | добавлен ли компьют на стек | +| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID ссылки | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Наименование ресурса | +| rg_id | int | Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | +| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| snap_sets | []Struct [см. ниже](#описание-структуры-snap-sets) | Snap sets | +| stack_id | int | id стэка | +| stateless_sep_id | int | ID сеп | +| stateless_sep_type | string | Тип сеп | +| status | string | Статус компьюта | +| tags | []Struct [см. ниже](#описание-структуры-tags) | Тэги | +| tech_status | string | Технический статус компьюта в составе группы | +| total_disk_size | int | Размер диска | +| updated_by | string | Кем компьют был обновлен | +| updated_time | int | Время последнего обновления | +|user_data| string | Данные пользователя | +| user_managed | bool | Флаг, показывает управление пользователем вычислительной мощностью | +| vgpus | []int | Список vgpu | +| vins_connected | int | Кол-во присоединенных винсов | +| virtual_image_id | int | ID виртуального образа | + +### Описание структуры os users +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | GUID | +| login | string | Логин | +| password | string | Пароль | +| public_key | string | Публичный ssh ключ | + +### Описание структуры tags +| Параметр | Тип | Описание | +| --- | --- | --- | +| key | string | Ключ тэга | +| val | string | Значение тэга | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +### Описание структуры disks +| Параметр | Тип | Описание | +| --- | --- | --- | +| disk_id | int | id диска | +| pci_slot | int | id pci слота, к которому подключен диск | + +## Пример использования +```terraform +data "decort_cb_kvmvm_list" "kvmvm_list" { + #фильтр по id ВМ + #опциональный параметр + #тип - число + #by_id = 100 + + #фильтр по имени ВМ + #опциональный параметр + #тип - строка + #name = "test" + + #id аккаунта для получения списка ВМ + #опциональный параметр + #тип - число + #account_id = 11111 + + #фильтр по имени ресурсной группы + #опциональный параметр + #тип - строка + #rg_name = "test" + + #фильтр по id ресурсной группы + #опциональный параметр + #тип - число + #rg_id = 100 + + #фильтр по техническому статусу + #опциональный параметр + #тип - строка + #tech_status = "STOPPED" + + #фильтр по статусу + #опциональный параметр + #тип - строка + #status = "ENABLED" + + #фильтр по ip + #опциональный параметр + #тип - строка + #ip_address = "test" + + #фильтр по имени extnet + #опциональный параметр + #тип - строка + #extnet_name = "test" + + #фильтр по id extnet + #опциональный параметр + #тип - число + #extnet_id = 100 + + #флаг влючения в результат удаленных балансироващиков нагрузки + #опциональный параметр + #тип - булев тип + #значение по-умолчанию - false + #если не задан - выводятся все доступные неудаленные балансировщики + #includedeleted = true + + #номер страницы для отображения + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #page = 1 + + #размер страницы + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #size = 1 + + #Включить в список вывода ВМ, принадлежащие k8s кластерам (при значении параметра true) + #опциональный параметр + #bool (default = false) + #ignore_k8s = true +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_list** в переменной `data.decort_cb_kvmvm_list.kvmvm_list` будут сохранены возвращаемые значения. diff --git a/06.02.89-Data-функция-decort_cb_kvmvm_list_deleted-получение-информации-о-списке-удаленных-компьютов.md b/06.02.89-Data-функция-decort_cb_kvmvm_list_deleted-получение-информации-о-списке-удаленных-компьютов.md new file mode 100644 index 0000000..289376b --- /dev/null +++ b/06.02.89-Data-функция-decort_cb_kvmvm_list_deleted-получение-информации-о-списке-удаленных-компьютов.md @@ -0,0 +1,235 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_list_deleted** служит для получения информации о списке удаленных компьютов. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_list_deleted** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID ресурсной группы | +| rg_name | string | :x: | Фильтр по имени рес. группы | +| tech_status | string | :x: | Фильтр по тех.статусу | +| ip_address | string | :x: | Фильтр по IP адресу | +| extnet_name | string | :x: | Фильтр по имени внешней сети | +| extnet_id | int | :x: | Фильтр по extnet ID | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | +| ignore_k8s | bool | :x: | При значении true - показать все ВМ, не относящиеся к любому из кластеров k8s | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_list_deleted** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| anti_affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила анти аффинити для компьютов | +| arch | string | Архитектура | +| boot_order | []string | Boot order | +| bootdisk_size | int | Размер загрузочного диска в ГБ. | +|cd_image_id| int | cd image id | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | +| computeci_id | int | ID вычислительного ресурса | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кем создан _compute_ | +| created_time | int | Время создания _compute_ | +| custom_fields | string | Кастомные поля | +| deleted_by | string | Кем удален _compute_ | +| deleted_time | int | Время удаления _compute_ | +| desc | string | Текстовое описание виртуальной машины. | +| devices | string | Девайсы | +| disks | []Struct [см. ниже](#описание-структуры-disks) | информация о дисках компьюта | +| driver | string | Аппаратная архитектура данной виртуальной машины. | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| interfaces | []Struct [см. ниже](#описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | +| name | string | Имя компьюта | +| need_reboot | bool | Флаг перезапуска | +| os_users | []Struct [см. ниже](#описание-структуры-os-users) | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. | +| pinned | bool | добавлен ли компьют на стек | +| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID ссылки | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Наименование ресурса | +| rg_id | int | Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | +| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| snap_sets | []Struct [см. ниже](#описание-структуры-snap-sets) | Snap sets | +| stack_id | int | id стэка | +| stateless_sep_id | int | ID сеп | +| stateless_sep_type | string | Тип сеп | +| status | string | Статус компьюта | +| tags | []Struct [см. ниже](#описание-структуры-tags) | Тэги | +| tech_status | string | Технический статус компьюта в составе группы | +| total_disk_size | int | Размер диска | +| updated_by | string | Кем компьют был обновлен | +| updated_time | int | Время последнего обновления | +|user_data| string | Данные пользователя | +| user_managed | bool | Флаг, показывает управление пользователем вычислительной мощностью | +| vgpus | []int | Список vgpu | +| vins_connected | int | Кол-во присоединенных винсов | +| virtual_image_id | int | ID виртуального образа | + +### Описание структуры os users +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | GUID | +| login | string | Логин | +| password | string | Пароль | +| public_key | string | Публичный ssh ключ | + +### Описание структуры tags +| Параметр | Тип | Описание | +| --- | --- | --- | +| key | string | Ключ тэга | +| val | string | Значение тэга | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +### Описание структуры disks +| Параметр | Тип | Описание | +| --- | --- | --- | +| disk_id | int | id диска | +| pci_slot | int | id pci слота, к которому подключен диск | + +## Пример использования +```terraform +data "decort_cb_kvmvm_list_deleted" "kvmvm_list" { + #фильтр по id ВМ + #опциональный параметр + #тип - число + #by_id = 100 + + #фильтр по имени ВМ + #опциональный параметр + #тип - строка + #name = "test" + + #id аккаунта для получения списка ВМ + #опциональный параметр + #тип - число + #account_id = 11111 + + #фильтр по имени ресурсной группы + #опциональный параметр + #тип - строка + #rg_name = "test" + + #фильтр по id ресурсной группы + #опциональный параметр + #тип - число + #rg_id = 100 + + #фильтр по техническому статусу + #опциональный параметр + #тип - строка + #tech_status = "STOPPED" + + #фильтр по ip + #опциональный параметр + #тип - строка + #ip_address = "test" + + #фильтр по имени extnet + #опциональный параметр + #тип - строка + #extnet_name = "test" + + #фильтр по id extnet + #опциональный параметр + #тип - число + #extnet_id = 100 + + #номер страницы для отображения + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #page = 1 + + #размер страницы + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #size = 1 + + #Включить в список вывода ВМ, принадлежащие k8s кластерам (при значении параметра true) + #опциональный параметр + #bool (default = false) + #ignore_k8s = true +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_list_deleted** в переменной `data.decort_cb_kvmvm_list_deleted.kvmvm_list` будут сохранены возвращаемые значения. diff --git a/06.02.90-Data-функция-decort_cb_kvmvm_migrate_storage_info-получение-информации-о-последней-миграции-хранилища.md b/06.02.90-Data-функция-decort_cb_kvmvm_migrate_storage_info-получение-информации-о-последней-миграции-хранилища.md new file mode 100644 index 0000000..7059d58 --- /dev/null +++ b/06.02.90-Data-функция-decort_cb_kvmvm_migrate_storage_info-получение-информации-о-последней-миграции-хранилища.md @@ -0,0 +1,29 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_migrate_storage_info** служит для получения информации о последней (включая текущую) миграции хранилища. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_migrate_storage_info** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_migrate_storage_info** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- | --- |-------------------------------------------------------------| +| migrate_storage_info | string | Информация о последней (включая текущую) миграции хранилища | + +## Пример использования +```terraform +data "decort_cb_kvmvm_migrate_storage_info" "info" { + compute_id = 10154 +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_migrate_storage_info** в переменной `data.decort_cb_kvmvm_migrate_storage_info.info` будут сохранены возвращаемые значения. diff --git a/06.02.91-Data-функция-decort_cb_kvmvm_pci_device_list-получение-информации-о-доступных-компьюту-списка-устройств-с-шиной-PCI.md b/06.02.91-Data-функция-decort_cb_kvmvm_pci_device_list-получение-информации-о-доступных-компьюту-списка-устройств-с-шиной-PCI.md new file mode 100644 index 0000000..822e79f --- /dev/null +++ b/06.02.91-Data-функция-decort_cb_kvmvm_pci_device_list-получение-информации-о-доступных-компьюту-списка-устройств-с-шиной-PCI.md @@ -0,0 +1,77 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_pci_device_list** служит для получения информации о доступных компьюту списка устройств с шиной PCI. + +## Аргументы +_Data source_ функция **decort_cb_kvmvm_pci_device_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- |---------------------------------|-------------------------------| +| compute_id | int | :heavy_check_mark: | id компьюта | +| rg_id | int | :x: | Фильтр по ID ресурсной группы | +| device_id | int | :x: | Фильтр по ID устройства | +| status | string | :x: | Фильтр по статусу | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_pci_device_list** возвращает в указанную при вызове переменную, в поле _items_ массив строк + +| Параметр | Тип | Описание | +|------------|----------|--------------------------------------| +| ckey | string | CKey | +| meta | []string | Мета информация | +| compute_id | int | id вычислительной площадки | +| description | string | Описание | +| guid | int | Внутренний id | +| hwpath | string | HW Путь | +| device_id | int | id устройства | +| name | string | Наименование устройства | +| rg_id | int | id ресурсной группы (resource group) | +| stack_id | int | id стэка | +| status | string | Статус устройства | +| system_name | string | Системное имя устройства | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_kvmvm_pci_device_list**: +```terraform +data "decort_cb_kvmvm_pci_device_list" "pl" { + #id виртуальной машины + #обязательный параметр + #тип - число + compute_id = 100 + + #фильтр по id ресурсной группы + #опциональный параметр + #тип - число + #rg_id = 100 + + #фильтр по id устройства + #опциональный параметр + #тип - число + #device_id = 100 + + #фильтр по статусу + #опциональный параметр + #тип - строка + #status = "ENABLED" + + #номер страницы для отображения + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #page = 1 + + #размер страницы + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #size = 1 +} +# once the above directive completes, pcidevice list will be accessible +# as data.decort_cb_kvmvm_pci_device_list.pl.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +После успешного завершения такого вызова **decort_cb_kvmvm_pci_device_list** в переменной `data.decort_cb_kvmvm_pci_device_list.pl.items` будут сохранены возвращаемые значения. diff --git a/06.02.92-Data-функция-decort_cb_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md b/06.02.92-Data-функция-decort_cb_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md new file mode 100644 index 0000000..f4b7e77 --- /dev/null +++ b/06.02.92-Data-функция-decort_cb_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md @@ -0,0 +1,37 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_pfw_list** служит для получения списка pfw компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_pfw_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|------------|--------|--------------------|----------------| +| compute_id | int | :heavy_check_mark: | ID компьюта | +| reason | string | :x: | Причина вызова | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_pfw_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| pfw_id | int | ID pfw | +| local_ip | string | Локальный ip адрес | +| local_port | int | Локальный порт | +| protocol | string | Протокол tcp/udp | +| public_port_end | int | Конец диапазона внешних портов | +| public_port_start | int | Начало диапазона внешних портов | +| vm_id | int | ID компьюта| + +## Пример использования +```terraform +data "decort_cb_kvmvm_pfw_list" "pfw_list" { + compute_id = 10154 + #reason = "test" +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_pfw_list** в переменной `data.decort_cb_kvmvm_pfw_list.pfw_list.items` будут сохранены возвращаемые значения. diff --git a/06.02.93-Data-функция-decort_cb_kvmvm_snapshot_usage-информация-об-использовании-снапшотов.md b/06.02.93-Data-функция-decort_cb_kvmvm_snapshot_usage-информация-об-использовании-снапшотов.md new file mode 100644 index 0000000..c0d2d6f --- /dev/null +++ b/06.02.93-Data-функция-decort_cb_kvmvm_snapshot_usage-информация-об-использовании-снапшотов.md @@ -0,0 +1,43 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_snapshot_usage** служит для получения информации о использовании снапшотов. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_kvmvm_snapshot_usage**. + +## Аргументы +_Data source_ функция **decort_cb_kvmvm_snapshot_usage** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| compute_id | int | :heavy_check_mark: | Идентификатор компьюта | +| label | string | :x: | Название снапшота | + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_snapshot_usage** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| count | int | Количество компьютов, использующих снапшот | +| stored | float | Stored | +| label | string | Название снапшота | +| timestamp | int | Время снапшота | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_kvmvm_snapshot_usage**: + +```terraform +data "decort_cb_kvmvm_snapshot_usage" "snapshot_usage" { + compute_id = 1234 + #label = "label1" +} +# Once the above directive completes, snapshot usage will be accessible as +# data.decort_cb_kvmvm_snapshot_usage.snapshot_usage.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)). + +После успешного завершения такого вызова **decort_cb_kvmvm_snapshot_usage** в переменной `data.decort_cb_kvmvm_snapshot_usage.snapshot_usage.items` будут сохранены возвращаемые значения. diff --git a/06.02.94-Data-функция-decort_cb_kvmvm_snapshot_list-получение-списка-снапшотов.md b/06.02.94-Data-функция-decort_cb_kvmvm_snapshot_list-получение-списка-снапшотов.md new file mode 100644 index 0000000..a2e92ec --- /dev/null +++ b/06.02.94-Data-функция-decort_cb_kvmvm_snapshot_list-получение-списка-снапшотов.md @@ -0,0 +1,39 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_snapshot_list** служит для получения информации о использовании снапшотов. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +## Аргументы +_Data source_ функция **decort_cb_kvmvm_snapshot_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| compute_id | int | :heavy_check_mark: | Идентификатор компьюта | + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_snapshot_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |--------| --- | +| disks | []int | Список id дисков | +| guid | string | ID ресурса | +| label | string | Название снапшота | +| timestamp | int | Время снапшота | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_kvmvm_snapshot_list**: + +```terraform +data "decort_cb_kvmvm_snapshot_list" "snapshot_list" { + compute_id = 1234 +} +# Once the above directive completes, snapshot list will be accessible as +# data.decort_cb_kvmvm_snapshot_list.snapshot_list.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)). + +После успешного завершения такого вызова **decort_cb_kvmvm_snapshot_list** в переменной `data.decort_cb_kvmvm_snapshot_list.snapshot_list.items` будут сохранены возвращаемые значения. diff --git a/06.02.95-Data-функция-decort_cb_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md b/06.02.95-Data-функция-decort_cb_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md new file mode 100644 index 0000000..ca67d24 --- /dev/null +++ b/06.02.95-Data-функция-decort_cb_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md @@ -0,0 +1,41 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_user_list** служит для получения информации о Access Control List компьюта. + +## Аргументы + +_Data source_ функция **decort_cb_kvmvm_user_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_user_list** возвращает в указанную при вызове переменную следующие параметры: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct [см. ниже](#описание-структуры-list-acl) | Информация о списке пользователей аккаунтов | +| compute_acl | []Struct [см. ниже](#описание-структуры-list-acl) | Информация о списке пользователей компьютов | +| rg_acl | []Struct [см. ниже](#описание-структуры-list-acl) | Информация о списке пользователей ресурной группы | + +### Описание структуры List acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +## Пример использования +```terraform +data "decort_cb_kvmvm_user_list" "user_list" { + compute_id = 10154 +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _data source_ функции **decort_cb_kvmvm_user_list** в переменной `data.decort_cb_kvmvm_user_list.user_list` будут сохранены возвращаемые значения. diff --git a/06.02.96-Data-функция-decort_cb_kvmvm_vgpu_list-получение-информации-о-доступных-компьюту-списка-виртуальных-графических-устройств.md b/06.02.96-Data-функция-decort_cb_kvmvm_vgpu_list-получение-информации-о-доступных-компьюту-списка-виртуальных-графических-устройств.md new file mode 100644 index 0000000..b789791 --- /dev/null +++ b/06.02.96-Data-функция-decort_cb_kvmvm_vgpu_list-получение-информации-о-доступных-компьюту-списка-виртуальных-графических-устройств.md @@ -0,0 +1,68 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_kvmvm_vgpu_list** служит для получения информации о доступных компьюту списка виртуальных графических устройств. + +## Аргументы +_Data source_ функция **decort_cb_kvmvm_vgpu_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------|---------------------------------|-----------------------------------------| +| compute_id | int | :heavy_check_mark: | id компьюта | +| gpu_id | int | :x: | Фильтр по ID устройства | +| type | string | :x: | Фильтр по типу графического устройства | +| status | string | :x: | Фильтр по статусу | +| includedeleted | bool | :x: | Включить в рез-тат удаленные устройства | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_kvmvm_vgpu_list** возвращает в указанную при вызове переменную, в поле _items_ массив строк. + +## Пример использования +Пример вызова _data source_ функции **decort_cb_kvmvm_vgpu_list**: +```terraform +data "decort_cb_kvmvm_vgpu_list" "vgpu_list" { + #id виртуальной машины + #обязательный параметр + #тип - число + compute_id = 100 + + #фильтр по id графического процессора + #опциональный параметр + #тип - число + #gpu_id = 100 + + #фильтр по типу графического процессора + #опциональный параметр + #тип - строка + #type = "NVIDIA" + + #фильтр по статусу + #опциональный параметр + #тип - строка + #status = "ENABLED" + + #фильтр "включая удаленные графические процессоры" + #опциональный параметр + #тип - булев тип + #includedeleted = "false" + + #номер страницы для отображения + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #page = 1 + + #размер страницы + #опциональный параметр + #тип - число + #если не задан - выводятся все доступные данные + #size = 1 +} +# once the above directive completes, decort_cb_kvmvm_vgpu_list list will be accessible +# as data.decort_cb_kvmvm_vgpu_list.vgpu_list.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +После успешного завершения такого вызова **decort_cb_kvmvm_vgpu_list** в переменной `data.decort_cb_kvmvm_vgpu_list.vgpu_list.items` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index ef1b554..f34094e 100644 --- a/Home.md +++ b/Home.md @@ -115,7 +115,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_flipgroup_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах) - получение информации о плавающих группах 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)