ovirt_group - Модуль для управления группами в oVirt/RHV
Новое в версии 2.3.
Обзор
- Модуль для управления группами в oVirt/RHV
Псевдонимы: ovirt_groups
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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-запросу. | |
| authz_name обязательно | Провайдер авторизации группы. В предыдущих версиях oVirt/RHV известен как домен. псевдонимы: домен | |
| fetch_nested (добавлено в 2.3) | Если True, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name обязательно | Имя группы, которую нужно обработать. | |
| namespace | Пространство имён провайдера авторизации, где расположена группа. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| poll_interval | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить новый запрос на проверку состояния сущности. |
| state |
| Группа должна быть present/absent. |
| timeout | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| 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:
# Add group group1 from authorization provider example.com-authz
- ovirt_group:
name: group1
domain: example.com-authz
# Add group group1 from authorization provider example.com-authz
# In case of multi-domain Active Directory setup, you should pass
# also namespace, so it adds correct group:
- ovirt_group:
name: group1
namespace: dc=ad2,dc=example,dc=com
domain: example.com-authz
# Remove group group1 with authorization provider example.com-authz
- ovirt_group:
state: absent
name: group1
domain: example.com-authz
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| group dict | При успехе, если группа найдена. | Словарь всех атрибутов группы. Атрибуты группы можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/group. |
| id str | При успехе, если группа найдена. | Идентификатор группы, которая обрабатывается. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость.
Автор
- 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_group_module.html
