7.0 KiB
7.0 KiB
Модуль decort_sdn_hypervisor
Обзор модуля
Модуль decort_sdn_hypervisor предназначен для выполнения следующих действий над гипервизором SDN:
- получить основную информацию о гипервизоре и его портах (см. возвращаемые значения и примеры)
- удалить (см. параметр state и примеры)
- изменить отображаемое имя (см. параметр display_name и примеры)
Параметры модуля
Ниже приведен список параметров для модуля decort_sdn_hypervisor (за исключением общих параметров):
| Параметр | Тип | Описание | ||
|---|---|---|---|---|
| display_name | (str) | Отображаемое имя гипервизора. | ||
| name | (str) | Имя гипервизора. | ||
| port_info |
(str)
Значения: detailed
general
|
Позволяет получить информацию о портах гипервизора, в зависимости от выбранного значения.
detailed - получить список портов и информацию об их количестве.
general - получить информацию о количестве портов.
|
||
| state |
(str)
Значения: absent
|
Целевое состояние гипервизора.
absent - отсутствует. Если существует, будет удален.
|
||
Возвращаемые значения
Модуль decort_sdn_hypervisor возвращает информацию о гипервизоре в виде словаря facts со следующими ключами:
| Ключ |
Тип
данных |
Описание | ||
|---|---|---|---|---|
| created_at | str | Дата и время создания в формате ISO 8601. | ||
| display_name | str | Отображаемое имя гипервизора. | ||
| hostname | str | Имя хоста. | ||
| ip | str | IP-адрес гипервизора. | ||
| name | str | Имя гипервизора. | ||
| ports | null | dict[str, any] | Словарь, описывающий информацию о портах гипервизора. | ||
| data | null | list[dict[str, any]] | Список портов гипервизора. | ||
| display_name | str | Отображаемое имя. | ||
| id | str | Идентификатор порта. | ||
| unique_identifier | str | Уникальный идентификатор порта. | ||
| up | bool | Включен ли порт. | ||
| info | dict[str, int] | Словарь, описывающий количество портов гипервизора. | ||
| active_ports | int | Количество активных портов. | ||
| total_ports | int | Всего портов. | ||
| status | str | Статус гипервизора. | ||
| synced_at | str | Дата и время последней синхронизации в формате ISO 8601. | ||
Примеры использования
Получить основную информацию о гипервизоре
- 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 }}"