diff --git a/06.02.03-Data-функция-decort_cb_disk-получение-информации-о-диске.md b/06.02.03-Data-функция-decort_cb_disk-получение-информации-о-диске.md new file mode 100644 index 0000000..7727f7c --- /dev/null +++ b/06.02.03-Data-функция-decort_cb_disk-получение-информации-о-диске.md @@ -0,0 +1,110 @@ +Функция доступна в провайдере версии 3.0 и выше. + +_Data source_ функция **decort_cb_disk** служит для получения информации об уже существующем диске. + +## Аргументы +_Data source_ функция **decort_cb_disk** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| disk_id | int | :heavy_check_mark: | Идентификатор диска | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +|-----------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 | Логин для доступа к диску | +| 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_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"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**: + +```terraform +data "decort_cb_disk" "my_data_disk" { + disk_id = 33333 +} +# Once the above directive completes, disk name will be accessible as +# data.decort_cb_disk.my_data_disk.disk_name +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_cb_disk** в переменной `data.decort_cb_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения наименования диска следует использовать конструкцию `data.decort_cb_disk.my_data_disk.disk_name` diff --git a/06.02.03-Data-функция-decort_disk-получение-информации-о-диске.md b/06.02.03-Data-функция-decort_disk-получение-информации-о-диске.md deleted file mode 100644 index d4e98ed..0000000 --- a/06.02.03-Data-функция-decort_disk-получение-информации-о-диске.md +++ /dev/null @@ -1,75 +0,0 @@ -Функция доступна в провайдере версии 3.0 и выше. - -_Data source_ функция **decort_disk** служит для получения информации об уже существующем диске. - -## Аргументы -_Data source_ функция **decort_disk** принимает следующие аргументы: - -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| disk_id | int | :heavy_check_mark: | Идентификатор диска | - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | Уникальный идентификатор подписчика-владельца диска | -| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск | -| boot_partition | int | Кол-во разделов диска | -| compute_id | int | Идентификатор compute (виртуальной машины) | -| compute_name | string | Название compute (виртуальной машины) | -| 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 | Идентификатор диска | -| id | int | Идентификатор диска | -| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа | -| images | []int | Идентификаторы образов, использующих диск | -| iotune | Struct{
read_bytes_sec int
read_bytes_sec_max int
read_iops_sec int
read_iops_sec_max int
size_iops_sec int
total_bytes_sec int
total_bytes_sec_max int
total_iops_sec int
total_iops_sec_max int
write_bytes_sec int
write_bytes_sec_max int
write_iops_sec int
write_iops_sec_max int
} | Информация об ограничениях IO диска
Кол-во байт для чтения в секунду
Максимальное кол-во байт для чтения
 
Кол-во операций чтения io в секунду
Максимальное число io операций чтения
Размер io операций
Общий размер байт в секунду
Максимальный общий размер байт в секунду
 
Общее кол-во io операций в секунду
Максимальное общее кол-во io операций в секунду
 
Кол-во байт для записи в секунду
Максимальное кол-во байт для записи в секунду
 
Кол-во операций записи в секунду
Максимальное число операций записей
 
| -| iqn | string | iqn диска | -| login | string | Логин для доступа к диску | -| milestones | int | Вехи | -| disk_name | string | Наименование диска | -| order | int | Номер диска | -| params | string | Параметры диска | -| parent_id | int | id родительского диска | -| passwd | string | Пароль для доступа к диску | -| pci_slot | int | id pci слота, к которому подключен диск | -| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | -| 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. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений | -| size_max | int | Размер диска в ГБ | -| size_used | int | Кол-во используемого места, в ГБ | -| snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Снимки состояния диска
id снимка
Наименование снимка
Ссылка на снимок
Установленный id снимка
Установленное время снимка
Время снимка
 
