ovirt_nic – Модуль для управления сетевыми интерфейсами виртуальных машин в oVirt/RHV
Новый в версии 2.3.
Краткое описание
- Модуль для управления сетевыми интерфейсами виртуальных машин в 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 строка | Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной окружения OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной окружения OVIRT_USERNAME. | ||
| fetch_nested булево добавлено в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. | |
| id - добавлено в 2.8 | Идентификатор сетевого интерфейса для управления. | ||
| interface - | Тип сетевого интерфейса. Например, e1000, pci_passthrough, rtl8139, rtl8139_virtio, spapr_vlan или virtio. Это обязательный параметр при создании нового сетевого интерфейса. | ||
| 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 булево |
| 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
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 строка | При успехе, если сетевой интерфейс найден. | Идентификатор управляемого сетевого интерфейса Пример: 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.8/modules/ovirt_nic_module.html
