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

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

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

| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| page | int | :x: | Номер страницы результата |
| per_page | int | :x: | Количество результатов на странице |
| sort_by | string | :x: | Сортировка по одному из поддерживаемых полей |
| sort_order | string | :x: | Порядок сортировки |
| port_info | string | :x: | Объем информации |
| hostname | string | :x: | Фильтр по имени хоста |
| display_name | string | :x: | Фильтр по отображаемому имени гипервизора |
| ip | string | :x: | Фильтр по IP гипервизора |
| created_from | string | :x: | Фильтр по нижней границе даты создания |
| created_to | string | :x: | Фильтр по верхней границе даты создания |
| updated_from | string | :x: | Фильтр по нижней границе даты обновления |
| updated_to | string | :x: | Фильтр по верхней границе даты обновления |

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

| Параметр | Тип | Описание |
| --- | --- | --- | 
| Параметр | Тип | Описание |
| --- | --- | --- | 
| name | string | Имя гипервизора |
| created_at | string | Время создания гипервизора |
| display_name | string | Отображаемое имя гипервизора |
| hostname | string | Имя хоста |
| ip | string | IP гипервизора |
| synced_at | string | Время синхронизации гипервизора |
| ports | Struct [см. ниже](#описание-структуры-ports) | Порты гипервизора |
| status | string | Статус гипервизора |


### Описание структуры ports
| Параметр | Тип | Описание |
| --- | --- | --- | 
| data | []Struct [см. ниже](#описание-структуры-port) | Данные портов |
| info | Struct [см. ниже](#описание-структуры-info) | Количество портов |

### Описание структуры port
| Параметр | Тип | Описание |
| --- | --- | --- | 
| id | string | ID порта |
| unique_identifier | string | Уникальный идентификатор порта |
| display_name | string | Отображаемое имя гипервизора |
| up | bool | Работает ли порт |


### Описание структуры info
| Параметр | Тип | Описание |
| --- | --- | --- | 
| active_ports | int | Количество работающих портов |
| total_ports | int | Общее количество портов |


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

```terraform
data "decort_sdn_hypervisor_list" "test" {
  #номер страницы результата
  #опциональный параметр
  #тип - целое число
  #page = 1

  #количество результатов на странице
  #опциональный параметр
  #тип - целое число
  #per_page = 2

  #сортировка по одному из поддерживаемых полей
  #опциональный параметр
  #тип - строка
  #возможные значения - name, hostname, last_sync, display_name, ip, created_at, updated_at
  #sort_by = "created_at"

  #порядок сортировки
  #опциональный параметр
  #тип - строка
  #возможные значения - asc, desc
  #sort_order = "asc"

  #объем информации
  #опциональный параметр
  #тип - строка
  #возможные значения - detailed, general
  #port_info = "detailed"

  #хостнейм
  #опциональный параметр
  #тип - строка
  #hostname = "hostname"

  #фильтр по отображаемому имени
  #опциональный параметр
  #тип - строка
  #display_name = "name"

  #IP
  #опциональный параметр
  #тип - строка
  #ip = "192.168. 123.132"

  #фильтр по нижней границе даты создания
  #опциональный параметр
  #тип - строка
  #значение по умолчанию - null
  #created_from = "2023-01-01T00:00:00Z"

  #фильтр по верхней границе даты создания
  #опциональный параметр
  #тип - строка
  #значение по умолчанию - null
  #created_to = "2023-01-01T00:00:00Z"

  #фильтр по нижней границе даты обновления
  #опциональный параметр
  #тип - строка
  #значение по умолчанию - null
  #updated_from = "2023-01-01T00:00:00Z"

  #фильтр по верхней границе даты обновления
  #опциональный параметр
  #тип - строка
  #значение по умолчанию - null
  #updated_to = "2023-01-01T00:00:00Z"
}
```

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

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

