Spec-Zone.ru › Ansible 2.9

ovirt_nic – Модуль для управления сетевыми интерфейсами виртуальных машин в 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
строка
Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`.
Значение по умолчанию установлено переменной среды OVIRT_URL.
Требуется либо url, либо hostname.
username
строка / обязательно
Имя пользователя, например admin@internal.
Значение по умолчанию установлено переменной среды OVIRT_USERNAME.
fetch_nested
логическое значение
    Варианты:
  • нет
  • да
Если True, модуль получит дополнительные данные из API.
Он получит ID дисков ВМ, снимков и т. д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes.
id
-
добавлен в 2.8
ID сетевого интерфейса для управления.
interface
-
Тип сетевого интерфейса. Например, e1000, pci_passthrough, rtl8139, rtl8139_virtio, spapr_vlan или virtio.
Это обязательный параметр при создании нового сетевого интерфейса.
linked
логическое значение
добавлен в 2.9
    Варианты:
  • нет
  • да
Определяет, связан ли сетевой интерфейс с виртуальной машиной.
mac_address
-
Настраиваемый MAC-адрес сетевого интерфейса, по умолчанию он берется из пула MAC-адресов.
name
- / обязательно
Имя сетевого интерфейса для управления.
nested_attributes
список
Указывает список атрибутов, которые должны быть получены из API.
Этот параметр применяется только когда fetch_nested равен true.
network
-
Логическая сеть, которую должен использовать сетевой интерфейс ВМ, по умолчанию используется пустая сеть, если сеть не указана.
poll_interval
целое число
По умолчанию:
3
Количество секунд, в течение которых модуль ожидает, прежде чем отправить еще один запрос на статус сущности.
profile
-
Профиль виртуального сетевого интерфейса, который нужно подключить к сетевому интерфейсу ВМ.
Если не указано и сеть содержит только один профиль, он будет автоматически выбран, в противном случае вам нужно указать профиль.
state
-
    Варианты:
  • absent
  • plugged
  • present ←
  • unplugged
Виртуальный сетевой интерфейс ВМ должен быть present/absent/plugged/unplugged.
template
-
добавлен в 2.4
Имя шаблона для управления.
Вы должны указать либо параметр vm, либо параметр template.
timeout
целое число
По умолчанию:
180
Количество времени в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
vm
-
Имя виртуальной машины для управления.
Вы должны указать либо параметр vm, либо параметр template.
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:

- name: Add NIC to VM
  ovirt_nic:
    state: present
    vm: myvm
    name: mynic
    interface: e1000
    mac_address: 00:1a:4a:16:01:56
    profile: ovirtmgmt
    network: ovirtmgmt

- name: Plug NIC to VM
  ovirt_nic:
    state: plugged
    vm: myvm
    name: mynic

- name: Unplug NIC from VM
  ovirt_nic:
    state: unplugged
    linked: false
    vm: myvm
    name: mynic

- name: Add NIC to template
  ovirt_nic:
    auth: "{{ ovirt_auth }}"
    state: present
    template: my_template
    name: nic1
    interface: virtio
    profile: ovirtmgmt
    network: ovirtmgmt

- name: Remove NIC from VM
  ovirt_nic:
    state: absent
    vm: myvm
    name: mynic

# Change NIC Name
- ovirt_nic:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_nic_name"
    vm: myvm

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

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

Ключ Возвращаемое значение Описание
id
строка
При успехе, если сетевой интерфейс найден.
ID сетевого интерфейса, который управляется

Пример:
7de90f31-222c-436c-a1ca-7e655bd5b60c
nic
словарь
При успехе, если сетевой интерфейс найден.
Словарь всех атрибутов сетевого интерфейса. Атрибуты сетевого интерфейса можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic.



Статус

  • Модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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_nic_module.html

Spec-Zone.ru

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