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