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, where VM pool should be created.
|
comment
-
|
|
Comment of the Virtual Machine pool.
|
description
-
|
|
Description of the VM pool.
|
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 .
|
id
-
added in 2.8 |
|
ID of the vmpool to manage.
|
name
-
/ required
|
|
Name of the VM pool 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.
|
prestarted
-
|
|
Number of pre-started VMs defines the number of VMs in run state, that are waiting to be attached to Users.
Default value is set by engine.
|
state
-
|
Choices:
present ←
- absent
|
Should the VM pool be present/absent.
Note that when state is absent all VMs in VM pool are stopped and removed.
|
template
-
|
|
Name of the template, which will be used to create VM pool.
|
timeout
integer
|
Default:
180
|
The amount of time in seconds the module should wait for the instance to get into desired state.
|
type
-
|
Choices:
- manual
- automatic
|
Type of the VM pool. Either manual or automatic.
manual - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.
Automatic - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.
Default value is set by engine.
|
vm
dictionary
added in 2.9 |
|
For creating vm pool without editing template.
Note: You can use vm only for creating vm pool.
|
|
cloud_init
-
|
|
Dictionary with values for Unix-like Virtual Machine initialization using cloud init.
host_name - Hostname to be set to Virtual Machine when deployed.
timezone - Timezone to be set to Virtual Machine when deployed.
user_name - Username to be used to set password to Virtual Machine when deployed.
root_password - Password to be set for user specified by user_name parameter.
authorized_ssh_keys - Use this SSH keys to login to Virtual Machine.
regenerate_ssh_keys - If True SSH keys will be regenerated on Virtual Machine.
custom_script - Cloud-init script which will be executed on Virtual Machine when deployed. This is appended to the end of the cloud-init script generated by any other options.
dns_servers - DNS servers to be configured on Virtual Machine.
dns_search - DNS search domains to be configured on Virtual Machine.
nic_boot_protocol - Set boot protocol of the network interface of Virtual Machine. Can be one of none , dhcp or static .
nic_ip_address - If boot protocol is static, set this IP address to network interface of Virtual Machine.
nic_netmask - If boot protocol is static, set this netmask to network interface of Virtual Machine.
nic_gateway - If boot protocol is static, set this gateway to network interface of Virtual Machine.
nic_name - Set name to network interface of Virtual Machine.
nic_on_boot - If True network interface will be set to start on boot.
|
|
comment
-
|
|
Comment of the Virtual Machine.
|
|
memory
-
|
|
Amount of memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
Default value is set by engine.
|
|
memory_guaranteed
-
|
|
Amount of minimal guaranteed memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
memory_guaranteed parameter can't be lower than memory parameter.
Default value is set by engine.
|
|
memory_max
-
|
|
Upper bound of virtual machine memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
Default value is set by engine.
|
|
nics
-
|
|
List of NICs, which should be attached to Virtual Machine. NIC is described by following dictionary.
name - Name of the NIC.
profile_name - Profile name where NIC should be attached.
interface - Type of the network interface. One of following virtio, e1000, rtl8139, default is virtio.
mac_address - Custom MAC address of the network interface, by default it's obtained from MAC pool.
NOTE - This parameter is used only when state is running or present and is able to only create NICs.
To manage NICs of the VM in more depth please use ovirt_nics module instead.
|
|
smartcard_enabled
boolean
|
|
If true, use smart card authentication.
|
|
sso
boolean
|
|
True enable Single Sign On by Guest Agent, False to disable it. By default is chosen by oVirt/RHV engine.
|
|
timezone
-
|
|
Sets time zone offset of the guest hardware clock.
For example Etc/GMT
|
vm_count
-
|
|
Number of VMs in the pool.
Default value is set by engine.
|
vm_per_user
-
|
|
Maximum number of VMs a single user can attach to from this pool.
Default value is set by engine.
|
wait
boolean
|
|
yes if the module should wait for the entity to get into desired state.
|