Create page data source decort_sep_consumption

stSolo
2022-05-04 14:56:03 +03:00
parent 33f8617004
commit c830727cd3

@@ -0,0 +1,43 @@
Функция доступна в провайдере версии 2.2 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_sep_consumption** служит для получения информации о загрузке переданного storage endpoint. Storage endpoint (sep) - точка доступа к хранилищу данных. Sep бывает четырех типов:
- des
- hitachi
- dorado
- tatlin
Каждый тип отличается возможной конфигурацией.
Загрузка sep состоит из загрузки его pool. Поэтому, информация предоставляется как по каждому pool'у, так и общая.
## Аргументы
_Data source_ функция **decort_sep_consumption** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| sep_id | int | :heavy_check_mark: | ID storage endpoint |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_sep_consumption** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| sep_id | int | id storage endpoint |
| by_pool | []Struct{<br/>name string<br/>disk_count int<br/>disk_usage int<br/>snapshot_count int<br/>snapshot_usage int<br/>usage int<br/>usage_limit int<br/>} | Список нагрузки по каждому pool<br/>Наименование pool<br/>Количество дисков<br/>Количество используемых дисков<br/>Количество snapshots<br/>Количество используемых snapshots<br/>Используемое место<br/>Максимально доступное пространство<br/> |
| total | Struct{<br/>capacity_limit int<br/>disk_count int<br/>disk_usage int<br/>snapshot_count int<br/>snapshot_usage int<br/>usage int<br/>usage_limit int<br/>} | Общая загрузка по каждому pool<br/>Ограничение емкости<br/>Количество дисков<br/>Количество используемых дисков<br/>Количество snapshots<br/>Количество используемых snapshots<br/>Используемое место<br/>Максимально доступное пространство<br/> |
| type | string | Тип sep |
## Пример использования
Пример вызова _data source_ функции **decort_sep_consumption**:
```terraform
data "decort_sep_consumption" "sc" {
sep_id = 1111
}
# once the above directive completes, sep will be accessible
# as data.decort_sep_consumption.sc
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/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_sep_consumption** в переменной `data.decort_sep_consumption.sc` будут сохранены возвращаемые значения.