ovirt_tag – Модуль для управления тегами в oVirt/RHV
Описание
- Этот модуль управляет тегами в 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. | ||
| description - | Описание управляемого тега. | ||
| fetch_nested булево |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| hosts - | Список имен хостов, которым должен быть назначен этот тег. | ||
| id - добавлено в 2.8 | Идентификатор управляемого тега. | ||
| name - / обязательно | Имя управляемого тега. | ||
| nested_attributes список | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только если fetch_nested имеет значение true. | ||
| parent - | Имя родительского тега. | ||
| poll_interval целое число | Значение по умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос на проверку состояния сущности. | |
| state - |
| Требуется ли наличие тега/его отсутствие/присоединение/отсоединение. Note: состояния attached и detached поддерживаются с версии 2.4. | |
| timeout целое число | Значение по умолчанию: 180 | Количество секунд, которое модуль должен ожидать, пока экземпляр не перейдет в желаемое состояние. | |
| vms - | Список имен ВМ, которым должен быть назначен этот тег. | ||
| 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:
# Create(if not exists) and assign tag to vms vm1 and vm2:
- ovirt_tag:
name: mytag
vms:
- vm1
- vm2
# Attach a tag to VM 'vm3', keeping the rest already attached tags on VM:
- ovirt_tag:
name: mytag
state: attached
vms:
- vm3
# Detach a tag from VM 'vm3', 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
# Change Tag Name
- ovirt_tag:
id: 00000000-0000-0000-0000-000000000000
name: "new_tag_name"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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.9/modules/ovirt_tag_module.html