ovirt_tags — Модуль для управления тегами в oVirt/RHV

Новый в версии 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Этот модуль управляет тегами в oVirt/RHV. Он также может управлять назначением этих тегов сущностям.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.2.4

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 ← absent attached detached	Должен ли тег быть present/absent/attached/detached. `Note`: состояния attached и detached поддерживаются начиная с версии 2.4.
timeout	По умолчанию: 180	Время в секундах, в течение которого модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
vms		Список имен ВМ, которым должен быть назначен этот тег.
wait		True, если модуль должен ждать, пока сущность не перейдет в нужное состояние.

Примечания

Примечание

Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.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_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 str	При успехе, если тег найден.	Идентификатор тега, который обрабатывается Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c
tag dict	При успехе, если тег найден.	Словарь со всеми атрибутами тега. Атрибуты тегов можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag.

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

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.5/modules/ovirt_tags_module.html