BASIS/terraform-provider-decort
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 69 Wiki Activity

Updated 06.01.14 Data функция decort_vins_list получение информации о всех виртуальных сетях (markdown)

Касим
2022-12-23 19:44:49 +03:00
parent 32a82bfd9f
commit edf4b37d41
1 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md

@@ -1,18 +1,25 @@
Функция доступна в провайдере версии 2.3 и выше.
_Data source_ функция **decort_vins_list** служит для получения информации об имеющихся виртуальных сетях.
_Data source_ функция **decort_vins_list** служит для получения списка удаленных виртуальных сетей (Vins).
## Аргументы
_Data source_ функция **decort_vins_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| include_deleted | bool | :x: | Включение удаленных vins в результат поиска |
| includedeleted | bool| :x: | Включить в результат удаленные балансировщики |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
В случае успешного выполнения _data source_ функция **decort_vins_list** возвращает следующие параметры:
| Параметр | Тип | Описание |
| --- | --- | --- |
| items | []Struct{} [см. ниже](#Описание-структуры-items) | Список аудитов |
### Описание структуры items
| Параметр | Тип | Описание |
| --- | --- | --- |
@@ -34,12 +41,14 @@ _Data source_ функция **decort_vins_list** принимает следу
| vxlan_id | int | Идентификатор vxlan |
## Пример использования
Пример вызова _data source_ функции **decort_vins_list**:
```terraform
data "decort_vins_list" "vl" {
data "decort_vins_list" "vins_list" {
#включение удаленных vins в результат
#опциональный параметр
#тип - булев тип
#тип - будев тип
#если не задан - выводятся все неудаленные данные
#include_deleted = true
@@ -56,10 +65,7 @@ data "decort_vins_list" "vl" {
#size = 1
}
# once the above directive completes, vins list will be accessible
# as data.decort_vins_list.vl.items
```
Данный пример подразумевает, что ранее по тексту 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_vins_list** в переменной `data.decort_vins_list.vins_list` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_vins_list** в переменной `data.decort_vins_list.vl` будут сохранены возвращаемые значения.