Parameter |
Choices/Defaults |
Comments |
auth
dictionary
/ required
|
|
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
|
|
ca_file
string
|
|
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.
|
|
headers
dictionary
|
|
Dictionary of HTTP headers to be added to each API call.
|
|
hostname
string
|
|
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.
|
|
insecure
boolean
|
|
A boolean flag that indicates if the server TLS certificate and host name should be checked.
|
|
kerberos
boolean
|
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
|
|
password
string
/ required
|
|
The password of the user.
Default value is set by OVIRT_PASSWORD environment variable.
|
|
token
string
|
|
Token to be used instead of login with username/password.
Default value is set by OVIRT_TOKEN environment variable.
|
|
url
string
|
|
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.
|
|
username
string
/ required
|
|
The name of the user, something like admin@internal.
Default value is set by OVIRT_USERNAME environment variable.
|
cluster
string
|
|
The id of the cluster associated with this event.
|
custom_id
integer
|
|
Custom ID for the event. This ID must be unique for each event.
Required when state is present.
|
data_center
string
|
|
The id of the data center associated with this event.
|
description
string
|
|
Message for the event.
Required when state is present.
|
fetch_nested
boolean
|
|
If True 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 .
|
host
string
|
|
The id of the host associated with this event.
|
id
string
|
|
The event ID in the oVirt/RHV audit_log table. This ID is not the same as custom_id and is only used when state is absent.
Required when state is absent.
|
nested_attributes
list
|
|
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
|
origin
string
|
|
Originator of the event.
Required when state is present.
|
poll_interval
integer
|
Default:
3
|
Number of the seconds the module waits until another poll request on entity status is sent.
|
severity
string
|
Choices:
- error
normal ←
- warning
|
Severity of the event.
Required when state is present.
|
state
string
|
Choices:
present ←
- absent
|
Should the event be present/absent.
The wait option must be set to false when state is absent.
|
storage_domain
string
|
|
The id of the storage domain associated with this event.
|
template
string
|
|
The id of the template associated with this event.
|
timeout
integer
|
Default:
180
|
The amount of time in seconds the module should wait for the instance to get into desired state.
|
user
string
|
|
The id of the user associated with this event.
|
vm
string
|
|
The id of the VM associated with this event.
|
wait
boolean
|
|
yes if the module should wait for the entity to get into desired state.
|