Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

dictionary / обязательный

Словарь со значениями, необходимыми для создания HTTP/HTTPS-подключения к oVirt:

ca_file

string

PEM-файл с доверенными сертификатами центров сертификации (CA).

Сертификат, предоставленный сервером, будет проверен с помощью этих сертификатов CA.

Если параметр ca_file не задан, используется общесистемное хранилище сертификатов CA.

Значение по умолчанию задается переменной среды OVIRT_CAFILE.

compress

boolean

Флаг, указывающий, используется ли сжатие при подключении.

Варианты:

  • false
  • true ← (по умолчанию)

headers

dictionary

Словарь HTTP-заголовков, добавляемых к каждому вызову API.

hostname

string

Строка с именем узла сервера, обычно в формате `server.example.com`.

Значение по умолчанию задается переменной среды OVIRT_HOSTNAME.

Необходимо указать либо url, либо hostname.

insecure

boolean

Логический флаг, указывающий, нужно ли проверять TLS-сертификат сервера и имя узла.

Варианты:

  • false ← (по умолчанию)
  • true

kerberos

boolean

Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной базовой аутентификации.

Варианты:

  • false
  • true

password

string

Пароль пользователя.

Значение по умолчанию задается переменной среды OVIRT_PASSWORD.

timeout

integer

Время ожидания ответа в секундах.

По умолчанию: 0

token

string

Токен, используемый вместо входа с именем пользователя и паролем.

Значение по умолчанию задается переменной среды OVIRT_TOKEN.

url

string

Строка с URL API сервера, обычно в формате `https://server.example.com/ovirt-engine/api`.

Значение по умолчанию задается переменной среды OVIRT_URL.

Необходимо указать либо url, либо hostname.

username

string

Имя пользователя, например admin@internal.

Значение по умолчанию задается переменной среды OVIRT_USERNAME.

clusters

list / элементы=dictionary

Список словарей, описывающих управление сетью в определенном кластере.

assigned

boolean

true, если сеть должна быть назначена кластеру. По умолчанию — true.

Варианты:

  • false
  • true

default_route

boolean

true, если шлюз по умолчанию и настройки DNS-резолвера узла должны браться из этой сети.

Варианты:

  • false
  • true

display

boolean

true, если сеть должна быть помечена как сеть отображения.

Варианты:

  • false
  • true

gluster

boolean

true, если сеть должна быть помечена как сеть Gluster.

Варианты:

  • false
  • true

migration

boolean

true, если сеть должна быть помечена как сеть миграции.

Варианты:

  • false
  • true

name

string

Имя кластера.

required

boolean

true, если сеть должна оставаться работоспособной для всех узлов, связанных с ней.

Варианты:

  • false
  • true

comment

string

Комментарий к сети.

data_center

string / обязательный

Имя центра обработки данных, в котором находится сеть.

description

string

Описание сети.

external_provider

string

Имя внешнего поставщика сетевых услуг.

Сначала модуль пытается импортировать сеть; если сеть не найдена, он создает ее у внешнего поставщика.

fetch_nested

boolean

Если значение равно True, модуль получит из API дополнительные данные.

Будут получены идентификаторы дисков виртуальных машин, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes.

Варианты:

  • false ← (по умолчанию)
  • true

id

string

Идентификатор управляемой сети.

label

string

Имя метки, назначаемой сети.

mtu

integer

Максимальная единица передачи (MTU) сети.

name

string / обязательный

Имя управляемой сети.

nested_attributes

list / элементы=string

Задает список атрибутов, которые следует получить из API.

Этот параметр применяется, только если fetch_nested имеет значение true.

По умолчанию: []

poll_interval

integer

Интервал в секундах, по истечении которого модуль отправляет очередной запрос для проверки состояния сущности.

По умолчанию: 3

state

string

Должна ли сеть присутствовать или отсутствовать.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

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

По умолчанию: 180

vlan_tag

integer

Укажите тег VLAN.

ПРИМЕЧАНИЕ. Чтобы удалить vlan_tag, используйте -1.

vm_network

boolean

Если значение равно True, сеть будет помечена как сеть для виртуальных машин.

Сеть виртуальных машин передает трафик, относящийся к виртуальной машине.

Варианты:

  • false
  • true

wait

boolean

yes, если модуль должен ожидать перехода сущности в требуемое состояние.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Для использования этого модуля необходимо установить Python SDK для oVirt. Чтобы убедиться, что установлена правильная версия, можно создать следующую задачу: 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.

Возвращается: При успешном выполнении, если сеть найдена.

Авторы

  • Разработчики oVirt (@oVirt)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API