6.6 KiB
Data source функция dynamix_vfpool_list служит для получения информации о доступных vfpool устройствах
Аргументы
Data source функция dynamix_vfpool_list принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|---|---|---|---|
| by_id | int | ❌ | Фильтр по ID устройства vfpool |
| gid | int | ❌ | Фильтр по grid ID |
| name | string | ❌ | Фильтр по наименованию vfpool |
| description | string | ❌ | Фильтр по описанию |
| status | string | ❌ | Фильтр по состоянию vfpool |
| account_access | int | ❌ | Фильтр по имеющей доступ к vfpool учетной записи |
| rg_access | int | ❌ | Фильтр по имеющей доступ к vfpool ресурсной группе |
| sort_by | string | ❌ | Отсортировать вывод по значениям поля. Формат +/-(field) |
| page | int | ❌ | Номер страницы для вывода |
| size | int | ❌ | Размер страницы для вывода |
Возвращаемые значения
В случае успешного выполнения data source функция dynamix_vfpool_list возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
|---|---|---|
| account_access | []int | Список имеющих доступ к vfpool учетных записей |
| created_time | int | Дата создания |
| description | string | Описание |
| gid | int | Grid ID |
| guid | int | Guid пользователя vfpool |
| vfpool_id | int | ID устройства vfpool |
| name | string | Наименование vfpool |
| rg_access | []int | Список имеющих доступ к vfpool ресурсных групп |
| status | string | Состояние |
| updated_time | int | Дата изменения |
| vfs | []Struct см. ниже | Список параметров |
Описание структуры vfs
| Параметр | Тип | Описание |
|---|---|---|
| node_id | int | ID узла |
| vf_list | []Struct см. ниже | Список параметров |
Описание структуры vf_list
| Параметр | Тип | Описание |
|---|---|---|
| nic_name | string | Название сетевого адаптера |
| vfs_info | []Struct см. ниже | Список параметров |
Описание структуры vfs_info
| Параметр | Тип | Описание |
|---|---|---|
| id | int | Идентификатор |
| claimed | bool | Флаг наличия сетевого драйвера |
| vm_id | int | ID виртуальной машины |
Пример использования
Пример вызова data source функции dynamix_account_vfpool_list:
data "dynamix_vfpool_list" "vfpool_list" {
#фильтрация списка для получения информации о конкретном vfpool по его id
#необязательный параметр
#тип - целое число
#by_id = 1
#фильтрация списка для получения информации о vfpool, которые принадлежат к определенному GRID
#необязательный параметр
#тип - целое число
#gid = 1
#фильтрация списка для получения информации о конкретном vfpool по его имени
#необязательный параметр
#тип - строка
#name = "alpha-cpu-04"
#фильтрация списка для получения информации о конкретном vfpool по его описанию
#необязательный параметр
#тип - строка
#description = "some"
#фильтрация списка для получения информации о vfpool, которые имеют соответствующий статус
#необязательный параметр
#тип - строка
#status = "ENABLED"
#фильтрация списка для получения информации о vfpool, которые доступны конкретному аккаунту
#необязательный параметр
#тип - целое число
#account_access = 1
#фильтрация списка для получения информации о vfpool, которые доступны конкретной ресурсной группе
#необязательный параметр
#тип - целое число
#rg_access = 1
#сортировка по одному из поддерживаемых полей
#опциональный параметр
#тип - строка
#формат - "+поле" по возрастанию / "-поле" по убыванию
#sort_by = "+name"
#номер страницы для отображения
#опциональный параметр
#тип - целое число
#если не задан - выводятся все доступные данные
#page = 2
#размер страницы
#опциональный параметр
#тип - целое число
#если не задан - выводятся все доступные данные
#size = 3
}
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DYNAMIX см. соответствующий раздел).
После успешного завершения такого вызова dynamix_vfpool_list в переменной data.dynamix_vfpool_list.vfpool_list будут сохранены возвращаемые значения.