ovirt_disks - Module to manage Virtual Machine and floating disks in oVirt.

New in version 2.2.

Synopsis

Module to manage Virtual Machine and floating disks in oVirt.

Requirements (on host that executes module)

• python >= 2.7
• ovirt-engine-sdk-python >= 4.0.0

Options

parameter	required	default	choices	comments
auth	yes			Dictionary with values needed to create HTTP/HTTPS connection to oVirt: username[required] - The name of the user, something like `admin@internal`. password[required] - The password of the user. url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. token - Token to be used instead of login with username/password. 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. kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
bootable	no			True if the disk should be bootable. By default when disk is created it isn't bootable.
format	no		raw cow	Specify format of the disk. If (cow) format is used, disk will by created as sparse, so space will be allocated for the volume as needed, also known as thin provision. If (raw) format is used, disk storage will be allocated right away, also known as preallocated. Note that this option isn't idempotent as it's not currently possible to change format of the disk via API.
id	no			ID of the disk to manage. Either id or name is required.
interface	no	virtio	virtio ide virtio_scsi	Driver of the storage interface.
logical_unit	no			Dictionary which describes LUN to be directly attached to VM: address - Address of the storage server. Used by iSCSI. port - Port of the storage server. Used by iSCSI. target - iSCSI target. lun_id - LUN id. username - CHAP Username to be used to access storage server. Used by iSCSI. password - CHAP Password of the user to be used to access storage server. Used by iSCSI. storage_type - Storage type either fcp or iscsi.
name	no			Name of the disk to manage. Either id or name/alias is required. aliases: alias
poll_interval	no	3		Number of the seconds the module waits until another poll request on entity status is sent.
profile	no			Disk profile name to be attached to disk. By default profile is chosen by oVirt engine.
shareable	no			True if the disk should be shareable. By default when disk is created it isn't shareable.
size	no			Size of the disk. Size should be specified using IEC standard units. For example 10GiB, 1024MiB, etc. Size can be only increased, not decreased.
state	no	present	present absent attached detached	Should the Virtual Machine disk be present/absent/attached/detached.
storage_domain	no			Storage domain name where disk should be created. By default storage is chosen by oVirt engine.
storage_domains (added in 2.3)	no			Storage domain names where disk should be copied. Please note that this parameter isn't idempotent, so always you specify this attribute the disk will be copied to the specified storage domains.
timeout	no	180		The amount of time in seconds the module should wait for the instance to get into desired state.
vm_id	no			ID of the Virtual Machine to manage. Either vm_id or vm_name is required if state is attached or detached.
vm_name	no			Name of the Virtual Machine to manage. Either vm_id or vm_name is required if state is attached or detached.
wait	no			True if the module should wait for the entity to get into desired state.

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create and attach new disk to VM
- ovirt_disks:
    name: myvm_disk
    vm_name: rhel7
    size: 10GiB
    format: cow
    interface: virtio

# Attach logical unit to VM rhel7
- ovirt_disks:
    vm_name: rhel7
    logical_unit:
      target: iqn.2016-08-09.brq.str-01:omachace
      id: 1IET_000d0001
      address: 10.34.63.204
    interface: virtio

# Detach disk from VM
- ovirt_disks:
    state: detached
    name: myvm_disk
    vm_name: rhel7
    size: 10GiB
    format: cow
    interface: virtio

Return Values

Common return values are documented here common_return_values, the following are the fields unique to this module:

name	description	returned	type	sample
disk	Dictionary of all the disk attributes. Disk attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/disk.	On success if disk is found and C(vm_id) or C(vm_name) wasn't passed.
id	ID of the managed disk	On success if disk is found.	str	7de90f31-222c-436c-a1ca-7e655bd5b60c
disk_attachment	Dictionary of all the disk attachment attributes. Disk attachment attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/disk_attachment.	On success if disk is found and C(vm_id) or C(vm_name) was passed and VM was found.

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.0.0

This is an Extras Module

For more information on what this means please read modules_extra

For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.