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
-
|
|
Name of the cluster of the affinity group.
|
description
-
|
|
Description of the affinity group.
|
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_enforcing
boolean
|
|
If yes VM cannot start on host if it does not satisfy the host_rule .
This parameter is support since oVirt/RHV 4.1 version.
|
host_rule
-
|
Choices:
- negative
- positive
|
If positive all VMs in this group should run on the this host.
If negative no VMs in this group should run on the this host.
This parameter is support since oVirt/RHV 4.1 version.
|
hosts
-
|
|
List of the hosts names, which should have assigned this affinity group.
This parameter is support since oVirt/RHV 4.1 version.
|
name
-
/ required
|
|
Name of the affinity group to manage.
|
nested_attributes
list
|
|
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
|
poll_interval
integer
|
Default:
3
|
Number of the seconds the module waits until another poll request on entity status is sent.
|
state
-
|
Choices:
- absent
present ←
|
Should the affinity group be present or absent.
|
timeout
integer
|
Default:
180
|
The amount of time in seconds the module should wait for the instance to get into desired state.
|
vm_enforcing
boolean
|
|
If yes VM cannot start if it does not satisfy the vm_rule .
|
vm_rule
-
|
Choices:
- disabled
- negative
- positive
|
If positive all VMs in this group should run on the host defined by host_rule .
If negative no VMs in this group should run on the host defined by host_rule .
If disabled this affinity group doesn't take effect.
|
vms
-
|
|
List of the VMs names, which should have assigned this affinity group.
|
wait
boolean
|
|
yes if the module should wait for the entity to get into desired state.
|