ovirt_nics - Модуль для управления сетевыми интерфейсами виртуальных машин в oVirt/RHV
Новая версия с 2.3.
Обзор
- Модуль для управления сетевыми интерфейсами виртуальных машин в oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной среды OVIRT_PASSWORD.url - Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL. Требуется либо url либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME. Требуется либо url либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не установлен, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу. | |
| fetch_nested (добавлено в 2.3) | Если True, модуль будет получать дополнительные данные из API. Он будет получать идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| interface |
| Тип сетевого интерфейса. Необходимый параметр при создании нового сетевого адаптера. |
| mac_address | Пользовательский MAC-адрес сетевого интерфейса, по умолчанию он берется из пула MAC-адресов. | |
| name обязательно | Имя сетевого интерфейса для управления. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| network | Логическая сеть, которую должен использовать сетевой интерфейс ВМ, по умолчанию используется пустая сеть, если сеть не указана. | |
| poll_interval | По умолчанию: 3 | Число секунд, которое модуль ждет, прежде чем отправить другой запрос проверки статуса сущности. |
| profile | Профиль виртуального сетевого интерфейса, который должен быть прикреплен к сетевому интерфейсу ВМ. | |
| state |
| Должен ли сетевой адаптер виртуальной машины быть present/absent/plugged/unplugged. |
| template (добавлено в 2.4) | Имя шаблона для управления. Вы должны указать либо параметр vm, либо параметр template. | |
| timeout | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| vm | Имя виртуальной машины для управления. Вы должны указать либо параметр vm, либо параметр template. | |
| wait |
True, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# 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_nics:
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_nics:
state: plugged
vm: myvm
name: mynic
- name: Unplug NIC from VM
ovirt_nics:
state: unplugged
vm: myvm
name: mynic
- name: Add NIC to template
ovirt_nics:
auth: "{{ ovirt_auth }}"
state: present
template: my_template
name: nic1
interface: virtio
profile: ovirtmgmt
network: ovirtmgmt
- name: Remove NIC from VM
ovirt_nics:
state: absent
vm: myvm
name: mynic
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id str | При успешном поиске сетевого интерфейса. | Идентификатор управляемого сетевого интерфейса. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| nic dict | При успешном поиске сетевого интерфейса. | Словарь всех атрибутов сетевого интерфейса. Атрибуты сетевого интерфейса можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic. |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и техническое обслуживание модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/ovirt_nics_module.html
