|
|
|
|
@ -0,0 +1,133 @@
|
|
|
|
|
Функция доступна в провайдере версии 3.0 и выше.
|
|
|
|
|
|
|
|
|
|
_Data source_ функция **decort_cb_disk_list** служит для получения информации об имеющихся дисках.
|
|
|
|
|
|
|
|
|
|
## Аргументы
|
|
|
|
|
_Data source_ функция **decort_cb_disk_list** принимает следующие аргументы:
|
|
|
|
|
|
|
|
|
|
| Аргумент | Тип | Обязательный | Описание |
|
|
|
|
|
| --- | --- | --- |-------------------------------------------------------------|
|
|
|
|
|
| by_id | int | :x: | Фильтр по ID диска |
|
|
|
|
|
| name | string | :x: | Фильтр по имени диска |
|
|
|
|
|
| account_name | string | :x: | Фильтр по имени аккаунта |
|
|
|
|
|
| disk_max_size | int | :x: | Фильтр по макс. размеру диска |
|
|
|
|
|
| status | string | :x: | Фильтр по статусу диска |
|
|
|
|
|
| shared | bool | :x: | Фильтр по значению shared |
|
|
|
|
|
| account_id | int | :x: | id аккаунта для получения списка дисков |
|
|
|
|
|
| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk |
|
|
|
|
|
| sep_id | int | :x: | Фильтр по storage endpoint provider ID |
|
|
|
|
|
| pool | string | :x: | Фильтр по Pool |
|
|
|
|
|
| page | int | :x: | Номер страниц |
|
|
|
|
|
| size | int | :x: | Размер страницы |
|
|
|
|
|
|
|
|
|
|
## Возвращаемые значения
|
|
|
|
|
В случае успешного выполнения _data source_ функция **decort_cb_disk_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
|
|
|
|
|
|
|
|
|
| Параметр | Тип | Описание |
|
|
|
|
|
|-----------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| account_id | int | Уникальный идентификатор подписчика-владельца диска |
|
|
|
|
|
| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск |
|
|
|
|
|
| acl | string | Acces Control List |
|
|
|
|
|
| boot_partition | int | Кол-во разделов диска |
|
|
|
|
|
| computes | []Struct [см. ниже](#описание-структуры-computes) | Информация о подключенных виртуальных машинах |
|
|
|
|
|
| created_time | int | Время создания |
|
|
|
|
|
| deleted_time | int | Время удаления |
|
|
|
|
|
| desc | string | Текстовое описание диска |
|
|
|
|
|
| destruction_time | int | Время окончательного удаления |
|
|
|
|
|
| devicename | string | Наименование устройства |
|
|
|
|
|
| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. |
|
|
|
|
|
| disk_path | string | Адрес диска |
|
|
|
|
|
| gid | int | Идентификатор площадки (grid id) |
|
|
|
|
|
| guid | int | Идентификатор диска |
|
|
|
|
|
| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа |
|
|
|
|
|
| images | []int | Идентификаторы образов, использующих диск |
|
|
|
|
|
| iotune | []Struct [см. ниже](#описание-структуры-iotune) | Информация об ограничениях IO диска |
|
|
|
|
|
| iqn | string | iqn диска |
|
|
|
|
|
| login | string | Логин для доступа к диску |
|
|
|
|
|
| machine_id | int | id машины (устаревшее) |
|
|
|
|
|
| machine_name | string | Наименование машины (устаревшее) |
|
|
|
|
|
| milestones | int | Вехи |
|
|
|
|
|
| disk_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 | int | id ссылки на диск |
|
|
|
|
|
| res_id | int | id ресурса |
|
|
|
|
|
| res_name | string | Наименование ресурса |
|
|
|
|
|
| role | string | Роль диска |
|
|
|
|
|
| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск |
|
|
|
|
|
| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений |
|
|
|
|
|
| shareable | bool | Флаг, отвечающий за доступность диска дургим ресурсам |
|
|
|
|
|
| size_max | int | Размер диска в ГБ |
|
|
|
|
|
| size_used | float | Кол-во используемого места, в ГБ |
|
|
|
|
|
| snapshots | []Struct [см. ниже](#описание-структуры-snapshots) | Снимки состояния диска |
|
|
|
|
|
| status | string | Статус диска |
|
|
|
|
|
| tech_status | string | Технический статус диска |
|
|
|
|
|
| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:<br/>"B" - признак загрузочного диска ("boot").<br/>"D" - признак дополнительного диска ("data") |
|
|
|
|
|
| vmid | int | Идентификатор виртуальной машины (устаревшее) |
|
|
|
|
|
|
|
|
|
|
### Описание структуры computes
|
|
|
|
|
| Параметр | Тип | Описание |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| compute_id | int | Идентификатор compute (виртуальной машины) |
|
|
|
|
|
| compute_name | string | Название compute (виртуальной машины) |
|
|
|
|
|
|
|
|
|
|
### Описание структуры 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 | Наименование снимка |
|
|
|
|
|
| reference_id | int | Reference ID |
|
|
|
|
|
| res_id | string | Ссылка на снимок |
|
|
|
|
|
| snap_set_guid | string | Установленный id снимка |
|
|
|
|
|
| snap_set_time | int | Установленное время снимка |
|
|
|
|
|
| timestamp | int | Время снимка |
|
|
|
|
|
|
|
|
|
|
## Пример использования
|
|
|
|
|
Пример вызова _data source_ функции **decort_cb_disk_list**:
|
|
|
|
|
```terraform
|
|
|
|
|
data "decort_cb_disk_list" "dl" {
|
|
|
|
|
#by_id = 11111
|
|
|
|
|
#name = "disk name"
|
|
|
|
|
#account_name = "account name"
|
|
|
|
|
#disk_max_size = 3
|
|
|
|
|
#status = "started"
|
|
|
|
|
#shared = true
|
|
|
|
|
#account_id = 11111
|
|
|
|
|
#type = "d"
|
|
|
|
|
#sep_id = 1
|
|
|
|
|
#pool = "pool name"
|
|
|
|
|
#page = 1
|
|
|
|
|
#size = 1
|
|
|
|
|
}
|
|
|
|
|
# once the above directive completes, disk list will be accessible
|
|
|
|
|
# as data.decort_cb_disk_list.dl.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_disk_list** в переменной `data.decort_cb_disk_list.dl.items` будут сохранены возвращаемые значения.
|
