W3cubDocs

/Ansible 2.11

community.general.ovirt – oVirt/RHEV platform management

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ovirt.

DEPRECATED

Removed in

version 3.0.0

Why

This module is for deprecated version of ovirt.

Alternative

Use ovirt_vm from the ovirt.ovirt collection instead

Synopsis

  • This module only supports oVirt/RHEV version 3. A newer module ovirt.ovirt.ovirt_vm supports oVirt/RHV version 4.
  • Allows you to create new instances, either from scratch or an image, in addition to deleting or stopping instances on the oVirt/RHEV platform.

Requirements

The below requirements are needed on the host that executes this module.

  • ovirt-engine-sdk-python

Parameters

Parameter Choices/Defaults Comments
disk_alloc
string
    Choices:
  • preallocated
  • thin ←
Define whether disk is thin or preallocated.
disk_int
string
    Choices:
  • ide
  • virtio ←
Interface type of the disk.
image
string
The template to use for the instance.
instance_cores
string
Default:
1
Define the instance's number of cores.

aliases: vmcores
instance_cpus
string
Default:
1
The instance's number of CPUs.

aliases: vmcpus
instance_disksize
string
Size of the instance's disk in GB.

aliases: vm_disksize
instance_dns
string
Define the instance's Primary DNS server.

aliases: dns
instance_domain
string
Define the instance's Domain.

aliases: domain
instance_gateway
string
Define the instance's Gateway.

aliases: gateway
instance_hostname
string
Define the instance's Hostname.

aliases: hostname
instance_ip
string
Define the instance's IP.

aliases: ip
instance_key
string
Define the instance's Authorized key.

aliases: key
instance_mem
string
The instance's amount of memory in MB.

aliases: vmmem
instance_name
string / required
The name of the instance to use.

aliases: vmname
instance_netmask
string
Define the instance's Netmask.

aliases: netmask
instance_network
string
Default:
"rhevm"
The logical network the machine should belong to.

aliases: vmnetwork
instance_nic
string
The name of the network interface in oVirt/RHEV.

aliases: vmnic
instance_os
string
Type of Operating System.

aliases: vmos
instance_rootpw
string
Define the instance's Root password.

aliases: rootpw
instance_type
string
    Choices:
  • desktop
  • server ←
  • high_performance
Define whether the instance is a server, desktop or high_performance.
high_performance is supported since Ansible 2.5 and oVirt/RHV 4.2.

aliases: vmtype
password
string / required
Password of the user to authenticate with.
region
string
The oVirt/RHEV datacenter where you want to deploy to.
resource_type
string
    Choices:
  • new
  • template
Whether you want to deploy an image or create an instance from scratch.
sdomain
string
The Storage Domain where you want to create the instance's disk on.
state
string
    Choices:
  • absent
  • present ←
  • restart
  • shutdown
  • started
Create, terminate or remove instances.
url
string / required
The url of the oVirt instance.
user
string / required
The user to authenticate with.
zone
string
Deploy the image to this oVirt cluster.

Examples

- name: Basic example to provision from image
  community.general.ovirt:
    user: admin@internal
    url: https://ovirt.example.com
    instance_name: ansiblevm04
    password: secret
    image: centos_64
    zone: cluster01
    resource_type: template

- name: Full example to create new instance from scratch
  community.general.ovirt:
    instance_name: testansible
    resource_type: new
    instance_type: server
    user: admin@internal
    password: secret
    url: https://ovirt.example.com
    instance_disksize: 10
    zone: cluster01
    region: datacenter1
    instance_cpus: 1
    instance_nic: nic1
    instance_network: rhevm
    instance_mem: 1000
    disk_alloc: thin
    sdomain: FIBER01
    instance_cores: 1
    instance_os: rhel_6x64
    disk_int: virtio

- name: Stopping an existing instance
  community.general.ovirt:
    instance_name: testansible
    state: stopped
    user: admin@internal
    password: secret
    url: https://ovirt.example.com

- name: Start an existing instance
  community.general.ovirt:
    instance_name: testansible
    state: started
    user: admin@internal
    password: secret
    url: https://ovirt.example.com

- name: Start an instance with cloud init information
  community.general.ovirt:
    instance_name: testansible
    state: started
    user: admin@internal
    password: secret
    url: https://ovirt.example.com
    hostname: testansible
    domain: ansible.local
    ip: 192.0.2.100
    netmask: 255.255.255.0
    gateway: 192.0.2.1
    rootpw: bigsecret

Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Vincent Van der Kussen (@vincentvdk)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_module.html