community.general.ovirt_event_facts (2.5.9) — module

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9

Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

Retrieve information about one or more oVirt/RHV events.

Requirements

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Examples don't contain the auth parameter for simplicity,
# look at the ovirt_auth module to see how to reuse authentication.

- name: Return all events
  ovirt_event_info:
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Return the last 10 events
  ovirt_event_info:
    max: 10
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Return all events of type alert
  ovirt_event_info:
    search: "severity=alert"
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.builtin.debug:
    msg: "{{ result.ovirt_events }}"

Inputs

    
max:
    description:
    - Sets the maximum number of events to return. If not specified all the events are
      returned.
    required: false
    type: int

auth:
    description:
    - 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:'
    - C(username)[I(required)] - The name of the user, something like I(admin@internal).
      Default value is set by I(OVIRT_USERNAME) environment variable.
    - C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD)
      environment variable.
    - C(url)- A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`.
      Default value is set by I(OVIRT_URL) environment variable. Either C(url) or C(hostname)
      is required.
    - C(hostname) - A string containing the hostname of the server, usually something
      like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment
      variable. Either C(url) or C(hostname) is required.
    - C(token) - Token to be used instead of login with username/password. Default value
      is set by I(OVIRT_TOKEN) environment variable.
    - C(insecure) - A boolean flag that indicates if the server TLS certificate and host
      name should be checked.
    - C(ca_file) - 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. Default value is
      set by I(OVIRT_CAFILE) environment variable.
    - C(kerberos) - A boolean flag indicating if Kerberos authentication should be used
      instead of the default basic authentication.
    - C(headers) - Dictionary of HTTP headers to be added to each API call.
    required: true
    type: dict

wait:
    default: true
    description:
    - If True wait for the response.
    required: false
    type: bool

from_:
    description:
    - Indicates the event index after which events should be returned. The indexes of
      events are strictly increasing, so when this parameter is used only the events with
      greater indexes will be returned.
    required: false
    type: int

query:
    description:
    - Additional URL query parameters.
    required: false
    type: str

search:
    description:
    - Search term which is accepted by the oVirt/RHV API.
    - 'For example to search for events of severity alert use the following pattern: severity=alert'
    required: false
    type: str

headers:
    description:
    - Additional HTTP headers.
    required: false
    type: str

fetch_nested:
    default: false
    description:
    - If I(yes) the module will fetch additional data from the API.
    - It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested
      attributes. Only the attributes of the current entity. User can configure to fetch
      other attributes of the nested entities by specifying C(nested_attributes).
    type: bool

case_sensitive:
    default: true
    description:
    - Indicates if the search performed using the search parameter should be performed
      taking case into account. The default value is true, which means that case is taken
      into account. If you want to search ignoring case set it to false.
    required: false
    type: bool

nested_attributes:
    description:
    - Specifies list of the attributes which should be fetched from the API.
    - This parameter apply only when C(fetch_nested) is I(true).
    type: list

Outputs

ovirt_events:
  description: 'List of dictionaries describing the events. Event attributes are mapped
    to dictionary keys. All event attributes can be found at the following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/event'
  returned: On success."
  type: list