ansible.builtin.ovirt_auth (v2.4.6.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

This module authenticates to oVirt/RHV engine and creates SSO token, which should be later used in all other oVirt/RHV modules, so all modules don't need to perform login and logout. This module returns an Ansible fact called I(ovirt_auth). Every module can use this fact as C(auth) parameter, to perform authentication.

Requirements

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

Inputs

    
url:
    description:
    - 'A string containing the base URL of the server. For example: I(https://server.example.com/ovirt-engine/api).'
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specifies if a token should be created or revoked.

ca_file:
    description:
    - A PEM file containing the trusted CA certificates. The certificate presented by
      the server will be verified using these CA certificates. If C(ca_file) parameter
      is not set, system wide CA certificate store is used.
    required: false

headers:
    description:
    - A dictionary of HTTP headers to be added to each API call.
    required: false
    version_added: '2.4'
    version_added_collection: ansible.builtin

timeout:
    description:
    - The maximum total time to wait for the response, in seconds. A value of zero (the
      default) means wait forever. If the timeout expires before the response is received
      an exception will be raised.
    required: false

compress:
    description:
    - A boolean flag indicating if the SDK should ask the server to send compressed responses.
      The default is I(True). Note that this is a hint for the server, and that it may
      return uncompressed data even when this parameter is set to I(True).
    required: false

insecure:
    description:
    - A boolean flag that indicates if the server TLS certificate and host name should
      be checked.
    required: false

kerberos:
    description:
    - A boolean flag indicating if Kerberos authentication should be used instead of the
      default basic authentication.
    required: false

password:
    description:
    - The password of the user.
    required: true

username:
    description:
    - 'The name of the user. For example: I(admin@internal).'
    required: true

Outputs

ovirt_auth:
  contains:
    ca_file:
      description: CA file, which is used to verify SSL/TLS connection.
      returned: success
      sample: ca.pem
      type: string
    compress:
      description: Flag indicating if compression is used for connection.
      returned: success
      sample: true
      type: bool
    headers:
      description: Dictionary of HTTP headers to be added to each API call.
      returned: success
      type: dict
    insecure:
      description: Flag indicating if insecure connection is used.
      returned: success
      sample: false
      type: bool
    kerberos:
      description: Flag indicating if kerberos is used for authentication.
      returned: success
      sample: false
      type: bool
    timeout:
      description: Number of seconds to wait for response.
      returned: success
      sample: 0
      type: int
    token:
      description: SSO token which is used for connection to oVirt/RHV engine.
      returned: success
      sample: kdfVWp9ZgeewBXV-iq3Js1-xQJZPSEQ334FLb3eksoEPRaab07DhZ8ED8ghz9lJd-MQ2GqtRIeqhvhCkrUWQPw
      type: string
    url:
      description: URL of the oVirt/RHV engine API endpoint.
      returned: success
      sample: https://ovirt.example.com/ovirt-engine/api
      type: string
  description: Authentication facts, needed to perform authentication to oVirt/RHV.
  returned: success
  type: complex