ovirt_auth - Модуль для управления аутентификацией в oVirt/RHV
Новое в версии 2.2.
- Обзор
- Требования (на хосте, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Этот модуль выполняет аутентификацию в движке oVirt/RHV и создает токен SSO, который должен быть впоследствии использован во всех других модулях oVirt/RHV, чтобы все модули не нуждались в выполнении входа и выхода. Этот модуль возвращает факт Ansible, называемый ovirt_auth. Каждый модуль может использовать этот факт как параметр
authдля выполнения аутентификации.
Требования (на хосте, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| ca_file | нет | Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр ca_file не задан, используется системное хранилище сертификатов CA. | ||
| compress | нет | Флаг булевого типа, указывающий, должен ли SDK запросить у сервера отправку сжатых ответов. Значение по умолчанию — True. Обратите внимание, что это подсказка для сервера, и он может возвращать несжатые данные даже при установке этого параметра в True. | ||
| headers (добавлено в 2.4)
| нет | Словарь HTTP-заголовков, которые нужно добавить к каждому вызову API. | ||
| insecure | нет | Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. | ||
| kerberos | нет | Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | ||
| password | да | Пароль пользователя. | ||
| state | нет | present |
| Указывает, нужно ли создать или аннулировать токен. |
| timeout | нет | Максимальное время ожидания ответа в секундах. Значение ноль (по умолчанию) означает бесконечное ожидание. Если таймаут истекает до получения ответа, будет возбуждено исключение. | ||
| url | да | Строка, содержащая базовый URL-адрес сервера. Например: https://server.example.com/ovirt-engine/api. | ||
| username | да | Имя пользователя. Например: admin@internal. |
Примеры
tasks:
- block:
# Create a vault with `ovirt_password` variable which store your
# oVirt/RHV user's password, and include that yaml file with variable:
- include_vars: ovirt_password.yml
- name: Obtain SSO token with using username/password credentials
ovirt_auth:
url: https://ovirt.example.com/ovirt-engine/api
username: admin@internal
ca_file: ca.pem
password: "{{ ovirt_password }}"
# Previous task generated I(ovirt_auth) fact, which you can later use
# in different modules as follows:
- ovirt_vms:
auth: "{{ ovirt_auth }}"
state: absent
name: myvm
always:
- name: Always revoke the SSO token
ovirt_auth:
state: absent
ovirt_auth: "{{ ovirt_auth }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ovirt_auth | Факты аутентификации, необходимые для выполнения аутентификации в oVirt/RHV. | успех | сложный | ||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Каждый раз, когда вы используете модуль ovirt_auth для получения билета, вам также необходимо аннулировать билет, когда вы больше в нем не нуждаетесь, иначе билет будет аннулирован движком при истечении срока действия. Для примера того, как это сделать, см. раздел Примеры.
- Для использования этого модуля необходимо установить oVirt/RHV Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
- Обратите внимание, что в oVirt/RHV 4.1, если вы хотите использовать пользователя, который не является администратором, необходимо включить переменную ENGINE_API_FILTER_BY_DEFAULT в движке. В oVirt/RHV 4.2 и более поздних версиях она включена по умолчанию.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вам это нужно, прочитайте Справочную информацию сообщества и вклад, Тестирование 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_auth_module.html