ovirt_tag – Модуль для управления тегами в oVirt/RHV
Новый в версии 2.3.
Обзор
- Этот модуль управляет тегами в oVirt/RHV. Он также может управлять назначением этих тегов сущностям.
Псевдонимы: ovirt_tags
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. | |
| description - | Описание тега для управления. | |
| fetch_nested boolean добавлен в 2.3 |
| Если True, модуль извлечет дополнительные данные из API. Он извлечет идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. |
| hosts - | Список имен хостов, которым должен быть назначен этот тег. | |
| name - / обязательно | Имя тега для управления. | |
| nested_attributes - добавлен в 2.3 | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| parent - | Имя родительского тега. | |
| poll_interval - | По умолчанию: 3 | Количество секунд, которое модуль ждет до отправки следующего запроса на опрос статуса сущности. |
| state - |
| Тег должен быть present/absent/attached/detached. Note: состояния attached и detached поддерживаются начиная с версии 2.4. |
| timeout - | По умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| vms - | Список имен виртуальных машин, которым должен быть назначен этот тег. | |
| wait boolean |
|
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:
# Create(if not exists) and assign tag to vms vm1 and vm2:
- ovirt_tag:
name: mytag
vms:
- vm1
- vm2
# Attach a tag to VM 'vm1', keeping the rest already attached tags on VM:
- ovirt_tag:
name: mytag
state: attached
vms:
- vm3
# Detach a tag from VM 'vm1', keeping the rest already attached tags on VM:
- ovirt_tag:
name: mytag
state: detached
vms:
- vm3
# To detach all VMs from tag:
- ovirt_tag:
name: mytag
vms: []
# Remove tag
- ovirt_tag:
state: absent
name: mytag
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если тег найден. | Идентификатор тега, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| tag словарь | При успехе, если тег найден. | Словарь всех атрибутов тега. Атрибуты тега можно найти на вашей oVirt/RHV системе по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/ovirt_tag_module.html
