# Модуль decort_sdn_hypervisor
## Обзор модуля

Модуль **decort_sdn_hypervisor** предназначен для выполнения следующих действий над гипервизором SDN:
- **получить основную информацию о гипервизоре и его портах** (см. [возвращаемые значения](#возвращаемые-значения) и [примеры](#получить-основную-информацию-о-гипервизоре))
- **удалить** (см. [параметр state](#state) и [примеры](#удалить))
- **изменить отображаемое имя** (см. [параметр display_name](#display_name) и [примеры](#изменить-отображаемое-имя))
## Параметры модуля
Ниже приведен список параметров для модуля **decort_sdn_hypervisor** (за исключением [общих параметров](./введение.md#общие-параметры-модулей)):

<table>
  <tr>
    <th colspan="3">Параметр</th>
    <th>Тип</th>
    <th>Описание</th>
  </tr>
  <tr>
    <td colspan="3">
      <a name="display_name">
        display_name
      </a>
    </td>
    <td>
      (str)
    </td>
    <td>
      Отображаемое имя гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      name
    </td>
    <td>
      (str)
    </td>
    <td>
      Имя гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      port_info
    </td>
    <td>
      (str)
      <br>Значения:
      <br><code>detailed</code>
      <br><code>general</code>
    </td>
    <td>
      Позволяет получить информацию о портах гипервизора, в зависимости от выбранного значения.
      <br><code>detailed</code> - получить список портов и информацию об их количестве.
      <br><code>general</code> - получить информацию о количестве портов.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      <a name="state">
        state
      </a>
    </td>
    <td>
      (str)
      <br>Значения:
      <br><code>absent</code>
    </td>
    <td>
      Целевое состояние гипервизора.
      <br><code>absent</code> - отсутствует. Если существует, будет удален.
    </td>
  </tr>
</table>

## Возвращаемые значения
Модуль **decort_sdn_hypervisor** возвращает информацию о гипервизоре в виде словаря `facts` со следующими ключами:

<table>
  <tr>
    <th colspan="3">
      Ключ
    </th>
    <th>
      Тип
      <br>данных
    </th>
    <th>
      Описание
    </th>
  </tr>
  <tr>
    <td colspan="3">
      created_at
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время создания в формате ISO 8601.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      display_name
    </td>
    <td>
      str
    </td>
    <td>
      Отображаемое имя гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      hostname
    </td>
    <td>
      str
    </td>
    <td>
      Имя хоста.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      ip
    </td>
    <td>
      str
    </td>
    <td>
      IP-адрес гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      name
    </td>
    <td>
      str
    </td>
    <td>
      Имя гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      ports
    </td>
    <td>
      null | dict[str, any]
    </td>
    <td>
      Словарь, описывающий информацию о портах гипервизора.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="2">
      data
    </td>
    <td>
      null | list[dict[str, any]]
    </td>
    <td>
      Список портов гипервизора.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      display_name
    </td>
    <td>
      str
    </td>
    <td>
      Отображаемое имя.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор порта.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      unique_identifier
    </td>
    <td>
      str
    </td>
    <td>
      Уникальный идентификатор порта.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      up
    </td>
    <td>
      bool
    </td>
    <td>
      Включен ли порт.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="2">
      info
    </td>
    <td>
      dict[str, int]
    </td>
    <td>
       Словарь, описывающий количество портов гипервизора.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      active_ports
    </td>
    <td>
      int
    </td>
    <td>
      Количество активных портов.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="1">
      total_ports
    </td>
    <td>
      int
    </td>
    <td>
      Всего портов.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус гипервизора.
    </td>
  </tr>
  <tr>
    <td colspan="3">
      synced_at
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время последней синхронизации в формате ISO 8601.
    </td>
  </tr>
</table>

## Примеры использования

### Получить основную информацию о гипервизоре
```
- name: Example
  hosts: localhost
  tasks:
    - name: Get SDN hypervisor info
      decort_sdn_hypervisor:
        # Параметры для авторизации упущены
        name: "{{ name }}"
```

### Получить основную информацию о гипервизоре и его портах
```
- name: Example
  hosts: localhost
  tasks:
    - name: Get SDN hypervisor and ports info 
      decort_sdn_hypervisor:
        # Параметры для авторизации упущены
        name: "{{ name }}"
        port_info: "{{ port_info }}"
```

### Удалить
```
- name: Example
  hosts: localhost
  tasks:
    - name: Delete SDN hypervisor
      decort_sdn_hypervisor:
        # Параметры для авторизации упущены
        name: "{{ name }}"
        state: absent
```

### Изменить отображаемое имя
```
- name: Example
  hosts: localhost
  tasks:
    - name: Update SDN hypervisor
      decort_sdn_hypervisor:
        # Параметры для авторизации упущены
        name: "{{ name }}"
        display_name: "{{ display_name }}"
```