diff --git a/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md index b4e312c..8355c0a 100644 --- a/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md +++ b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md @@ -7,33 +7,39 @@ _Data source_ функция **decort_cb_extnet** принимает следу | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| net_id | int | :heavy_check_mark: | Идентификатор сети | +| extnet_id | int | :heavy_check_mark: | Идентификатор сети | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_extnet** возвращает следующие параметры: -| Параметр | Тип | Описание | -| --- | --- | --- | -| ckey | string | CKey | -| meta | []string | Meta | -| default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | -| desc | string | Описание внешней сети | -| free_ips | int | Кол-во свободных IP адресов | -| guid | int | ID внешней сети на платформе | -| ipcidr | string | IP CIDR | -| extnet_id | int | ID внешней сети | -| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | -| milestones | int | Вехи | -| network_id | int | ID сети | -| pri_vnfdev_id | int | Pri_VNFDev ID | -| pre_reservations_num | int | Кол-во резерваций | +| Параметр | Тип | Описание | +| --- | --- |---------------------------------------------| +| ckey | string | CKey | +| meta | []string | Meta информация | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| desc | string | Описание внешней сети | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| ipcidr | string | IP CIDR | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| name | string | Имя внешней сети | +| network_id | int | ID сети | | ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | -| shared_with | []int | ID объектов, использующих сеть | -| status | string | Статус внешней сети | -| vlan_id | int | vLAN ID | -| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | -| reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | +| pre_reservations_num | int | Кол-во резерваций | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vlan_id | int | vLAN ID | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| check_ips | []string | Список ip адресов для проверки | +| dns | []string | Список DNS адресов | +| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | +| gateway | string | IP шлюза | +| network | string | Информация о сети | +| prefix | int | Префикс | +| reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | ### Описание блока default_qos @@ -55,6 +61,7 @@ _Data source_ функция **decort_cb_extnet** принимает следу | Параметр | Тип | Описание | | --- | --- | --- | | client_type | string | Тип клиента | +| desc | string | Описание | | domain_name | string | Имя домена | | hostname | string | Имя хоста | | ip | string | IP адрес клиента | @@ -82,7 +89,7 @@ data "decort_cb_extnet" "e" { # Идентификатор сети # Обязательный параметр # Тип - число - net_id = 1111 + extnet_id = 1111 } ``` diff --git a/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md index a2971b0..2a24055 100644 --- a/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md +++ b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md @@ -7,39 +7,41 @@ _Data source_ функция **decort_cb_extnet_list** принимает сле | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| account_id | int | :x: | ID аккаунта для фильтрации результата поиска | | by_id | int | :x: | Фильтр по extnet ID | | name | string | :x: | Фильтр по имени extnet | | network | string | :x: | Фильтр по сети | | vlan_id | int | :x: | Фильтр по VLAN ID | | vnfdev_id | int | :x: | Фильтр по VnfDEV ID | | status | string | :x: | Фильтр по статусу | -| account_id | int | :x: | ID аккаунта для фильтрации результата поиска | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_extnet_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: -| Параметр | Тип | Описание | -| --- | --- | --- | -| ckey | string | CKey | -| meta | []string | Meta | -| default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | -| desc | string | Описание внешней сети | -| free_ips | int | Кол-во свободных IP адресов | -| guid | int | ID внешней сети на платформе | -| ipcidr | string | IP CIDR | -| extnet_id | int | ID внешней сети | -| milestones | int | Вехи | -| network_id | int | ID сети | -| pri_vnfdev_id | int | Pri_VNFDev ID | -| pre_reservations_num | int | Кол-во резерваций | +| Параметр | Тип | Описание | +| --- | --- |--------------------------------------------| +| ckey | string | CKey | +| meta | []string | Meta информация | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| desc | string | Описание внешней сети | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| ipcidr | string | IP CIDR | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| name | string | Имя внешней сети | +| network_id | int | ID сети | | ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | -| shared_with | []int | ID объектов, использующих сеть | -| status | string | Статус внешней сети | -| vlan_id | int | vLAN ID | -| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| pre_reservations_num | int | Кол-во резерваций | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vlan_id | int | vLAN ID | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| check_ips | []string | Список ip адресов для проверки | ### Описание блока default_qos @@ -66,11 +68,36 @@ data "decort_cb_extnet_list" "el" { #тип - число account_id = 13 + #фильтр по id внешней сети + #опциональный параметр + #тип - число + by_id = 100 + #Фильтр по имени extnet #необязательный параметр #тип - строка name = "test" + #фильтр по IP внешней сети + #опциональный параметр + #тип - строка + network = "test" + + #фильтр по id vlan + #опциональный параметр + #тип - число + vlan_id = 100 + + #фильтр по id vnfDevices + #опциональный параметр + #тип - число + vnfdev_id = 100 + + #фильтр по статусу + #опциональный параметр + #тип - строка + status = "ENABLED" + #кол-во страниц для вывода #опицональный параметр #тип - число @@ -82,7 +109,7 @@ data "decort_cb_extnet_list" "el" { size = 1 } # once the above directive completes, extnet list will be accessible -# as data.decort_extnet_list.el.items +# as data.decort_cb_extnet_list.el.items ``` -После успешного завершения такого вызова **decort_cb_extnet_list** в переменной `data.decort_cb_extnet_list.el` будут сохранены возвращаемые значения. +После успешного завершения такого вызова **decort_cb_extnet_list** в переменной `data.decort_cb_extnet_list.el.items` будут сохранены возвращаемые значения. diff --git a/06.02.97-Data-функция-decort_cb_extnet_default-получение-информации-о-внешней-сети-по-умолчанию.md b/06.02.97-Data-функция-decort_cb_extnet_default-получение-информации-о-внешней-сети-по-умолчанию.md new file mode 100644 index 0000000..79537a0 --- /dev/null +++ b/06.02.97-Data-функция-decort_cb_extnet_default-получение-информации-о-внешней-сети-по-умолчанию.md @@ -0,0 +1,27 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_extnet_default** служит для получения информации о доступной внешней сети по умолчанию. + +## Аргументы +_Data source_ функция **decort_cb_extnet_default** не имеет аргументов. + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet_default** возвращает следующий результат: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| extnet_id | int | ID сети по-умолчанию | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_extnet_default**: +```terraform +data "decort_cb_extnet_default" "ed" { + #нет входящих параметров +} +# once the above directive completes, extnet default id will be accessible +# as data.decort_cb_extnet_default.ed.extnet_id +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова **decort_cb_extnet_default** в переменной `data.decort_cb_extnet_default.ed` будут сохранены возвращаемые значения. diff --git a/06.02.98-Data-функция-decort_cb_extnet_static_route_list-получение-списка-статических-маршрутов-для-внешней-сети.md b/06.02.98-Data-функция-decort_cb_extnet_static_route_list-получение-списка-статических-маршрутов-для-внешней-сети.md new file mode 100644 index 0000000..c174bab --- /dev/null +++ b/06.02.98-Data-функция-decort_cb_extnet_static_route_list-получение-списка-статических-маршрутов-для-внешней-сети.md @@ -0,0 +1,36 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_extnet_static_route_list** служит для получения списка статических маршрутов для внешней сети extnet. + +## Аргументы +_Data source_ функция **decort_cb_extnet_static_route_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|----------| --- | --- |-----------------| +| extnet_id | int | :heavy_check_mark: | ID внешней сети | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet_static_route_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| compute_ids | []int | Список ID compute, которым предоствавлен доступ | +| destination | string | IP целевой сети | +| gateway | string | IP шлюза | +| guid | string | ID ресурса | +| netmask | string | Маска сети | +| route_id | int | ID статического маршрута | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_extnet_static_route_list**: +```terraform +data "decort_cb_extnet_static_route_list" "ensr" { + extnet_id = 10101 +} +# once the above directive completes, extnet static route list will be accessible +# as data.decort_cb_extnet_static_route_list.ensr.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_extnet_static_route_list** в переменной `data.decort_cb_extnet_static_route_list.ensr.items` будут сохранены возвращаемые значения. diff --git a/06.02.99-Data-функция-decort_cb_extnet_static_route-получение-статического-маршрута-для-внешней-сети.md b/06.02.99-Data-функция-decort_cb_extnet_static_route-получение-статического-маршрута-для-внешней-сети.md new file mode 100644 index 0000000..7db399a --- /dev/null +++ b/06.02.99-Data-функция-decort_cb_extnet_static_route-получение-статического-маршрута-для-внешней-сети.md @@ -0,0 +1,39 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_extnet_static_route** служит для получения статического маршрута для внешней сети. + +## Аргументы +_Data source_ функция **decort_cb_extnet_static_route** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|----------|-----|--------------------|--------------------------| +| extnet_id | int | :heavy_check_mark: | ID внешней сети | +| route_id | int | :heavy_check_mark: | ID статического маршрута | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet_static_route** возвращает в указанную при вызове переменную, которая состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-------------|--------|-------------------------------------------------| +| compute_ids | []int | Список ID compute, которым предоствавлен доступ | +| destination | string | IP целевой сети | +| gateway | string | IP шлюза | +| guid | string | ID ресурса | +| route_id | int | ID статического маршрута | +| netmask | string | Маска сети | +| extnet_id | int | ID внешней сети | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_extnet_static_route**: +```terraform +data "decort_cb_extnet_static_route" "sr" { + extnet_id = 10101 + route_id = 1 +} +# once the above directive completes, extnet static route will be accessible +# as data.decort_cb_extnet_static_route.sr +``` + +Данный пример подразумевает, что ранее по тексту 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_extnet_static_route** в переменной `data.decort_cb_extnet_static_route.sr` будут сохранены возвращаемые значения. diff --git a/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md index efe0830..7eecd47 100644 --- a/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md +++ b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md @@ -1,51 +1,73 @@ +Функция доступна в версии провайдера 4.5.1 и выше. + _Resource_ функция **decort_cb_extnet** служит для управления внешними сетями. **Для того чтобы использовать данную Resource функцию требуются права администратора!** ## Аргументы -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| name | string | :heavy_check_mark: | Наименование внешней сети | -| gid | int | :heavy_check_mark: | ID платформы | -| ipcidr | string | :heavy_check_mark: | CIDR адресация | -| vlan_id | int | :heavy_check_mark: | ID виртуальной локальной сети | -| gateway | string | :x: | Опциональный IP шлюза | -| dns | []string | :x: | Список DNS адресов | -| ntp | []string | :x: | Список NTP адресов | -| check_ips | []string | :x: | IP адреса для проверки доступности сети | -| virtual | bool | :x: | При значении true DHCP сервер **не** будет создан | -| start_ip | string | :x: | Начало диапазона включенных IP адресов | -| end_ip | string | :x: | Конец диапазона включенных IP адресов | -| vnfdev_ip | string | :x: | IP адрес для VNFDev | -| pre_reservations_num | int | :x: | Кол-во резерваций | -| ovs_bridge | string | :x: | Наименование моста OpenvSwitch внешней сети | -| enable | bool | :x: | Включить/Выключить внешнюю сеть | -| set_default | bool | :x: | При значении true - внешняя сеть становится дефолтной на платформе (невозможно отменить) | -| excluded_ips | []string | :x: | Список исключенных IP адресов | +| Аргумент | Тип | Обязательный | Описание | +| --- |--------------------------------------------------------------| --- |-----------------------------------------------------------------------------------------| +| name | string | :heavy_check_mark: | Наименование внешней сети | +| gid | int | :heavy_check_mark: | ID платформы | +| ipcidr | string | :heavy_check_mark: | CIDR адресация | +| vlan_id | int | :heavy_check_mark: | ID виртуальной локальной сети | +| gateway | string | :x: | Опциональный IP шлюза | +| dns | []string | :x: | Список DNS адресов | +| ntp | []string | :x: | Список NTP адресов | +| check_ips | []string | :x: | IP адреса для проверки доступности сети | +| virtual | bool | :x: | При значении true DHCP сервер **не** будет создан | +| desc | string |:x: | Текстовое опиание внешней сети | +| start_ip | string | :x: | Начало диапазона включенных IP адресов | +| end_ip | string | :x: | Конец диапазона включенных IP адресов | +| vnfdev_ip | string | :x: | IP адрес для VNFDev | +| pre_reservations_num | int | :x: | Кол-во резерваций | +| ovs_bridge | string | :x: | Наименование моста OpenvSwitch внешней сети | +| enable | bool | :x: | Включить/Выключить внешнюю сеть | +| set_default | bool | :x: | При значении true - внешняя сеть становится дефолтной на платформе (невозможно отменить) | +| excluded_ips | []string | :x: | Список исключенных IP адресов | +|excluded_ips_range| []Struct [см. ниже](#описание-блока-excluded_ips_range-args) |:x:| Задать диапазон исключенных IP адресов | +|default_qos| []Struct [см. ниже](#описание-блока-default_qos-args) |:x: | Стандартные значения QOS | +| restart | bool | :x: | Флаг перезапуска сети | +|migrate| int | :x: |ID stack на который происходит миграция| +|shared_with| []int |:x:| Список id аккаунтов, которым предоставлен доступ к extnet | + +### Описание блока excluded_ips_range args +| Аргумент | Тип | Обязательный | Описание | +| ----------- | ------ | ------------------ |--------------------------------------------------------| +| ip_start | string | :heavy_check_mark: | Начало диапазона IP, который должен быть явно исключен | +| ip_end | string | :heavy_check_mark: | Конец диапазона IP, который должен быть явно исключен | + +### Описание структуры default_qos args +| Параметр | Тип | Обязательный | Описание | +| --- | --- | --- |--- | +| e_rate | int |:x: | E rate | +| in_brust | int |:x: | In brust | +| in_rate | int |:x: | In rate | ## Возвращаемые значения В случае успешного выполнения _resource_ функция **decort_cb_extnet** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -| --- | --- | --- | -| ckey | string | CKey | -| meta | []string | Meta | -| default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | -| free_ips | int | Кол-во свободных IP адресов | -| guid | int | ID внешней сети на платформе | -| extnet_id | int | ID внешней сети | -| milestones | int | Вехи | -| network_id | int | ID сети | -| pri_vnfdev_id | int | Pri_VNFDev ID | -| pre_reservations_num | int | Кол-во резерваций | -| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | -| shared_with | []int | ID объектов, использующих сеть | -| status | string | Статус внешней сети | -| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | -| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | -| network | string | Сеть | -| prefix | string | Префикс | +| Параметр | Тип | Описание | +| --- |----------------------------------------------------| --- | +| ckey | string | CKey | +| meta | []string | Meta | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| network_id | int | ID сети | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| pre_reservations_num | int | Кол-во резерваций | +| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | +| network | string | Сеть | +| prefix | int | Префикс | +| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов | | reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | ### Описание блока default_qos @@ -75,6 +97,16 @@ _Resource_ функция **decort_cb_extnet** служит для управл | type | string | Тип исключения | | vm_id | int | VM ID | +### Описание структуры routes +| Параметр | Тип | Описание | +|-------------|--------|-------------------------------------------------| +| compute_ids | []int | Список ID compute, которым предоствавлен доступ | +| route_id | int | ID статического маршрута | +| guid | string | ID ресурса | +| destination | string | IP целевой сети | +| netmask | string | Маска сети | +| gateway | string | IP шлюза | + ### Описание блока reservations | Параметр | Тип | Описание | @@ -112,25 +144,125 @@ resource "decort_cb_extnet" "new_extnet" { # Тип - число vlan_id = 111 + # IP-адрес шлюза внешней сети + # Опциональный параметр + # Тип - строка + gateway = "test desc" + # Список DNS адресов # Опциональный параметр # Тип - массив строк dns = ["8.8.8.8", "9.9.9.9"] + # Список NTP адресов + # Опциональный параметр + # Тип - массив строк + ntp = ["ntp0.ntp-servers.net", "ntp1.ntp-servers.net"] + + # IP-адреса для проверки доступности сети + # Опциональный параметр + # Тип - массив строк + check_ips = ["191.255.0.0,", "191.255.0.0,"] + + # Если true - DHCP-сервер создан не будет + # Опциональный параметр + # Тип - булевое + virtual = true + # Описание # Опциональный параметр # Тип - строка desc = "test desc" + # Начало диапазона IP-адресов + # Опциональный параметр + # Тип - строка + start_ip = "191.255.0.0" + + # Окончание диапазона IP-адресов + # Опциональный параметр + # Тип - строка + end_ip = "191.255.0.40" + + # IP с которым будет создан vnfdev + # Опциональный параметр + # Тип - строка + vnfdev_ip = "191.255.0.20" + + # Количество предварительно созданных бронирований + # Опциональный параметр + # Тип - число + # По-умолчанию значение 128 + pre_reservations_num = 128 + + # Имя bridge Openvswitch для подключения к внешней сети + # Опциональный параметр + # Тип - строка + ovs_bridge = "some" + # Включение/Выключение внешней сети # Опциональный параметр (default = true) # Тип - булев enable = true + # Сделать сеть сетью по умолчанию + # Опциональный параметр + # Тип - булев + set_default = true + # Список исключенных IP адресов # Опциональный параметр # Тип - массив строк excluded_ips = ["192.168.0.4", "192.168.0.5"] + + # Диапазон исключенных IP адресов + # Опциональный параметр + excluded_ips_range { + # Начало диапазона + # Обязательный параметр + # Тип - строка + ip_start = "192.168.0.4" + + # Окончание диапазона + # Обязательный параметр + # Тип - строка + ip_end = "192.168.0.50" + } + + # Список id аккаунтов, которым предоставлен доступ к extnet + # Опциональный параметр + # Тип - массив чисел + shared_with = [112, 123] + + # Изменение настроек ограничения трафика сети + # Значение по умолчанию 0, то есть без ограничений + # Опциональный параметр + default_qos { + # Ограничение внутреннего трафика в кбит + # Опциональный параметр + # Тип - число + in_rate = 0 + + # Ограничение внутреннего burst трафика в кбит + # Опциональный параметр + # Тип - число + in_burst = 0 + + # Ограничение внешнего трафика в кбит + # Опциональный параметр + # Тип - число + e_rate = 0 + } + + # ID stack на который происходит миграция + # Опциональный параметр + # Тип - число + migrate = 1 + + # Перезапустить сеть + # Опциональный параметр + # Тип - булев + restart = true } ``` diff --git a/07.02.25-Resource-функция-decort_cb_extnet_static_route-управление-статическим-маршрутом-для-внешней-сети.md b/07.02.25-Resource-функция-decort_cb_extnet_static_route-управление-статическим-маршрутом-для-внешней-сети.md new file mode 100644 index 0000000..18f8272 --- /dev/null +++ b/07.02.25-Resource-функция-decort_cb_extnet_static_route-управление-статическим-маршрутом-для-внешней-сети.md @@ -0,0 +1,46 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_extnet_static_route** служит для управления статическим маршрутом для внешней сети. + +## Аргументы +_Resource_ функция **decort_cb_extnet_static_route** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|----------|--------|--------------------|------------------------------------------------------------------------| +| extnet_id | int | :heavy_check_mark: | ID сети extnet | +| destination | string | :heavy_check_mark: | IP-адрес сети назначения | +| gateway | string | :heavy_check_mark: | Шлюз по умолчанию. IP-адрес из пула свободных IP-адресов сети. | +| netmask | string | :heavy_check_mark: | Маска сети назначения в формате 255.255.255.255 | +| compute_ids | []int | :x: | Список ID виртуальных машин, которым предоставляется доступ к маршруту | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet_static_route** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +|-------------|--------|------------------------------------------------| +| extnet_id | int | ID сети extnet | +| compute_ids | []int | Список ID compute, которым предоствавлен доступ | +| route_id | int | ID статического маршрута | +| guid | string | ID ресурса | +| destination | string | IP целевой сети | +| netmask | string | Маска сети | +| gateway | string | IP шлюза | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_extnet_static_route**: + +```terraform +resource "decort_cb_extnet_static_route "my_route" { + extnet_id = 385 + destination = "192.168.201.0" + netmask = "255.255.255.255" + gateway = "192.168.201.40" + #compute_ids = [111,222] +} +# Once the above directive completes, extnet static route id will be accessible as +# decort_cb_extnet_static_route.my_route.route_id +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)). + +После успешного завершения такого вызова **decort_cb_extnet_static_route** в переменной `data.decort_cb_extnet_static_route.my_route` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index af18731..afad504 100644 --- a/Home.md +++ b/Home.md @@ -211,6 +211,9 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_kvmvm_snapshot_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.94-Data-функция-decort_cb_kvmvm_snapshot_list-получение-списка-снапшотов) - получение списка снапшотов - [**decort_cb_kvmvm_user_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.95-Data-функция-decort_cb_kvmvm_user_list-получение-информации-о-пользователях-компьюта) - получение информации о пользователях компьюта - [**decort_cb_kvmvm_vgpu_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.96-Data-функция-decort_cb_kvmvm_vgpu_list-получение-информации-о-доступных-компьюту-списка-виртуальных-графических-устройств) - получение информации о доступных компьюту списка виртуальных графических устройств + - [**decort_cb_extnet_default**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.97-Data-функция-decort_cb_extnet_default-получение-информации-о-внешней-сети-по-умолчанию) - получение информации о внешней сети по умолчанию + - [**decort_cb_extnet_static_route_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.98-Data-функция-decort_cb_extnet_static_route_list-получение-списка-статических-маршрутов-для-внешней-сети) - получение списка статических маршрутов для внешней сети + - [**decort_cb_extnet_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.99-Data-функция-decort_cb_extnet_static_route-получение-статического-маршрута-для-внешней-сети) - получение статического маршрута для внешней сети --> 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT) @@ -263,6 +266,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_vins_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.22-Resource-функция-decort_cb_vins_static_route-управление-статическим-маршрутом-для-внутренней-сети) - управление статическим маршрутом для внутренней сети - [**decort_cb_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска) - управление снимком диска - [**decort_cb_k8ci**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.24-Resource-функция-decort_cb_k8ci-управление-k8ci) - управление k8ci + - [**decort_cb_extnet_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.25-Resource-функция-decort_cb_extnet_static_route-управление-статическим-маршрутом-для-внешней-сети) - управление статическим маршрутом для внешней сети --> 8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы)