ovirt_network – Модуль для управления логическими сетями в oVirt/RHV

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Модуль для управления логическими сетями в 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 булево		Варианты: нет да	Если истина, модуль загрузит дополнительные данные из API. Он загрузит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав `nested_attributes`.
id - добавлен в 2.8			Идентификатор сети, которую нужно управлять.
label - добавлен в 2.5			Имя метки, которую нужно назначить сети.
mtu -			Максимальный размер блока передачи (MTU) сети.
name - / обязательно			Имя сети, которую нужно управлять.
nested_attributes список			Указывает список атрибутов, которые должны быть загружены из API. Этот параметр применяется только когда `fetch_nested` равен истина.
poll_interval целое число		Значение по умолчанию: 3	Количество секунд, в течение которого модуль ожидает, прежде чем отправить другой запрос опроса о состоянии сущности.
state -		Варианты: present ← отсутствует	Сеть должна быть присутствующей или отсутствующей
timeout целое число		Значение по умолчанию: 180	Количество секунд, в течение которого модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
vlan_tag целое число			Указывает тег VLAN. ПРИМЕЧАНИЕ: для удаления vlan_tag используйте -1.
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: 10
    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_network:
    data_center: mydatacenter
    name: mynetwork
    external_provider: ovirt-provider-ovn

# Remove vlan_tag
- ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: -1

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
id строка	При успешном поиске сети.	Идентификатор управляемой сети Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c
network словарь	При успешном поиске сети.	Словарь всех атрибутов сети. Атрибуты сети можно найти на вашем экземпляре oVirt/RHV по следующему URL: 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.9/modules/ovirt_network_module.html