ovirt_networks - Модуль для управления логическими сетями в oVirt/RHV
Новый в версии 2.3.
Обзор
- Модуль для управления логическими сетями в oVirt/RHV
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задаётся переменной окружения OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задаётся переменной окружения OVIRT_PASSWORD.url - Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной окружения OVIRT_URL. Требуется либо url либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задаётся переменной окружения OVIRT_HOSTNAME. Требуется либо url либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной окружения OVIRT_TOKEN.insecure - Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Сертификат, предоставленный сервером, будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задаётся переменной окружения OVIRT_CAFILE.kerberos - Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | |
| clusters | Список словарей, описывающих, как сеть управляется в конкретном кластере. name - Имя кластера.assigned - true, если сеть должна быть назначена кластеру. По умолчанию true.required - true, если сеть должна оставаться активной для всех хостов, связанных с этой сетью.display - true, если сеть должна быть помечена как сеть отображения.migration - true, если сеть должна быть помечена как сеть миграции.gluster - true, если сеть должна быть помечена как сеть gluster. | |
| comment | Комментарий к сети. | |
| data_center | Имя ЦОД, в котором расположена сеть. | |
| description | Описание сети. | |
| fetch_nested (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. | |
| label (добавлено в 2.5) | Имя метки, которую нужно назначить сети. | |
| mtu | Максимальный размер транспортного блока (MTU) сети. | |
| name обязательно | Имя сети, которую нужно управлять. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| poll_interval | По умолчанию: 3 | Количество секунд, в течение которых модуль ожидает, прежде чем отправлять следующий запрос о статусе сущности. |
| state |
| Сеть должна быть присутствующей или отсутствовать |
| timeout | По умолчанию: 180 | Количество секунд, в течение которых модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| vlan_tag | Укажите тег VLAN. | |
| vm_network | Если True, сеть будет помечена как сеть ВМ. Сеть ВМ переносит трафик, относящийся к виртуальной машине. | |
| wait |
True, если модуль должен ожидать, пока сущность перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create network
- ovirt_networks:
data_center: mydatacenter
name: mynetwork
vlan_tag: 1
vm_network: true
# Remove network
- ovirt_networks:
state: absent
name: mynetwork
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| id str | При успехе, если сеть найдена. | Идентификатор управляемой сети Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| network dict | При успехе, если сеть найдена. | Словарь всех атрибутов сети. Атрибуты сети можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Поддержка и техническое обслуживание модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Ondra Machacek (@machacekondra)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ovirt_networks_module.html
