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

Примечание

Этот модуль является частью коллекции ovirt.ovirt (версия 3.2.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ovirt.ovirt. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: ovirt.ovirt.ovirt_network.

Добавлен в ovirt.ovirt 1.0.0

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

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.4.0

Параметры

Параметр	Комментарии
auth словарь / обязательно	Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt:
ca_file строка	Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задаётся переменной среды `OVIRT_CAFILE`.
compress логическое значение	Флаг, указывающий, используется ли сжатие для соединения. Выбор: `false` `true` ← (по умолчанию)
headers словарь	Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу.
hostname строка	Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задаётся переменной среды `OVIRT_HOSTNAME`. Требуется либо `url`, либо `hostname`.
insecure логическое значение	Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. Выбор: `false` ← (по умолчанию) `true`
kerberos логическое значение	Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. Выбор: `false` `true`
password строка	Пароль пользователя. Значение по умолчанию задаётся переменной среды `OVIRT_PASSWORD`.
timeout целое число	Количество секунд ожидания ответа.
token строка	Токен, который будет использоваться вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной среды `OVIRT_TOKEN`.
url строка	Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной среды `OVIRT_URL`. Требуется либо `url`, либо `hostname`.
username строка	Имя пользователя, например admin@internal. Значение по умолчанию задаётся переменной среды `OVIRT_USERNAME`.
clusters список / элементы=словарь	Список словарей, описывающих, как сеть управляется в конкретном кластере.
assigned логическое значение	true, если сеть должна быть назначена кластеру. По умолчанию true. Выбор: `false` `true`
default_route логическое значение	true, если шлюз по умолчанию и конфигурация DNS-сервера хоста будут взяты из этой сети. Выбор: `false` `true`
display логическое значение	true, если сеть должна быть помечена как дисплейная сеть. Выбор: `false` `true`
gluster логическое значение	true, если сеть должна быть помечена как сеть Gluster. Выбор: `false` `true`
migration логическое значение	true, если сеть должна быть помечена как миграционная сеть. Выбор: `false` `true`
name строка	Имя кластера.
required логическое значение	true, если сеть должна оставаться работоспособной для всех хостов, связанных с этой сетью. Выбор: `false` `true`

END_OF_DOCUMENT_MARKER

comment string	Комментарий к сети.
data_center string / обязательно	Имя ЦОД, где находится сеть.
description string	Описание сети.
external_provider string	Имя внешнего поставщика сети. Сначала пытается импортировать сеть, а если её нет, создаёт сеть у внешнего поставщика.
fetch_nested boolean	Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т. д. виртуальных машин. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`. Выбоp: `false` ← (по умолчанию) `true`
id string	Идентификатор сети для управления.
label string	Имя метки для назначения сети.
mtu integer	Максимальный размер блока передачи (MTU) сети.
name string / обязательно	Имя сети для управления.
nested_attributes list / elements=string	Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
poll_interval integer	Количество секунд, которое модуль ожидает, прежде чем отправить новый запрос состояния сущности. По умолчанию: `3`
state string	Сеть должна присутствовать или отсутствовать Выбоp: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в нужное состояние. По умолчанию: `180`
vlan_tag integer	Укажите тег VLAN. ПРИМЕЧАНИЕ. Чтобы удалить vlan_tag, используйте -1.
vm_network boolean	Если True, сеть будет помечена как сеть для виртуальной машины. Сеть VM переносит трафик, относящийся к виртуальной машине. Выбоp: `false` `true`
wait boolean	`yes` если модуль должен ожидать, пока сущность не перейдёт в нужное состояние. Выбоp: `false` `true` ← (по умолчанию)

Примечания

Примечание

Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.4.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create network
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: 10
    vm_network: true

# Remove network
- ovirt.ovirt.ovirt_network:
    state: absent
    name: mynetwork

# Change Network Name
- ovirt.ovirt.ovirt_network:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_network_name"
    data_center: mydatacenter

# Add network from external provider
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    external_provider: ovirt-provider-ovn

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

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

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

Ключ	Описание
id string	Идентификатор управляемой сети Возвращается: При успехе, если сеть найдена. Пример: `"7de90f31-222c-436c-a1ca-7e655bd5b60c"`
network dictionary	Словарь всех атрибутов сети. Атрибуты сети можно найти на вашей инстанции oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network. Возвращается: При успехе, если сеть найдена.

Авторы

Ondra Machacek (@machacekondra)
Martin Necas (@mnecas)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_network_module.html