ovirt_network – Модуль для управления логическими сетями в oVirt/RHV
Новая версия с 2.3.
Обзор
- Модуль для управления логическими сетями в oVirt/RHV
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр ca_file не задан, используется системный хранилище сертификатов CA.Значение по умолчанию задаётся переменной окружения OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задаётся переменной окружения OVIRT_HOSTNAME. Требуется либо url, либо hostname. | ||
| insecure булево |
| Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos булево |
| Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию задаётся переменной окружения OVIRT_PASSWORD. | ||
| token строка | Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной окружения OVIRT_TOKEN. | ||
| url строка | Строка, содержащая URL API-сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной окружения OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задаётся переменной окружения OVIRT_USERNAME. | ||
| clusters - | Список словарей, описывающих, как сеть управляется в конкретном кластере. | ||
| assigned булево |
|
истина, если сеть должна быть назначена кластеру. По умолчанию — истина. | |
| display булево |
|
истина, если сеть должна быть помечена как сетевой интерфейс отображения. | |
| gluster булево |
|
истина, если сеть должна быть помечена как сетевой интерфейс gluster. | |
| migration булево |
|
истина, если сеть должна быть помечена как сетевой интерфейс миграции. | |
| name - | Имя кластера. | ||
| required булево |
|
истина, если сеть должна оставаться работоспособной для всех хостов, связанных с этой сетью. | |
| comment - | Комментарий к сети. | ||
| data_center - | Имя ЦОД, где находится сеть. | ||
| description - | Описание сети. | ||
| external_provider - добавлен в 2.8 | Имя внешнего поставщика сети. | ||
| fetch_nested булево добавлен в 2.3 |
| Если истина, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. | |
| id - добавлен в 2.8 | Идентификатор сети, которую необходимо настроить. | ||
| label - добавлен в 2.5 | Имя метки, которая должна быть назначена сети. | ||
| mtu - | Максимальный размер передаваемого блока (MTU) сети. | ||
| name - / обязательно | Имя сети, которую необходимо настроить. | ||
| nested_attributes список добавлен в 2.3 | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только тогда, когда fetch_nested равно истина. | ||
| poll_interval целое число | По умолчанию: 3 | Количество секунд, в течение которых модуль ожидает, прежде чем отправить ещё один запрос на проверку состояния сущности. | |
| state - |
| Сеть должна быть присутствующей или отсутствовать | |
| timeout целое число | По умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в желаемое состояние. | |
| vlan_tag - | Укажите тег VLAN. | ||
| vm_network булево |
| Если истина, сеть будет помечена как сеть для ВМ. Сетевой интерфейс ВМ переносит трафик, относящийся к виртуальной машине. | |
| wait булево |
| yes если модуль должен ждать, пока сущность не перейдёт в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create network
- ovirt_network:
data_center: mydatacenter
name: mynetwork
vlan_tag: 1
vm_network: true
# Remove network
- ovirt_network:
state: absent
name: mynetwork
# Change Network Name
- ovirt_network:
id: 00000000-0000-0000-0000-000000000000
name: "new_network_name"
data_center: mydatacenter
# Add network from external provider
- ovirt_networks:
data_center: mydatacenter
name: mynetwork
external_provider: ovirt-provider-ovn
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — это поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успешном поиске сети. | Идентификатор управляемой сети Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| network словарь | При успешном поиске сети. | Словарь всех атрибутов сети. Атрибуты сети можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network. |
Статус
- Интерфейс этого модуля не гарантируется как обратная совместимость. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/ovirt_network_module.html
