ovirt_auth – Модуль для управления аутентификацией в oVirt/RHV

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

Обзор

• Этот модуль выполняет аутентификацию в oVirt/RHV-движке и создаёт токен SSO, который впоследствии должен использоваться во всех других модулях oVirt/RHV, чтобы все модули не нуждались в выполнении входа и выхода. Этот модуль возвращает факт Ansible, называемый ovirt_auth. Каждый модуль может использовать этот факт как параметр auth для выполнения аутентификации.

Требования

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

• python >= 2.7
• ovirt-engine-sdk-python >= 4.3.0

Параметры

Примечания

Примеры

  - 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 }}"

# When user will set following environment variables:
#   OVIRT_URL = https://fqdn/ovirt-engine/api
#   OVIRT_USERNAME = admin@internal
#   OVIRT_PASSWORD = the_password
# User can login the oVirt using environment variable instead of variables
# in yaml file.
# This is mainly useful when using Ansible Tower or AWX, as it will work
# for Red Hat Virtualization credentials type.
  - name: Obtain SSO token
    ovirt_auth:
      state: present

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

Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для данного модуля:

Статус

• Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
• Этот модуль поддерживается сообществом Ansible. [community]

Авторы

• Ondra Machacek (@machacekondra)