ovirt_nics - Модуль для управления сетевыми интерфейсами виртуальных машин в oVirt/RHV
Новая версия 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Модуль для управления сетевыми интерфейсами виртуальных машин в oVirt/RHV.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| 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 | нет | virtio |
| Тип сетевого интерфейса. |
| mac_address | нет | Пользовательский MAC-адрес сетевого интерфейса, по умолчанию он берется из пула MAC-адресов. | ||
| name | да | Имя сетевого интерфейса для управления. | ||
| nested_attributes (добавлено в 2.3)
| нет | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только при fetch_nested равно true. | ||
| network | нет | Логическая сеть, которую должна использовать сетевой интерфейс ВМ. По умолчанию используется пустая сеть, если сеть не указана. | ||
| poll_interval | нет | 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос на проверку состояния сущности. | |
| profile | нет | Профиль виртуального сетевого интерфейса, который должен быть присоединен к сетевому интерфейсу ВМ. | ||
| state | нет | present |
| Виртуальный сетевой адаптер ВМ должен быть присутствующим/отсутствующим/подключенным/отключенным. |
| template (добавлено в 2.4)
| нет | Имя шаблона для управления. Вы должны указать либо параметр vm, либо параметр template. | ||
| timeout | нет | 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние. | |
| vm | нет | Имя виртуальной машины для управления. Вы должны указать либо параметр vm, либо параметр template. | ||
| wait | нет |
True, если модуль должен ждать, пока сущность не перейдет в желаемое состояние. |
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# 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
# Plug NIC to VM
- ovirt_nics:
state: plugged
vm: myvm
name: mynic
# Unplug NIC from VM
- ovirt_nics:
state: unplugged
vm: myvm
name: mynic
# add NIC to template
- ovirt_nics:
auth: "{{ ovirt_auth }}"
state: present
template: my_template
name: nic1
interface: virtio
profile: ovirtmgmt
network: ovirtmgmt
# Remove NIC from VM
- ovirt_nics:
state: absent
vm: myvm
name: mynic
Возвращаемые значения
Общие значения возврата описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| id | Идентификатор сетевого интерфейса, который управляется | При успехе, если сетевой интерфейс найден. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| nic | Словарь всех атрибутов сетевого интерфейса. Атрибуты сетевого интерфейса можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic. | При успехе, если сетевой интерфейс найден. | dict |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь со статьей Информации о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_nics_module.html