Spec-Zone.ru › Ansible 2.8

ovirt_tag – Модуль управления тегами в 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
строка
Строка, содержащая API-URL сервера, обычно что-то вроде https://server.example.com/ovirt-engine/api.
Значение по умолчанию задаётся переменной среды OVIRT_URL.
Требуется либо url, либо hostname.
username
строка / обязательно
Имя пользователя, например admin@internal.
Значение по умолчанию задаётся переменной среды OVIRT_USERNAME.
description
-
Описание тега для управления.
fetch_nested
логическое
добавлен в 2.3
    Варианты:
  • нет
  • да
Если истина, модуль получит дополнительные данные из API.
Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes.
hosts
-
Список имен хостов, которым должен быть назначен этот тег.
id
-
добавлен в 2.8
Идентификатор тега для управления.
name
- / обязательно
Имя тега для управления.
nested_attributes
список
добавлен в 2.3
Указывает список атрибутов, которые необходимо получить из API.
Этот параметр применяется только когда fetch_nested имеет значение истина.
родитель
-
Имя родительского тега.
poll_interval
целое число
По умолчанию:
3
Количество секунд, которое модуль ожидает, прежде чем отправить запрос о статусе сущности.
состояние
-
    Варианты:
  • present ←
  • absent
  • attached
  • detached
Должен ли тег быть present/absent/attached/detached.
Note: состояния attached и detached поддерживаются с версии 2.4.
timeout
целое число
По умолчанию:
180
Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
vms
-
Список имен ВМ, которым должен быть назначен этот тег.
wait
булево
    Варианты:
  • no
  • yes ←
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
строка
При успехе, если тег найден.
ID управляемого тега

Пример:
7de90f31-222c-436c-a1ca-7e655bd5b60c
tag
словарь
При успехе, если тег найден.
Словарь всех атрибутов тега. Атрибуты тега можно найти на вашем экземпляре oVirt/RHV по следующему адресу URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag.



Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [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_tag_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API