ovirt_event_facts – This module can be used to retrieve facts about one or more oVirt/RHV events
New in version 2.8.
Synopsis
- Retrieve facts about one or more oVirt/RHV events.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| auth
dictionary / required
|
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
username[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable.
password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.
url- A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. Either url or hostname is required.
hostname - A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by OVIRT_HOSTNAME environment variable. Either url or hostname is required.
token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.
insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.
ca_file - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.
kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
headers - Dictionary of HTTP headers to be added to each API call.
|
|
| case_sensitive
boolean
|
|
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.
|
| fetch_nested
boolean
added in 2.3
|
|
If yes the module will fetch additional data from the API.
It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying nested_attributes.
|
| from_
integer
|
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.
|
|
| headers
string
|
Additional HTTP headers.
|
|
| max
integer
|
Sets the maximum number of events to return. If not specified all the events are returned.
|
|
| nested_attributes
list
added in 2.3
|
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
|
|
| query
string
|
Additional URL query parameters.
|
|
| search
string
|
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
|
|
| wait
boolean
|
|
If True wait for the response.
|
Notes
Note
- In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.3.0
Examples
# 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_facts:
- name: Return the last 10 events
ovirt_event_facts:
max: 10
- name: Return all events of type alert
ovirt_event_facts:
search: "severity=alert"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| ovirt_facts
list
|
On success." |
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Chris Keller (@nasx)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ovirt_event_facts_module.html