Функция доступна в версии провайдера 4.10.1 и выше.

_Data source_ функция **decort_sdn_segment** служит для получения информации об уже существующем сегменте сети.

## Аргументы
_Data source_ функция **decort_sdn_segment** принимает следующие аргументы:

| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| segment_id | string | :heavy_check_mark: | Идентификатор экземпляра segment |
| access_group_id | string | :x: | Идентификатор группы доступа  |

## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_sdn_segment** возвращает в указанную при вызове переменную следующие значения:

| Параметр | Тип | Описание |
| --- | --- | --- | 
| access_group_id | string | Уникальный идентификатор группы доступа |
| access_group_name | string | Имя группы доступа |
| created_at | int | Когда создан сегмент |
| description | string | Описание сегмента | 
| dhcp_v4 | Struct [см. ниже](#описание-структуры-dhcp_v4) | Описание конфигурации dhcp v4 |
| dhcp_v6 | Struct [см. ниже](#описание-структуры-dhcp_v6) | Описание конфигурации dhcp v6 |
| display_name | string | Имя сегмента | 
| enabled | bool | Флаг доступности сегмента | 
| logical_ports_info | []Struct [см. ниже](#описание-структуры-entity) | Информация о логических портах |  
| routers | []Struct [см. ниже](#описание-структуры-entity) | Информация о роутерах |  
| status | []Struct [см. ниже](#описание-структуры-status) | Информация о статусе сегмента | 
| segment_id | int | Идентификатор экземпляра segment |
| subnet_v4 | string | Подсеть IPv4 для текущего сегмента |  
| subnet_v6 | string | Подсеть IPv6 для текущего сегмента |  
| updated_at | string | Когда обновлён сегмент |  
| version_id | int | Номер версии сегмента |          

### Описание структуры dhcp_v4
| Параметр | Тип | Описание |
| --- | --- | --- |
| dns | []string | Список DNS |
| excluded_address_ranges | []string | Список адресов для исключений |
| gateway | string | Шлюз |
| id | string | Уникальный идентификатор конфигурации |
| lease_time | int | Время на которое выдается адрес в секундах |
| server_ip | string | IP адрес сервера |
| server_mac | string | MAC адрес сервера |
| enabled | bool | Флаг активности конфигурации |

### Описание структуры dhcp_v6
| Параметр | Тип | Описание |
| --- | --- | --- |
| address_prefix | string | IPv6 префикс, в рамках которого выделяются IPv6 адреса |
| dns | []string | Список DNS |
| id | string | Уникальный идентификатор конфигурации |
| lease_time | int | Время на которое выдается адрес в секундах |
| server_mac | string | MAC адрес сервера |
| enabled | bool | Флаг активности конфигурации |

### Описание структуры entity
| Параметр | Тип | Описание |
| --- | --- | --- |
| display_name | string | Имя сущности | 
| id | string | Уникальный идентификатор сущности |

### Описание структуры status
| Параметр | Тип | Описание |
| --- | --- | --- |
| status | string | Статус сегмента |
| hypervisors | []Struct [см. ниже](#описание-структуры-hypervisor) | Список гипервизоров |

### Описание структуры hypervisor
| Параметр | Тип | Описание |
| --- | --- | --- |
| status | string | Статус |
| name | string | Имя гипервизора |
| display_name | string | Отображаемое имя гипервизора |
| hypervisor_status | string | Статус гипервизора |
| server_mac | string | MAC адрес сервера |
| synced_at | string | Время последней синхронизации |

## Пример использования
В нижеприведённом примере посредством вызова _data source_ функции **decort_sdn_segment** извлекается информация об уже существующем на платформе виртуальном сервере со следующими характеристиками:

```terraform
data "decort_sdn_segment" "name" {
  #идентификатор сегмента
  #обязательный параметр
  #тип - строка
  segment_id = "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"

  #идентификатор группы доступа
  #опциональный параметр
  #тип - строка
  #access_group_id = "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
}
```

Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.10.3/04.02-Инициализация-Terraform-провайдера-DECORT.md)).

После успешного завершения такого вызова **decort_sdn_segment** в переменной `data.decort_sdn_segment.name` будут сохранены возвращаемые значения. 
