update data: vins, vins_list; add data vins list_deleted, nat_rule_list, ext_net_list, ip_list, static_route, static_route_list, audits
@@ -0,0 +1,294 @@
|
|||||||
|
Функция доступна в провайдере версии 3.0 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins** служит для получения информации об уже существующем виртуальном сетевом сегменте (Virtual Network Segment, ViNS).
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------|--------|--------------------|-----------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | id vins |
|
||||||
|
| reason | string | :x: | Причина запроса |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins** возвращает в указанную при вызове переменную следующие значения:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| vins_id | int | id vins |
|
||||||
|
| vnf_dev | []Struct [см. ниже](#описание-структуры-vnf_dev) | Виртуальный маршрутизатор внутренней сети |
|
||||||
|
| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| created_by | string | Аккаунт, создавший vins |
|
||||||
|
| created_time | int | Время создания vins |
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию |
|
||||||
|
| deleted_by | string | Пользователь, удаливший vins |
|
||||||
|
| deleted_time | int | Время удаления vins |
|
||||||
|
| description | string | Текстовое описание ViNS. |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| lock_status | string | Статус доступности |
|
||||||
|
| manager_id | int | Manager id |
|
||||||
|
| manager_type | string | Type of manager |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| name | string | Имя ViNS. |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| network | string | Информация о сети |
|
||||||
|
| pre_reservations_num | int | Кол-во зарезервированных ip адресов |
|
||||||
|
| redundant | bool | Redudant |
|
||||||
|
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
|
||||||
|
| rg_name | string | Имя ресурсной группы |
|
||||||
|
| sec_vnf_dev_id | int | ID sec внутренней сети для разработки |
|
||||||
|
| status | string | Статус vins |
|
||||||
|
| updated_by | string | Кем был обновлен vins |
|
||||||
|
| updated_time | int | Время последнего обновления vins |
|
||||||
|
| user_managed | bool | Флаг, управляется ли пользователем |
|
||||||
|
| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs |
|
||||||
|
| vxlan_id | int | Идентификатор vxlan |
|
||||||
|
|
||||||
|
### Описание структуры vnf_dev
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|---------------|---------------------------------------------------------|------------------------------------------------------|
|
||||||
|
| ckey | string | CKey |
|
||||||
|
| meta | []string | Мета информация |
|
||||||
|
| account_id | int | ID учетной записи |
|
||||||
|
| capabilities | []string | Возможности vnf_dev |
|
||||||
|
| config | []Struct [см. ниже](#описание-структуры-vnf_dev_config) | Конфигурация |
|
||||||
|
| config_saved | bool | Флаг, отвечающий за то сохранен ли конфиг |
|
||||||
|
| custom_precfg | bool | Флаг, отвечающий за то, есть ли кастомный пре-конфиг |
|
||||||
|
| description | string | Описание |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| id | int | ID виртуального маршрутизатора внутренней сети |
|
||||||
|
| interfaces | []Struct [см. ниже](#описание-структуры-interfaces) | Список интерфейсов подключений |
|
||||||
|
| lock_status | string | Статус доступности |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| name | string | Название виртуального маршрутизатора внутренней сети |
|
||||||
|
| status | string | Статус виртуального маршрутизатора внутренней сети |
|
||||||
|
| tech_status | string | Технический статус |
|
||||||
|
| type | string | Тип виртуального маршрутизатора внутренней сети |
|
||||||
|
| vins | []int | Список виртуальных сетей |
|
||||||
|
|
||||||
|
### Описание структуры vnf_dev_config
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-----------|----------------------------------------------------|-------------|
|
||||||
|
| mgmt | []Struct [см. ниже](#описание-структуры-mgmt) | Config Mgmt |
|
||||||
|
| resources | []Struct [см. ниже](#описание-структуры-resources) | Ресурсы |
|
||||||
|
|
||||||
|
### Описание структуры mgmt
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|--------------------|
|
||||||
|
| ip_addr | string | ip-адрес |
|
||||||
|
| password | string | Пароль |
|
||||||
|
| ssh_key | string | Публичный SSH ключ |
|
||||||
|
| user | string | Имя пользователя |
|
||||||
|
|
||||||
|
### Описание структуры resources
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|----------------|
|
||||||
|
| cpu | int | Количество CPU |
|
||||||
|
| ram | int | Количество RAM |
|
||||||
|
| stack_id | int | id стэка |
|
||||||
|
| uuid | string | UUID ресурса |
|
||||||
|
|
||||||
|
### Описание структуры interfaces
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------|----------------------------------------------|----------------------------------|
|
||||||
|
| conn_id | int | ID подключения |
|
||||||
|
| conn_type | string | Тип соединения |
|
||||||
|
| def_gw | string | Шлюз по умолчанию |
|
||||||
|
| enabled | bool | Флаг доступности |
|
||||||
|
| flipgroup_id | int | ID группы с плавающим ip-адресом |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| ip_address | string | IP адрес |
|
||||||
|
| listen_ssh | bool | открыт ли ssh connect |
|
||||||
|
| mac | string | MAC адрес интерфейса |
|
||||||
|
| name | string | Название интерфейса |
|
||||||
|
| net_id | int | ID сети |
|
||||||
|
| net_mask | int | Маска подсети |
|
||||||
|
| net_type | string | Тип сети |
|
||||||
|
| pci_slot | int | id pci слота |
|
||||||
|
| qos | []Struct [см. ниже](#описание-структуры-qos) | QOS |
|
||||||
|
| target | string | Цель сети |
|
||||||
|
| type | string | Тип интерфейса |
|
||||||
|
| vnfs | []int | Список VNFs |
|
||||||
|
|
||||||
|
### Описание структуры qos
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------|
|
||||||
|
| e_rate | int | Egress Rate |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| in_brust | int | In brust |
|
||||||
|
| in_rate | int | In rate |
|
||||||
|
|
||||||
|
### Описание структуры default_qos
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------|
|
||||||
|
| e_rate | int | Egress Rate |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| in_brust | int | In brust |
|
||||||
|
| in_rate | int | In rate |
|
||||||
|
|
||||||
|
### Описание структуры vnfs
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|-----------------------------------------------|--------------------|
|
||||||
|
| dhcp | []Struct [см. ниже](#описание-структуры-dhcp) | Информация о DHCP |
|
||||||
|
| gw | []Struct [см. ниже](#описание-структуры-gw) | Информация о шлюзе |
|
||||||
|
| nat | []Struct [см. ниже](#описание-структуры-nat) | NAT |
|
||||||
|
|
||||||
|
### Описание структуры nat
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------|-----------------------------------------------------|---------------------------------------------------------|
|
||||||
|
| ckey | string | CKey |
|
||||||
|
| meta | []string | Мета информация |
|
||||||
|
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
|
||||||
|
| created_time | int | Время создания |
|
||||||
|
| config | Struct{} [см. ниже](#описание-структуры-nat_config) | Информация о конфиге |
|
||||||
|
| devices | []Struct{} [см. ниже](#описание-структуры-devices) | Информация о девайсах |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| id | int | ID NAT |
|
||||||
|
| lock_status | string | Статус доступа виртуальной сети |
|
||||||
|
| milestones | int | Milestones |
|
||||||
|
| owner_id | int | ID владельца |
|
||||||
|
| owner_type | string | Тип владельца |
|
||||||
|
| pure_virtual | bool | Флаг, показывающий является ли ресурс чисто виртуальным |
|
||||||
|
| status | string | Статус |
|
||||||
|
| tech_status | string | Технический статус |
|
||||||
|
| type | string | Тип ресурса |
|
||||||
|
| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов |
|
||||||
|
|
||||||
|
### Описание структуры nat_config
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------------------------------------------------|-------------|
|
||||||
|
| net_mask | int | Маска сети |
|
||||||
|
| network | string | Сеть |
|
||||||
|
| rules | []Struct{} [см. ниже](#описание-структуры-rules) | Правила NAT |
|
||||||
|
|
||||||
|
### Описание структуры rules
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------------|--------|-------------------------|
|
||||||
|
| rule_id | int | ID правила |
|
||||||
|
| local_ip | string | Локальный IP адрес |
|
||||||
|
| local_port | int | Локальный порт |
|
||||||
|
| protocol | string | Протокол |
|
||||||
|
| public_port_end | int | Конец диапазона портов |
|
||||||
|
| public_port_start | int | Начало диапазона портов |
|
||||||
|
| vm_id | int | ID виртуальной машины |
|
||||||
|
| vm_name | string | Имя виртуальной машины |
|
||||||
|
|
||||||
|
### Описание структуры gw
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------|----------------------------------------------------|---------------------------------------------------------|
|
||||||
|
| ckey | string | CKey |
|
||||||
|
| meta | []string | Мета информация о шлюзе |
|
||||||
|
| account_id | int | Уникальный идентификатор владельца |
|
||||||
|
| config | Struct{} [см. ниже](#писание-структуры-gw_config) | Информация о конфиге |
|
||||||
|
| created_time | int | Время создания |
|
||||||
|
| devices | []Struct{} [см. ниже](#описание-структуры-devices) | Информация о девайсах |
|
||||||
|
| gid | int | Grid ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| id | int | ID gw |
|
||||||
|
| lock_status | string | Статус доступа gw |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| owner_id | int | ID владельца |
|
||||||
|
| owner_type | string | Тип владельца |
|
||||||
|
| pure_virtual | bool | Флаг, показывающий является ли ресурс чисто виртуальным |
|
||||||
|
| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов |
|
||||||
|
| status | string | Статус gw |
|
||||||
|
| tech_status | string | Технический статус gw |
|
||||||
|
| type | string | Тип gw |
|
||||||
|
|
||||||
|
### Описание структуры gw_config
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|----------------------------------------------|--------------------|
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| ext_net_id | int | ID внешней сети |
|
||||||
|
| ext_net_ip | string | IP внешней сети |
|
||||||
|
| ext_netmask | int | Маска внешней сети |
|
||||||
|
| qos | Struct{} [см. ниже](#описание-структуры-qos) | QOS |
|
||||||
|
|
||||||
|
### Описание структуры dhcp
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------|------------------------------------------------------|---------------------------------------------------------|
|
||||||
|
| ckey | string | CKey |
|
||||||
|
| meta | []string | Мета информация о dhcp |
|
||||||
|
| account_id | int | id аккаунта |
|
||||||
|
| config | []Struct [см. ниже](#описание-структуры-dhcp_config) | Конфигурация dhcp |
|
||||||
|
| created_time | int | Время создания |
|
||||||
|
| devices | []Struct{} [см. ниже](#описание-структуры-devices) | Информация о девайсах |
|
||||||
|
| gid | int | Grid ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| id | int | ID dhcp |
|
||||||
|
| lock_status | string | Статус доступа dhcp |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| owner_id | int | ID владельца |
|
||||||
|
| owner_type | string | Тип владельца |
|
||||||
|
| pure_virtual | bool | Флаг, показывающий является ли ресурс чисто виртуальным |
|
||||||
|
| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов |
|
||||||
|
| status | string | Статус dhcp |
|
||||||
|
| tech_status | string | Технический статус dhcp |
|
||||||
|
| type | string | Тип dhcp |
|
||||||
|
|
||||||
|
### Описание структуры dhcp_config
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------|-------------------------------------------------------|----------------------------|
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| dns | []string | Список dns |
|
||||||
|
| ip_end | string | Конец диапазона IP адресов |
|
||||||
|
| ip_start | string | Старт диапазона IP адресов |
|
||||||
|
| lease | int | Срок |
|
||||||
|
| net_mask | int | Маска подсети |
|
||||||
|
| network | string | Информация о сети |
|
||||||
|
| reservations | []Struct [см. ниже](#описание-структуры-reservations) | Информация о резервациях |
|
||||||
|
|
||||||
|
### Описание структуры reservations
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|--------|-----------------------|
|
||||||
|
| client_type | string | Тип клиента |
|
||||||
|
| description | string | Описание |
|
||||||
|
| domain_name | string | Имя домена |
|
||||||
|
| host_name | string | Имя хоста |
|
||||||
|
| ip | string | IP адрес |
|
||||||
|
| mac | string | MAC адрес |
|
||||||
|
| type | string | Тип сети |
|
||||||
|
| vm_id | int | ID виртуальной машины |
|
||||||
|
|
||||||
|
### Описание структуры devices
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------------------------------------------------|----------------------|
|
||||||
|
| primary | Struct{} [см. ниже](#описание-структуры-primary) | Первичная информация |
|
||||||
|
|
||||||
|
### Описание структуры primary
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------|
|
||||||
|
| dev_id | int | ID dev |
|
||||||
|
| iface01 | string | Интерфейс 1 |
|
||||||
|
| iface02 | string | Интерфейс 2 |
|
||||||
|
|
||||||
|
### Описание структуры routes
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|--------|-------------------------------------------------|
|
||||||
|
| compute_ids | []int | Список ID compute, которым предоствавлен доступ |
|
||||||
|
| route_id | int | ID статического маршрута |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| destination | string | IP целевой сети |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| gateway | string | IP шлюза |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins" "my_vins" {
|
||||||
|
vins_id = 10101
|
||||||
|
#reason = "report"
|
||||||
|
}
|
||||||
|
# Once the above directive completes, ViNS info will be accessible as
|
||||||
|
# data.decort_cb_vins.my_vins
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_vins** в переменной `data.decort_cb_vins.my_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ViNS следует использовать конструкцию `data.decort_cb_vins.my_vins.vins_id`
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
Функция доступна в провайдере версии 3.0 и выше.
|
|
||||||
|
|
||||||
_Data source_ функция **decort_vins** служит для получения информации об уже существующем виртуальном сетевом сегменте (Virtual Network Segment, ViNS).
|
|
||||||
|
|
||||||
## Аргументы
|
|
||||||
_Data source_ функция **decort_vins** принимает следующие аргументы:
|
|
||||||
|
|
||||||
| Аргумент | Тип | Обязательный | Описание |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.<br>ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).<br>Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. |
|
|
||||||
| account_id | int | :x: | Идентификатор подписчика ("account"), в котором находится данный ViNS.<br>Данный параметр игнорируется, если задан ненулевой `rg_id`, так как в этом случае подразумевается, что осуществляется поиск ViNS на уровне указанной ресурсной группы. |
|
|
||||||
| rg_id | int | :x: | Идентификатор ресурсной группы, в которой находится данный ViNS.<br>Если необходимо найти ViNS, созданный на уровне подписчика ("account"), то необходимо указать ненулевой `account_id`, а параметр `rg_id` не задавать. |
|
|
||||||
|
|
||||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанной учётной записи ("account") и/или ресурсной группе. В противном случае возникнет ошибка доступа.
|
|
||||||
|
|
||||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
|
||||||
|
|
||||||
## Возвращаемые значения
|
|
||||||
В случае успешного выполнения _data source_ функция **decort_vins** возвращает в указанную при вызове переменную следующие значения:
|
|
||||||
|
|
||||||
| Параметр | Тип | Описание |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
|
|
||||||
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
|
||||||
| description | string | Текстовое описание ViNS. |
|
|
||||||
| ext_ip_addr | string | IP адрес подключения ViNS к внешней сети. Если ViNS не подключен к внешней сети, то данный параметр содержит пустую строку.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
|
|
||||||
| ext_net_id | int | Идентификатор внешней сети, к которой подключен данный ViNS. Признаком подключения ViNS ко внешней сети является ненулевое значение этого параметра.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
|
|
||||||
| id | int| Идентификатор ViNS. |
|
|
||||||
| ipcidr | string | IP CIDR, присвоенный внутреннему сегменту данного ViNS. |
|
|
||||||
| name | string | Имя ViNS. |
|
|
||||||
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
|
|
||||||
|
|
||||||
|
|
||||||
## Пример использования
|
|
||||||
Пример вызова _data source_ функции **decort_vins**:
|
|
||||||
|
|
||||||
```terraform
|
|
||||||
data "decort_vins" "my_vins" {
|
|
||||||
name = "Vins01" # this is the name of pre-existing ViNS
|
|
||||||
rg_id = 500 # this is the ID of the resource group, where ViNS named "Vins01" is found
|
|
||||||
}
|
|
||||||
# Once the above directive completes, ViNS ID will be accessible as
|
|
||||||
# data.decort_vins.my_vins.id
|
|
||||||
```
|
|
||||||
|
|
||||||
Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
|
||||||
|
|
||||||
После успешного завершения такого вызова **decort_vins** в переменной `data.decort_vins.my_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ViNS следует использовать конструкцию `data.decort_vins.my_vins.id`
|
|
||||||
94
06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md
Normal file
94
06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
Функция доступна в провайдере версии 3.0 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_list** служит для получения информации об имеющихся виртуальных сетях.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_list** принимает следующие аргументы:
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| by_id | int | :x: | Фильтр по ID vins |
|
||||||
|
| name | string | :x: | Фильтр по имени vins |
|
||||||
|
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||||
|
| rg_id | int | :x: | Фильтр по ID рес. группы |
|
||||||
|
| ext_ip | string | :x: | Фильтр по внешнему IP адресу |
|
||||||
|
| include_deleted | bool | :x: | Включение удаленных vins в результат поиска |
|
||||||
|
| page | int | :x: | Номер страниц |
|
||||||
|
| size | int | :x: | Размер страницы |
|
||||||
|
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| vins_id | int | id vins |
|
||||||
|
| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| created_by | string | Аккаунт, создавший vins |
|
||||||
|
| created_time | int | Время создания vins |
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию |
|
||||||
|
| deleted_by | string | Пользователь, удаливший vins |
|
||||||
|
| deleted_time | int | Время удаления vins |
|
||||||
|
| description | string | Текстовое описание ViNS. |
|
||||||
|
| external_ip | string | Внешний ip - адрес |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| lock_status | string | Статус доступности |
|
||||||
|
| manager_id | int | Manager id |
|
||||||
|
| manager_type | string | Type of manager |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| name | string | Имя ViNS. |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| network | string | Информация о сети |
|
||||||
|
| pre_reservations_num | int | Кол-во зарезервированных ip адресов |
|
||||||
|
| pri_vnf_dev_id | int | ID внутренней сети для разработки |
|
||||||
|
| redundant | bool | Redudant |
|
||||||
|
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
|
||||||
|
| rg_name | string | Имя ресурсной группы |
|
||||||
|
| sec_vnf_dev_id | int | ID sec внутренней сети для разработки |
|
||||||
|
| status | string | Статус vins |
|
||||||
|
| updated_by | string | Кем был обновлен vins |
|
||||||
|
| updated_time | int | Время последнего обновления vins |
|
||||||
|
| user_managed | bool | Флаг, управляется ли пользователем |
|
||||||
|
| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs |
|
||||||
|
| vxlan_id | int | Идентификатор vxlan |
|
||||||
|
|
||||||
|
### Описание структуры default_qos
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------|
|
||||||
|
| e_rate | int | Egress Rate |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| in_brust | int | In brust |
|
||||||
|
| in_rate | int | In rate |
|
||||||
|
|
||||||
|
### Описание структуры vnfs
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|-----|-------------------|
|
||||||
|
| dhcp | int | ID DHCP |
|
||||||
|
| dns | int | dns id |
|
||||||
|
| fw | int | fw id |
|
||||||
|
| gw | int | Шлюз по умолчанию |
|
||||||
|
| nat | int | NAT vins id |
|
||||||
|
| vpn | int | vpn id |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_list**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_list" "vl" {
|
||||||
|
#by_id = 100
|
||||||
|
#name = "test"
|
||||||
|
#account_id = 11111
|
||||||
|
#rg_id = 100
|
||||||
|
#ext_ip = "test"
|
||||||
|
#include_deleted = true
|
||||||
|
#page = 1
|
||||||
|
#size = 1
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins list will be accessible
|
||||||
|
# as data.decort_cb_vins_list.vl.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_vins_list** в переменной `data.decort_cb_vins_list.vl` будут сохранены возвращаемые значения.
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
Функция доступна в провайдере версии 3.0 и выше.
|
|
||||||
|
|
||||||
_Data source_ функция **decort_vins_list** служит для получения информации об имеющихся виртуальных сетях.
|
|
||||||
|
|
||||||
## Аргументы
|
|
||||||
_Data source_ функция **decort_vins_list** принимает следующие аргументы:
|
|
||||||
| Аргумент | Тип | Обязательный | Описание |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| include_deleted | bool | :x: | Включение удаленных vins в результат поиска |
|
|
||||||
| page | int | :x: | Номер страниц |
|
|
||||||
| size | int | :x: | Размер страницы |
|
|
||||||
|
|
||||||
|
|
||||||
## Возвращаемые значения
|
|
||||||
В случае успешного выполнения _data source_ функция **decort_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
|
||||||
|
|
||||||
| Параметр | Тип | Описание |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| account_id | int | ID аккаунта - владельца виртуальной сети |
|
|
||||||
| account_name | string | Имя аккаунта - владельца виртуальной |
|
|
||||||
| created_by | string | Информация о создателе виртуальной сети |
|
|
||||||
| created_time | int | Время создания виртуальной сети |
|
|
||||||
| deleted_by | string | Информация о том, кто удалил виртуальную сеть |
|
|
||||||
| deleted_time | int | Время удаления виртуальной сети |
|
|
||||||
| external_ip | string | Внешний ip - адрес |
|
|
||||||
| vins_id | int | Идентификатор виртуальной сети |
|
|
||||||
| vins_name | string | Название виртуальной сети |
|
|
||||||
| network | string | Сеть |
|
|
||||||
| rg_id | int | Идентификатор ресурсной группы |
|
|
||||||
| rg_name | string | Название ресурсной группы |
|
|
||||||
| status | string | Статус виртуальной сети |
|
|
||||||
| updated_by | string | Кем виртуальная сеть была обновлена в последний раз |
|
|
||||||
| updated_time | int | Время последнего обновления |
|
|
||||||
| vxlan_id | int | Идентификатор vxlan |
|
|
||||||
|
|
||||||
## Пример использования
|
|
||||||
Пример вызова _data source_ функции **decort_vins_list**:
|
|
||||||
```terraform
|
|
||||||
data "decort_vins_list" "vl" {
|
|
||||||
#включение удаленных vins в результат
|
|
||||||
#опциональный параметр
|
|
||||||
#тип - булев тип
|
|
||||||
#если не задан - выводятся все неудаленные данные
|
|
||||||
#include_deleted = true
|
|
||||||
|
|
||||||
#номер страницы для отображения
|
|
||||||
#опциональный параметр
|
|
||||||
#тип - число
|
|
||||||
#если не задан - выводятся все доступные данные
|
|
||||||
#page = 1
|
|
||||||
|
|
||||||
#размер страницы
|
|
||||||
#опциональный параметр
|
|
||||||
#тип - число
|
|
||||||
#если не задан - выводятся все доступные данные
|
|
||||||
#size = 1
|
|
||||||
|
|
||||||
}
|
|
||||||
# once the above directive completes, vins list will be accessible
|
|
||||||
# as data.decort_vins_list.vl.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_vins_list** в переменной `data.decort_vins_list.vl` будут сохранены возвращаемые значения.
|
|
||||||
92
06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md
Normal file
92
06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md
Normal file
@@ -0,0 +1,92 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_list_deleted** служит для получения информации об удаленных виртуальных сетях.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_list_deleted** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| by_id | int | :x: | Фильтр по ID vins |
|
||||||
|
| name | string | :x: | Фильтр по имени vins |
|
||||||
|
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||||
|
| rg_id | int | :x: | Фильтр по ID рес. группы |
|
||||||
|
| ext_ip | string | :x: | Фильтр по внешнему IP адресу |
|
||||||
|
| page | int | :x: | Номер страниц |
|
||||||
|
| size | int | :x: | Размер страницы |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_list_deleted** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| vins_id | int | id vins |
|
||||||
|
| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| created_by | string | Аккаунт, создавший vins |
|
||||||
|
| created_time | int | Время создания vins |
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию |
|
||||||
|
| deleted_by | string | Пользователь, удаливший vins |
|
||||||
|
| deleted_time | int | Время удаления vins |
|
||||||
|
| description | string | Текстовое описание ViNS. |
|
||||||
|
| external_ip | string | Внешний ip - адрес |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| lock_status | string | Статус доступности |
|
||||||
|
| manager_id | int | Manager id |
|
||||||
|
| manager_type | string | Type of manager |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| name | string | Имя ViNS. |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| network | string | Информация о сети |
|
||||||
|
| pre_reservations_num | int | Кол-во зарезервированных ip адресов |
|
||||||
|
| pri_vnf_dev_id | int | ID внутренней сети для разработки |
|
||||||
|
| redundant | bool | Redudant |
|
||||||
|
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
|
||||||
|
| rg_name | string | Имя ресурсной группы |
|
||||||
|
| sec_vnf_dev_id | int | ID sec внутренней сети для разработки |
|
||||||
|
| status | string | Статус vins |
|
||||||
|
| updated_by | string | Кем был обновлен vins |
|
||||||
|
| updated_time | int | Время последнего обновления vins |
|
||||||
|
| user_managed | bool | Флаг, управляется ли пользователем |
|
||||||
|
| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs |
|
||||||
|
| vxlan_id | int | Идентификатор vxlan |
|
||||||
|
|
||||||
|
### Описание структуры default_qos
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------|
|
||||||
|
| e_rate | int | Egress Rate |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| in_brust | int | In brust |
|
||||||
|
| in_rate | int | In rate |
|
||||||
|
|
||||||
|
### Описание структуры vnfs
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|-----|-------------------|
|
||||||
|
| dhcp | int | ID DHCP |
|
||||||
|
| dns | int | dns id |
|
||||||
|
| fw | int | fw id |
|
||||||
|
| gw | int | Шлюз по умолчанию |
|
||||||
|
| nat | int | NAT vins id |
|
||||||
|
| vpn | int | vpn id |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_list_deleted**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_list_deleted" "vld" {
|
||||||
|
#by_id = 100
|
||||||
|
#name = "test"
|
||||||
|
#account_id = 11111
|
||||||
|
#rg_id = 100
|
||||||
|
#ext_ip = "test"
|
||||||
|
#page = 1
|
||||||
|
#size = 1
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins list deleted will be accessible
|
||||||
|
# as data.decort_cb_vins_list_deleted.vld.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_vins_list_deleted** в переменной `data.decort_cb_vins_list_deleted.vld` будут сохранены возвращаемые значения.
|
||||||
40
06.02.45-Data-функция-decort_cb_vins_nat_rule_list-получение-информации-о-правилах-переадресации-портов-для-сети-vins.md
Normal file
40
06.02.45-Data-функция-decort_cb_vins_nat_rule_list-получение-информации-о-правилах-переадресации-портов-для-сети-vins.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_nat_rule_list** служит для получения списка правил NAT (переадресации портов) на внутренней сети.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_nat_rule_list** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------| --- | --- |--------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID vins |
|
||||||
|
| reason | string | :x: | Причина запроса |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_nat_rule_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-----------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| id | int | ID правила |
|
||||||
|
| local_ip | string | Локальный IP адрес |
|
||||||
|
| local_port | int | Локальный порт |
|
||||||
|
| protocol | string | Протокол |
|
||||||
|
| public_port_end | int | Конец диапазона портов |
|
||||||
|
| public_port_start | int | Начало диапазона портов |
|
||||||
|
| vm_id | int | ID виртуальной машины |
|
||||||
|
| vm_name | string | Имя виртуальной машины |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_nat_rule_list**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_nat_rule_list" "nrl" {
|
||||||
|
vins_id = 10101
|
||||||
|
#reason = "test"
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins nat rule list will be accessible
|
||||||
|
# as data.decort_cb_vins_nat_rule_list.nrl.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_vins_nat_rule_list** в переменной `data.decort_cb_vins_nat_rule_list.nrl` будут сохранены возвращаемые значения.
|
||||||
36
06.02.46-Data-функция-decort_cb_vins_ext_net_list-получение-информации-о-внешних-сетях-vins.md
Normal file
36
06.02.46-Data-функция-decort_cb_vins_ext_net_list-получение-информации-о-внешних-сетях-vins.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_ext_net_list** служит для получения списка внешних сетей для внутренней сети.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_ext_net_list** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------| --- | --- |-------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID vins |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_ext_net_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-----------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| default_gw | string | Шлюз по умолчанию |
|
||||||
|
| ext_net_id | int | ID внешней сети |
|
||||||
|
| ip | string | IP внешней сети |
|
||||||
|
| prefix_len | int | Длина префикса |
|
||||||
|
| status | string | Статус |
|
||||||
|
| tech_status | string | Технический статус|
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_ext_net_list**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_ext_net_list" "enl" {
|
||||||
|
vins_id = 10101
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins external networks list will be accessible
|
||||||
|
# as data.decort_cb_vins_ext_net_list.enl.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_vins_ext_net_list** в переменной `data.decort_cb_vins_ext_net_list.enl` будут сохранены возвращаемые значения.
|
||||||
37
06.02.47-Data-функция-decort_cb_vins_ip_list-получение-резервированных-ip-адресов-dhcp-на-внутренней-сети-vins.md
Normal file
37
06.02.47-Data-функция-decort_cb_vins_ip_list-получение-резервированных-ip-адресов-dhcp-на-внутренней-сети-vins.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_ip_list** служит для получения резервированных ip-адресов dhcp на внутренней сети vins.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_ip_list** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------| --- | --- |-------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID vins |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_ip_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|--------|-----------------------|
|
||||||
|
| client_type | string | Тип клиента |
|
||||||
|
| domain_name | string | Имя домена |
|
||||||
|
| host_name | string | Имя хоста |
|
||||||
|
| ip | string | IP адрес |
|
||||||
|
| mac | string | MAC адрес |
|
||||||
|
| type | string | Тип сети |
|
||||||
|
| vm_id | int | ID виртуальной машины |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_ip_list**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_ip_list" "ipl" {
|
||||||
|
vins_id = 10101
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins ip list will be accessible
|
||||||
|
# as data.decort_cb_vins_ip_list.ipl.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_vins_ip_list** в переменной `data.decort_cb_vins_ip_list.ipl` будут сохранены возвращаемые значения.
|
||||||
36
06.02.48-Data-функция-decort_cb_vins_static_route_list-получение-списка-статических-маршрутов-для-внутренней-сети-vins.md
Normal file
36
06.02.48-Data-функция-decort_cb_vins_static_route_list-получение-списка-статических-маршрутов-для-внутренней-сети-vins.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_static_route_list** служит для получения списка статических маршрутов для внутренней сети vins.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_static_route_list** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------| --- | --- |-------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID vins |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_static_route_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|--------|-----------------------|
|
||||||
|
| compute_ids | []int | Список ID compute, которым предоствавлен доступ |
|
||||||
|
| route_id | int | ID статического маршрута |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| destination | string | IP целевой сети |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| gateway | string | IP шлюза |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_static_route_list**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_static_route_list" "srl" {
|
||||||
|
vins_id = 10101
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins static route list will be accessible
|
||||||
|
# as data.decort_cb_vins_static_route_list.srl.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_vins_static_route_list** в переменной `data.decort_cb_vins_static_route_list.srl` будут сохранены возвращаемые значения.
|
||||||
39
06.02.49-Data-функция-decort_cb_vins_static_route-получение-статического-маршрута-для-внутренней-сети-vins.md
Normal file
39
06.02.49-Data-функция-decort_cb_vins_static_route-получение-статического-маршрута-для-внутренней-сети-vins.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_static_route** служит для получения статического маршрута для внутренней сети vins.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_static_route** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------|-----|--------------------|--------------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID внутренней сети |
|
||||||
|
| route_id | int | :heavy_check_mark: | ID статического маршрута |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_static_route** возвращает в указанную при вызове переменную, которая состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|-------------|--------|-------------------------------------------------|
|
||||||
|
| compute_ids | []int | Список ID compute, которым предоствавлен доступ |
|
||||||
|
| route_id | int | ID статического маршрута |
|
||||||
|
| vins_id | int | ID внутренней сети |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| destination | string | IP целевой сети |
|
||||||
|
| netmask | int | Маска сети |
|
||||||
|
| gateway | string | IP шлюза |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_static_route**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_static_route" "sr" {
|
||||||
|
vins_id = 10101
|
||||||
|
route_id = 1
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins static route will be accessible
|
||||||
|
# as data.decort_cb_vins_static_route.sr.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_vins_static_route** в переменной `data.decort_cb_vins_static_route.sr` будут сохранены возвращаемые значения.
|
||||||
35
06.02.50-Data-функция-decort_cb_vins_audits-получение-записей-аудита-для-внутренней-сети-vins.md
Normal file
35
06.02.50-Data-функция-decort_cb_vins_audits-получение-записей-аудита-для-внутренней-сети-vins.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_vins_audits** служит для получения записей аудита для внутренней сети vins.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_vins_audits** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|----------|-----|--------------------|--------------------------|
|
||||||
|
| vins_id | int | :heavy_check_mark: | ID внутренней сети |
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_vins_audits** возвращает в указанную при вызове переменную, которая состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|---------------|--------|-------------------|
|
||||||
|
| call | string | Вызов |
|
||||||
|
| response_time | float | Время ответа |
|
||||||
|
| status_code | int | Статус выполнения |
|
||||||
|
| time_stamp | float | Время выполнения |
|
||||||
|
| user | string | Имя пользователя |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_vins_audits**:
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_vins_audits" "audits" {
|
||||||
|
vins_id = 10101
|
||||||
|
}
|
||||||
|
# once the above directive completes, vins audits will be accessible
|
||||||
|
# as data.decort_cb_vins_audits.audits.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_vins_audits** в переменной `data.decort_cb_vins_audits.audits` будут сохранены возвращаемые значения.
|
||||||
11
Home.md
11
Home.md
@@ -118,7 +118,7 @@ Terraform провайдер для платформы DECORT с API верси
|
|||||||
[**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM) - получение информации о виртуальной машине, созданной на базе системы виртуализации KVM
|
[**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM) - получение информации о виртуальной машине, созданной на базе системы виртуализации KVM
|
||||||
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе) - получение информации о ресурсной группе
|
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе) - получение информации о ресурсной группе
|
||||||
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.03-Data-функция-decort_disk-получение-информации-о-диске) - получение информации о ресурсе хранения ("disk")
|
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.03-Data-функция-decort_disk-получение-информации-о-диске) - получение информации о ресурсе хранения ("disk")
|
||||||
- [**decort_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.04-Data-функция-decort_vins-получение-информации-о-ViNS) - получение информации о виртуальном сетевом сегменте (Virtual Network Segment, "ViNS")
|
- [**decort_cb_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.04-Data-функция-decort_cb_vins-получение-информации-о-ViNS) - получение информации о виртуальном сетевом сегменте (Virtual Network Segment, "ViNS")
|
||||||
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.05-Data-функция-decort_account-получение-информации-об-аккаунте) - получение информации об аккаунте
|
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.05-Data-функция-decort_account-получение-информации-об-аккаунте) - получение информации об аккаунте
|
||||||
- [**decort_image_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.06-Data-функция-decort_image_list-получение-информации-об-образах) - получение информации об образах (_image_)
|
- [**decort_image_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.06-Data-функция-decort_image_list-получение-информации-об-образах) - получение информации об образах (_image_)
|
||||||
- [**decort_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.07-Data-функция-decort_image-получение-информации-об-образе) - получение информации об образе (_image_)
|
- [**decort_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.07-Data-функция-decort_image-получение-информации-об-образе) - получение информации об образе (_image_)
|
||||||
@@ -130,7 +130,7 @@ Terraform провайдер для платформы DECORT с API верси
|
|||||||
- [**decort_vgpu**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.13-Data-функция-decort_vgpu-получение-информации-о-виртуальном-графическом-устройстве) - получение информации о виртуальном графическом устройстве
|
- [**decort_vgpu**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.13-Data-функция-decort_vgpu-получение-информации-о-виртуальном-графическом-устройстве) - получение информации о виртуальном графическом устройстве
|
||||||
- [**decort_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах) - получение информации о всех доступных ресурсных группах.
|
- [**decort_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах) - получение информации о всех доступных ресурсных группах.
|
||||||
- [**decort_disk_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках) - получение информации о всех доступных дисках
|
- [**decort_disk_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках) - получение информации о всех доступных дисках
|
||||||
- [**decort_vins_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.16-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях) - получение информации о всех доступных виртуальных сетях
|
- [**decort_cb_vins_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях) - получение информации о всех доступных виртуальных сетях
|
||||||
- [**decort_account_audits_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.17-Data-функция-decort_account_audits_list-получение-информации-о-запросах-аккаунта) - получение информации о запросах аккаунта
|
- [**decort_account_audits_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.17-Data-функция-decort_account_audits_list-получение-информации-о-запросах-аккаунта) - получение информации о запросах аккаунта
|
||||||
- [**decort_account_computes_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.18-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes) - получение информации об используемых аккаунтом экземплярах computes
|
- [**decort_account_computes_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.18-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes) - получение информации об используемых аккаунтом экземплярах computes
|
||||||
- [**decort_account_disks_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.19-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках) - получение информации об используемых аккаунтом дисках
|
- [**decort_account_disks_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.19-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках) - получение информации об используемых аккаунтом дисках
|
||||||
@@ -158,6 +158,13 @@ Terraform провайдер для платформы DECORT с API верси
|
|||||||
- [**decort_cb_grid_list_consumption**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.41-Data-функция-decort_cb_grid_list_consumption-получение-потребленных-и-зарезервированных-ресурсов-во-всех-grid) - получение потребленных и зарезервированных ресурсов во всех grid
|
- [**decort_cb_grid_list_consumption**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.41-Data-функция-decort_cb_grid_list_consumption-получение-потребленных-и-зарезервированных-ресурсов-во-всех-grid) - получение потребленных и зарезервированных ресурсов во всех grid
|
||||||
- [**decort_cb_grid_get_consumption**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.42-Data-функция-decort_cb_grid_get_consumption-получение-потребленных-и-зарезервированных-ресурсов-в-grid) - получение потребленных и зарезервированных ресурсов в grid
|
- [**decort_cb_grid_get_consumption**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.42-Data-функция-decort_cb_grid_get_consumption-получение-потребленных-и-зарезервированных-ресурсов-в-grid) - получение потребленных и зарезервированных ресурсов в grid
|
||||||
- [**decort_cb_grid_get_status**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.43-Data-функция-decort_cb_grid_get_status-проверка-статуса-активности-текущей-среды) - проверка статуса активности текущей среды
|
- [**decort_cb_grid_get_status**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.43-Data-функция-decort_cb_grid_get_status-проверка-статуса-активности-текущей-среды) - проверка статуса активности текущей среды
|
||||||
|
- [**decort_cb_vins_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях) - получение информации о всех удаленных виртуальных сетях
|
||||||
|
- [**decort_cb_vins_nat_rule_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.45-Data-функция-decort_cb_vins_nat_rule_list-получение-информации-о-правилах-переадресации-портов-для-сети-vins) - получение информации о правилах переадресации портов для сети vins
|
||||||
|
- [**decort_cb_vins_ext_net_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.46-Data-функция-decort_cb_vins_ext_net_list-получение-информации-о-внешних-сетях-vins) - получение информации о внешних сетях vins
|
||||||
|
- [**decort_cb_vins_ip_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.47-Data-функция-decort_cb_vins_ip_list-получение-резервированных-ip-адресов-dhcp-на-внутренней-сети-vins) - получение резервированных ip-адресов dhcp на внутренней сети vins
|
||||||
|
- [**decort_cb_vins_static_route_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.48-Data-функция-decort_cb_vins_static_route_list-получение-списка-статических-маршрутов-для-внутренней-сети-vins) - получение списка статических маршрутов для внутренней сети vins
|
||||||
|
- [**decort_cb_vins_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.49-Data-функция-decort_cb_vins_static_route-получение-статического-маршрута-для-внутренней-сети-vins) - получение статического маршрута для внутренней сети vins
|
||||||
|
- [**decort_cb_vins_audits**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.50-Data-функция-decort_cb_vins_audits-получение-записей-аудита-для-внутренней-сети-vins) - получение записей аудита для внутренней сети vins
|
||||||
-->
|
-->
|
||||||
|
|
||||||
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
|
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
|
||||||
|
|||||||
Reference in New Issue
Block a user