| -| status | string | Статус диска | -| tech_status | string | Технический статус диска | -| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | -| vmid | int | Идентификатор виртуальной машины (устаревшее) | - -## Пример использования -Пример вызова _data source_ функции **decort_disk**: - -```terraform -data "decort_disk" "my_data_disk" { - disk_id = 33333 -} -# Once the above directive completes, disk ID will be accessible as -# data.decort_disk.my_data_disk -``` - -Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). - -После успешного завершения такого вызова **decort_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения наименования диска следует использовать конструкцию `data.decort_disk.my_data_disk.disk_name` diff --git a/06.02.15-Data-функция-decort_cb_disk_list-получение-информации-о-всех-дисках.md b/06.02.15-Data-функция-decort_cb_disk_list-получение-информации-о-всех-дисках.md new file mode 100644 index 0000000..3b155fc --- /dev/null +++ b/06.02.15-Data-функция-decort_cb_disk_list-получение-информации-о-всех-дисках.md @@ -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_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"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` будут сохранены возвращаемые значения. diff --git a/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md b/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md deleted file mode 100644 index f7dbd44..0000000 --- a/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md +++ /dev/null @@ -1,84 +0,0 @@ -Функция доступна в провайдере версии 3.0 и выше. - -_Data source_ функция **decort_disk_list** служит для получения информации об имеющихся дисках. - -## Аргументы -_Data source_ функция **decort_disk_list** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| account_id | int | :x: | id аккаунта для получения списка дисков | -| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | -| page | int | :x: | Номер страниц | -| size | int | :x: | Размер страницы | - - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_disk_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | id аккаунта | -| account_name | string | имя аккаунта | -| created_time | int | Время создания диска | -| deleted_time | int | Время удаления диска | -| desc | string | Описание диска | -| destruction_time | int | Время уничтожения диска | -| devicename | string | Имя устройства | -| gid | int | Grid id | -| disk_id | int | id диска | -| image_id | int | id образа | -| images | []int | id образов | -| iotune | Struct{
total_iops_sec int
} | Информация об IO-интерфейсах
Общее кол-во операций в секунду
 
| -| machine_id | int | id маишны (устаревшее) | -| machine_name | string | Наименование машины (устаревшее) | -| name | string | Наименование диска | -| order | int | Номер диска в последовательности | -| params | string | Параметры диска | -| parent_id | int | id родителя | -| pci_slot | int | id pci слота | -| pool | string | Наименование пула диска | -| purge_time | int | Время удаления | -| res_id | string | Идентификатор ресурса | -| res_name | string | Наименование ресурсов | -| role | string | Роль диска -| sep_id | int | id sep | -| sep_type | string | Тип sep | -| size_max | int | Максимальный размер диска | -| snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Информация о снимках состояний диска
guid снимка
Наименование снимка
id ресурса снимка
Установленный guid снимка
Установленное время снимка
Время снимка
 
| -| status | string | Статус диска -| tech_status | string | Технический статус диска | -| type | string | Тип диска -| vmid | int | id виртуальной машины | - -## Пример использования -Пример вызова _data source_ функции **decort_disk_list**: -```terraform -data "decort_disk_list" "dl" { - #id аккаунта для получения списка дисков - #опциональный параметр - #тип - число - #account_id = 11111 - - #тип диска - #опциональный параметр - #тип - строка - #возможные типы: "b" - boot_disk, "d" - data_disk - #type = "d" - - #кол-во страниц для вывода - #опциональный параметр - #тип - число - #page = 1 - - #размер страницы - #опциональный параметр - #тип - число - #size = 1 -} -# once the above directive completes, disk list will be accessible -# as data.decort_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_disk_list** в переменной `data.decort_disk_list.dl` будут сохранены возвращаемые значения. diff --git a/06.02.63-Data-функция-decort_cb_disk_list_deleted-получение-информации-об-удаленных-дисках.md b/06.02.63-Data-функция-decort_cb_disk_list_deleted-получение-информации-об-удаленных-дисках.md new file mode 100644 index 0000000..b97a2ef --- /dev/null +++ b/06.02.63-Data-функция-decort_cb_disk_list_deleted-получение-информации-об-удаленных-дисках.md @@ -0,0 +1,127 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_list_deleted** служит для получения информации об удаленных дисках. + +## Аргументы +_Data source_ функция **decort_cb_disk_list_deleted** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- |-------------------------------------------------------------| +| by_id | int | :x: | Фильтр по ID диска | +| name | string | :x: | Фильтр по имени диска | +| account_name | string | :x: | Фильтр по имени аккаунта | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| shared | bool | :x: | Фильтр по значению shared | +| account_id | int | :x: | id аккаунта для получения списка дисков | +| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_list_deleted** возвращает в указанную при вызове переменную, в поле _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_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"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_deleted**: +```terraform +data "decort_cb_disk_list_deleted" "dld" { + #by_id = 11111 + #name = "disk name" + #account_name = "account name" + #disk_max_size = 3 + #shared = true + #account_id = 11111 + #type = "d" + #page = 1 + #size = 1 +} +# once the above directive completes, disk list deleted items will be accessible +# as data.decort_cb_disk_list_deleted.dld.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова **decort_cb_disk_list_deleted** в переменной `data.decort_cb_disk_list_deleted.dld.items` будут сохранены возвращаемые значения. diff --git a/06.02.64-Data-функция-decort_cb_disk_list_types-получение-списка-типов-диска.md b/06.02.64-Data-функция-decort_cb_disk_list_types-получение-списка-типов-диска.md new file mode 100644 index 0000000..5a22b31 --- /dev/null +++ b/06.02.64-Data-функция-decort_cb_disk_list_types-получение-списка-типов-диска.md @@ -0,0 +1,30 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_list_types** служит для получения информации о типах диска. + +## Аргументы +_Data source_ функция **decort_cb_disk_list_types** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_list_types** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +|----------|----------|------------------------------------| +| items | []string | Список всех доступных типов дисков | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_disk_list_types**: + +```terraform +data "decort_cb_disk_list_types" "dt" { + #page = 2 + #size = 3 +} +``` + +После успешного завершения такого вызова **decort_cb_disk_list_types** в переменной `data.decort_cb_disk_list_types.dt.items` будут сохранены возвращаемые значения. diff --git a/06.02.65-Data-функция-decort_cb_disk_list_types_detailed-расширенное-получение-информации-о-поддерживаемых-типах-дисков.md b/06.02.65-Data-функция-decort_cb_disk_list_types_detailed-расширенное-получение-информации-о-поддерживаемых-типах-дисков.md new file mode 100644 index 0000000..1b7d2f9 --- /dev/null +++ b/06.02.65-Data-функция-decort_cb_disk_list_types_detailed-расширенное-получение-информации-о-поддерживаемых-типах-дисков.md @@ -0,0 +1,39 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_list_types_detailed** служит для получения расширенной информации о поддерживаемых платформой типах дисков. В отличии от другой _data source_ функции **decort_cb_disk_list_types**, данная функция позволяет получить информацию о поддерживаемых пулами и sep типов дисков. + +## Аргументы +_Data source_ функция **decort_cb_disk_list_types_detailed** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_list_types_detailed** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| pools | []Struct [см.ниже](#описание-структуры-pools) | Пул хранилища | +| sep_id | int | ID storage endpoint (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| sep_name | int | Имя storage endpoint | + +### Описание структуры pools +| Параметр | Тип | Описание | +| --- | --- | --- | +| name | string | Имя пул | +| system | string | Флаг, обозначающий служебный пул, для размещения там данных о блокировках | +| types | []string | Список поддерживаемых типов | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_disk_list_types_detailed*: + +```terraform +data "decort_cb_disk_list_types_detailed" "dtd" { + #page = 2 + #size = 3 +} +``` + +После успешного завершения такого вызова **decort_cb_disk_list_types_detailed** в переменной `data.decort_cb_disk_list_types_detailed.dtd.items` будут сохранены возвращаемые значения. diff --git a/06.02.66-Data-функция-decort_cb_disk_list_unattached-получение-информации-о-неподключенных-дисках.md b/06.02.66-Data-функция-decort_cb_disk_list_unattached-получение-информации-о-неподключенных-дисках.md new file mode 100644 index 0000000..4dc4d41 --- /dev/null +++ b/06.02.66-Data-функция-decort_cb_disk_list_unattached-получение-информации-о-неподключенных-дисках.md @@ -0,0 +1,117 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_list_unattached** служит для получения информации о неподключенных к виртуальным машинам дисках. + +## Аргументы +_Data source_ функция **decort_cb_disk_list_unattached** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID диска | +| account_name | string | :x: | Фильтр по имени аккаунта | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| status | string | :x: | Фильтр по статусу | +| account_id | int | :x: | id аккаунта для получения списка дисков | +| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | +| sep_id | int | :x: | Фильтр по SEP id. SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| pool | string | :x: | Фильтр по наименованию pool | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_list_unattached** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- |-------------------------------------| +| _ckey | string | CKey | +| _meta | []string | Meta информация | +| account_id | int | id аккаунта | +| account_name | string | имя аккаунта | +| acl | string | Acces Control List | +| boot_partition | int | Загрузочный раздел | +| created_time | int | Время создания диска | +| deleted_time | int | Время удаления диска | +| desc | string | Описание диска | +| destruction_time | int | Время уничтожения диска | +| disk_path | string | Адрес диска | +| gid | int | Grid id | +| guid | int | Идентификатор диска | +| disk_id | int | id диска | +| image_id | int | id образа | +| images | []int | id образов | +| iotune | Struct{}[см. ниже](#описание-структуры-iotune) | Информация об ограничениях IO диска | +| iqn | string | iqn диска | +| login | 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 | string | Идентификатор ресурса | +| res_name | string | Наименование ресурсов | +| role | string | Роль диска | +| sep_id | int | id sep | +| shareable | bool | Флаг, отвечающий за доступность диска дургим ресурсам | +| size_max | int | Максимальный размер диска | +| snapshots | []Struct{}[см. ниже](#описание-структуры-snapshots)| Снимки состояния диска | +| status | string | Статус диска | +| tech_status | string | Технический статус диска | +| type | string | Тип диска | +| vmid | int | id виртуальной машины (устаревшее) | + +### Описание структуры 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 | string | ID ссылки | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | Установленный id снимка | +| snap_set_time | int | Установленное время снимка | +| timestamp | int | Время снимка | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_disk_list_unattached**: +```terraform +data "decort_cb_disk_list_unattached" "dlu" { + #by_id = 100 + #account_name = "user" + #disk_max_size = 100 + #status = "ENABLED" + #type = "d" + #account_id = 100 + #sep_id = 1 + #pool = "test" + #page = 2 + #size = 3 +} +# once the above directive completes, unattached disk list will be accessible +# as data.decort_cb_disk_list_unattached.dlu.items +``` + +После успешного завершения такого вызова **decort_cb_disk_list_unattached** в переменной `data.decort_cb_disk_list_unattached.dlu.items` будут сохранены возвращаемые значения. diff --git a/06.02.67-Data-функция-decort_cb_disk_snapshot-получение-информации-о-снимке-состояния.md b/06.02.67-Data-функция-decort_cb_disk_snapshot-получение-информации-о-снимке-состояния.md new file mode 100644 index 0000000..72a6260 --- /dev/null +++ b/06.02.67-Data-функция-decort_cb_disk_snapshot-получение-информации-о-снимке-состояния.md @@ -0,0 +1,36 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_snapshot** служит для получения информации о снимке состояния диска. + +## Аргументы +_Data source_ функция **decort_cb_disk_snapshot** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| disk_id | int | :heavy_check_mark: | ID диска, снимок которого необходимо получить | +| label | string | :heavy_check_mark: | Название снимка | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_snapshot** возвращает в указанную при вызове переменную следующие параметры: + +| Параметр | Тип | Описание | +| --- |--------| --- | +| disk_id | int | ID диска, снимок которого необходимо получить | +| label | string | Название снимка | +| guid | string | id снимка | +| reference_id | string | ID ссылки | +| res_id | string | Ссылка на снимок | +| timestamp | int | Время снимка | +| snap_set_guid | string | ID набора снимков, в котором лежит снимок состояния | +| snap_set_time | int | Время набора | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_disk_snapshot**: +```terraform +data "decort_cb_disk_snapshot" "ds" { + disk_id = 11111 + label = "fdsfsdfsdf" +} +``` + +После успешного завершения такого вызова **decort_cb_disk_snapshot** в переменной `data.decort_cb_disk_snapshot.ds` будут сохранены возвращаемые значения. diff --git a/06.02.68-Data-функция-decort_cb_disk_snapshot_list-получение-списка-снимков-состояния-диска.md b/06.02.68-Data-функция-decort_cb_disk_snapshot_list-получение-списка-снимков-состояния-диска.md new file mode 100644 index 0000000..3117c80 --- /dev/null +++ b/06.02.68-Data-функция-decort_cb_disk_snapshot_list-получение-списка-снимков-состояния-диска.md @@ -0,0 +1,35 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_disk_snapshot_list** служит для получения списка снимков состояния диска. + +## Аргументы +_Data source_ функция **decort_cb_disk_snapshot_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| disk_id | int | :heavy_check_mark: | ID диска для получения списка снимком состояния | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk_snapshot_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |--------| --- | +| label | string | Название снимка | +| guid | string | ID снимка | +| timestamp | int | Время снимка | +| reference_id | string | ID ссылки | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | ID набора снимков, в котором лежит снимок состояния | +| snap_set_time | int | Время набора | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_disk_snapshot_list**: +```terraform +data "decort_cb_disk_snapshot_list" "dsl" { + disk_id = 11111 +} +# once the above directive completes, disk snapshot list will be accessible +# as data.decort_cb_disk_snapshot_list.dsl.items +``` + +После успешного завершения такого вызова **decort_cb_disk_snapshot_list** в переменной `data.decort_cb_disk_snapshot_list.dsl.items` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index 8bf765c..08fdeb5 100644 --- a/Home.md +++ b/Home.md @@ -117,7 +117,7 @@ Terraform провайдер для платформы DECORT с API верси 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)