Spec-Zone.ru › Ansible 2.4

ovirt_affinity_label - Модуль для управления метками аффинити в 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-запросу.
cluster
нет Имя кластера, в котором находятся виртуальные машины и хосты.
fetch_nested
(добавлен в 2.3)
нет
Если True, модуль извлечёт дополнительные данные из API.
Он извлечёт идентификаторы дисков виртуальных машин, снимков и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes.
hosts
нет Список имён хостов, которым должна быть назначена эта метка аффинити.
name
да Имя метки аффинити для управления.
nested_attributes
(добавлен в 2.3)
нет Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применим только когда fetch_nested равен true.
poll_interval
нет 3 Количество секунд, которое модуль ожидает до отправки другого запроса опроса состояния сущности.
state
нет present
  • present
  • absent
Метка аффинити должна быть present или absent.
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 affinity label to vms vm1 and vm2 and host host1
- ovirt_affinity_label:
    name: mylabel
    cluster: mycluster
    vms:
      - vm1
      - vm2
    hosts:
      - host1

# To detach all VMs from label
- ovirt_affinity_label:
    name: mylabel
    cluster: mycluster
    vms: []

# Remove affinity label
- ovirt_affinity_label:
    state: absent
    name: mylabel

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

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

Примечания

Примечание

  • Для использования этого модуля необходимо установить 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_affinity_label_module.html

Spec-Zone.ru

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