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

added flipgroup: data, list, resource

loskutovanl
2023-11-22 13:14:06 +03:00
parent 04e9fb2c05
commit 3232847125
4 changed files with 230 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
06.02.35-Data-функция-decort_cb_flipgroup-получение-информации-о-группе-с-плавающим-ip-адресом.md Normal file

@@ -0,0 +1,65 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_flipgroup** служит для получения информации о группе с плавающим ip-адресом.
## Аргументы
_Data source_ функция **decort_cb_flipgroup** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|--------------|-----|--------------------|----------------------------------------------|
| flipgroup_id | int | :heavy_check_mark: | ID группы с плавающим ip-адресом (flipgroup) |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_flipgroup** возвращает в указанную при вызове переменную, которая состоит из следующих параметров:
| Параметр | Тип | Описание |
|--------------|----------|-------------------------------------------------------------|
| account_id | int | ID аккаунта - владельца группы с плавающим ip-адресом |
| account_name | string | Имя аккаунта - владельца группы с плавающим ip-адресом |
| client_ids | []int | Список ID клиентов группы с плавающим ip-адресом |
| client_names | []string | Список имен клиентов группы с плавающим ip-адресом |
| client_type | string | Тип клиента |
| conn_id | int | ID подключения |
| conn_type | string | Тип подключения |
| created_by | string | Информация о том, кто создал группу с плавающим ip-адресом |
| created_time | int | Время создания группы с плавающим ip-адресом |
| default_gw | string | Шлюз по умолчанию |
| deleted_by | string | Информация о том, кто удалил группу с плавающим ip-адресом |
| deleted_time | int | Время удаления группы с плавающим ip-адресом |
| description | string | Описание группы |
| gid | int | Идентификатор площадки (grid id) |
| guid | int | ID ресурса |
| flipgroup_id | int | ID группы с плавающим ip-адресом |
| ip | string | IP адрес |
| milestones | int | Вехи |
| name | string | Название группы с плавающим ip-адресом |
| net_id | int | ID сети |
| net_type | string | Тип сети |
| network | string | Сеть |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Название ресурсной группы |
| status | string | Статус группы с плавающим ip-адресом |
| updated_by | string | Информация о том, кто обновил группу с плавающим ip-адресом |
| updated_time | int | Время обновления группы с плавающим ip-адресом |
## Пример использования
Пример вызова _data source_ функции **decort_cb_flipgroup**:
```terraform
data "decort_cb_flipgroup" "fg" {
#id группы
#обязательный параметр
#тип - число
flipgroup_id = 1111
}
# once the above directive completes, flipgroup will be accessible
# as data.decort_cb_flipgroup.fg
```
Данный пример подразумевает, что ранее по тексту 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_flipgroup** в переменной `data.decort_cb_flipgroup.fg` будут сохранены возвращаемые значения.

70
06.02.36-Data-функция-decort_cb_flipgroup_list-получение-информации-о-всех-группах-с-плавающим-ip-адресом.md Normal file

@@ -0,0 +1,70 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_flipgroup_list** служит для получения информации о всех группах с плавающим ip-адресом.
## Аргументы
_Data source_ функция **decort_cb_flipgroup_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|-----------|--------|--------------|--------------------------------------------------------------|
| name | string | :x: | Фильтр по названию группы с плавающим ip-адресом (flipgroup) |
| vins_id | int | :x: | Фильтр по ID виртуальной сети |
| vins_name | string | :x: | Фильтр по названию виртуальной сети |
| extnet_id | int | :x: | Фильтр по ID внешней сети |
| by_ip | string | :x: | Фильтр по ip-адресу |
| rg_id | int | :x: | Фильтр по ID ресурсной группы |
| by_id | int | :x: | Фильтр по ID группы с плавающим ip-адресом |
| page | int | :x: | Номер страницы для вывода |
| size | int | :x: | Размер страницы для вывода |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_flipgroup_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
|--------------|----------|-------------------------------------------------------|
| ckey | string | CKey |
| meta | []string | Мета информация |
| account_id | int | ID аккаунта - владельца группы с плавающим ip-адресом |
| client_ids | []int | Список ID клиентов группы с плавающим ip-адресом |
| client_type | string | Тип клиента |
| conn_id | int | ID подключения |
| conn_type | string | Тип подключения |
| default_gw | string | Шлюз по умолчанию |
| description | string | Описание группы |
| gid | int | Идентификатор площадки (grid id) |
| guid | int | ID ресурса |
| flipgroup_id | int | ID группы с плавающим ip-адресом |
| ip | string | IP адрес |
| milestones | int | Вехи |
| name | string | Название группы с плавающим ip-адресом |
| net_id | int | ID сети |
| net_type | string | Тип сети |
| net_mask | int | Маска подсети |
| status | string | Статус группы с плавающим ip-адресом |
## Пример использования
Пример вызова _data source_ функции **decort_cb_flipgroup_list**:
```terraform
data "decort_cb_flipgroup_list" "fgl" {
#by_id = 100
#name = "test"
#vins_id = 100
#vins_name = "test"
#extnet_id = 100
#by_ip = "1.1.1.1.1"
#rg_id = 11111
#page = 2
#size = 3
}
# once the above directive completes, flipgroup list items will be accessible
# as data.decort_cb_flipgroup_list.fgl.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_flipgroup_list** в переменной `data.decort_cb_flipgroup_list.fgl.items` будут сохранены возвращаемые значения.

91
07.02.16-Resource-функция-decort_cb_flipgroup-управление-плавающей-группой.md Normal file

@@ -0,0 +1,91 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Resource_ функция **decort_cb_flipgroup** служит для управления группами с плавающим ip-адресом (флипгруппами). Функция позволяет:
- Создать флипгруппу
- Удалить флипгруппу
- Добавить/удалить клиентов
- Изменить описание, название флипгруппы
## Аргументы
_Resource_ функция **decort_cb_flipgroup** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|-------------|--------|--------------------|-------------------------------------------------------------|
| account_id | int | :heavy_check_mark: | ID аккаунта |
| name | string | :heavy_check_mark: | Название флипгруппы |
| net_type | string | :heavy_check_mark: | Тип сети, EXTNET или ViNS |
| net_id | int | :heavy_check_mark: | ID сети |
| client_type | string | :heavy_check_mark: | Тип клиента (в данный момент поддерживается только compute) |
| ip | string | :x: | IP для ассоциации с группой |
| client_ids | []int | :x: | Список ID клиентов группы |
| desc | string | :x: | Описание плавающей группы |
## Возвращаемые значения
| Параметр | Тип | Описание |
|--------------|----------|--------------------------------------------|
| ckey | string | CKey |
| account_id | int | ID аккаунта |
| account_name | string | Имя аккаунта |
| client_ids | []int | Список ID подключенных к группе клиентов |
| client_names | []string | Список имен подключенных клиентов |
| client_type | string | Тип клиентов, подключаемых к группе |
| conn_id | int | ID подключения |
| conn_type | string | Тип подключения |
| created_by | string | Кем создана группа |
| created_time | int | Время создания |
| default_gw | string | Шлюз по умолчанию |
| deleted_by | string | Кем удалена группа |
| deleted_time | int | Время удаления |
| desc | string | Описание группы |
| flipgroup_id | int | ID флипгруппы |
| gid | int | Grid ID платформы |
| guid | int | ID флипгруппы на платформе (=flipgroup_id) |
| milestones | int | Веха |
| name | string | Наименование плавающей группы |
| net_id | int | ID сети |
| net_type | string | Тип сети (EXTNET/ViNS) |
| net_mask | int | Маска сети |
| network | string | Сеть |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Наименование ресурсной группы |
| status | string | Статус плавающей группы |
| updated_by | string | Кем обновлена группа |
| updated_time | int | Время обновления |
## Пример использования
```terraform
resource "decort_cb_flipgroup" "fg" {
# ID аккаунта
# Обязательный параметр
# int
account_id = 999
# Наименование Flipgroup
# Обязательный параметр
# string
name = "flipgroup_name"
# Тип сети (EXTNET, VINS)
# Обязательный параметр
# string
net_type = "EXTNET"
# ID сети
# Обязательный параметр
# int
net_id = 13
# Тип клиентов (в данный момент поддерживается только тип 'compute')
# Обязательный параметр
# string
client_type = "compute"
#ip = "127.0.0.1"
#client_ids = [11269]
#desc = "CHANGED"
}
```
После успешного завершения такого вызова **decort_cb_flipgroup** в переменной `decort_cb_flipgroup.fg` будут сохранены возвращаемые значения.

5
Home.md

@@ -149,6 +149,8 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_cb_extnet_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях) - получение информации о списке внешних сетей
- [**decort_cb_stack**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.33-Data-функция-decort_cb_stack-получение-информации-о-stack) - получение информации о вычислительном узле (stack)
- [**decort_cb_stack_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list) - получение информации о списке вычислительных узлов (stack)
- [**decort_cb_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.35-Data-функция-decort_cb_flipgroup-получение-информации-о-группе-с-плавающим-ip-адресом) - получение информации о группе с плавающим ip-адресом
- [**decort_cb_flipgroup_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.36-Data-функция-decort_cb_flipgroup_list-получение-информации-о-всех-группах-с-плавающим-ip-адресом) - получение информации о всех группах с плавающим ip-адресом
-->
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
@@ -193,7 +195,8 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_sep_config**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.02-Resource-функция-decort_sep_config-управление-конфигурацией-sep) - управление конфигурацией sep
- [**decort_pcidevice**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.01-Resource-функция-decort_pcidevice-управление-устройством) - управление pcidevice
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.06-Resource-функция-decort_account-управление-аккаунтом) - управление аккаунтом
-->
- [**decort_cb_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.16-Resource-функция-decort_cb_flipgroup-управление-плавающей-группой) - управление плавающей группой
-->
8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы)
- [Как хранить авторизационную информацию отдельно от tf-файла](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#81-Как-хранить-авторизационную-информацию-отдельно-от-tf-файла)