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 сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL.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 |
| Должен ли виртуальный сетевой адаптер ВМ быть присутствующим/отсутствующим/подключенным/отключенным. |
| template (добавлено в 2.4) | Имя шаблона для управления. Вы должны указать либо параметр vm, либо параметр template. | |
| timeout | По умолчанию: 180 | Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние. |
| vm | Имя виртуальной машины для управления. Вы должны указать либо параметр vm, либо параметр template. | |
| wait |
True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.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_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 по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic. |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/ovirt_nics_module.html
