Spec-Zone.ru › Ansible

модуль ovirt.ovirt.ovirt_vnic_profile — модуль для управления профилем vNIC сети в oVirt/RHV

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: ovirt.ovirt.ovirt_vnic_profile.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Модуль для управления профилем vNIC сети в 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.

custom_properties

list / elements=dictionary

Пользовательские свойства, применяемые к профилю vNIC.

Пользовательские свойства представляют собой список словарей со следующими возможными значениями:

name

string

Имя пользовательского свойства. Например: hugepages, vhost, sap_agent и т. д.

regexp

string

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

value

string

Значение, задаваемое для пользовательского свойства.

data_center

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

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

description

string

Понятное пользователю описание в виде обычного текста.

fetch_nested

boolean

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

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

Варианты:

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

migratable

boolean

Указывает, допускается ли миграция сетевого адаптера pass_through.

Варианты:

  • false
  • true

name

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

Понятное пользователю имя в виде обычного текста.

nested_attributes

list / elements=string

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

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

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

network

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

Имя сети, к которой подключён vNIC.

network_filter

string

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

pass_through

string

Включает сквозной доступ к сетевому адаптеру узла с поддержкой SR-IOV.

При включении qos и network_filter автоматически устанавливаются в None, а port_mirroring — в False.

Если параметр включён, а migratable не указан, включается migratable.

Зеркалирование портов, QoS и сетевые фильтры не поддерживаются для профилей со сквозным доступом.

Варианты:

  • "disabled"
  • "enabled"

poll_interval

integer

Количество секунд ожидания до отправки следующего запроса для проверки состояния сущности.

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

port_mirroring

boolean

Включает зеркалирование портов.

Варианты:

  • false
  • true

qos

string

Атрибуты качества обслуживания (QoS) регулируют входящий и исходящий сетевой трафик сетевого адаптера.

state

string

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

Варианты:

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

timeout

integer

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

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

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:
- name: Add vNIC
  ovirt.ovirt.ovirt_vnic_profile:
    name: myvnic
    network: mynetwork
    state: present
    data_center: datacenter

- name: Editing vNICs network_filter, custom_properties, qos
  ovirt.ovirt.ovirt_vnic_profile:
    name: myvnic
    network: mynetwork
    data_center: datacenter
    qos: myqos
    custom_properties:
      - name: SecurityGroups
        value: 9bd9bde9-39da-44a8-9541-aa39e1a81c9d
    network_filter: allow-dhcp

- name: Remove vNICs network_filter, custom_properties, qos
  ovirt.ovirt.ovirt_vnic_profile:
    name: myvnic
    network: mynetwork
    data_center: datacenter
    qos: ""
    custom_properties: ""
    network_filter: ""

- name: Dont use migratable
  ovirt.ovirt.ovirt_vnic_profile:
    name: myvnic
    network: mynetwork
    data_center: datacenter
    migratable: false
    pass_through: enabled

- name: Remove vNIC
  ovirt.ovirt.ovirt_vnic_profile:
    name: myvnic
    network: mynetwork
    state: absent
    data_center: datacenter

Возвращаемые значения

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

Ключ

Описание

id

string

Идентификатор управляемого профиля vNIC

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

Пример: "7de90f31-222c-436c-a1ca-7e655bd5b60c"

vnic

dictionary

Словарь со всеми атрибутами профиля vNIC. Атрибуты сетевого интерфейса можно найти в экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic.

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

Авторы

  • Разработчики 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_vnic_profile_module.html

Spec-Zone.ru

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