- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ovirt_disk – Module to manage Virtual Machine and floating disks in oVirt/RHV

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

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

## Requirements

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

- python >= 2.7

- ovirt-engine-sdk-python >= 4.3.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
activate boolean added in 2.8 | Choices: no yes | True if the disk should be activated. When creating disk of virtual machine it is set to True.
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 | Choices: no yes | A boolean flag that indicates if the server TLS certificate and host name should be checked.
| kerberos boolean | Choices: no yes | 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.
bootable boolean | Choices: no ← yes | True if the disk should be bootable. By default when disk is created it isn't bootable.
content_type - added in 2.8 | Choices: data ← iso hosted_engine hosted_engine_sanlock hosted_engine_metadata hosted_engine_configuration | Specify if the disk is a data disk or ISO image or a one of a the Hosted Engine disk types The Hosted Engine disk content types are available with Engine 4.3+ and Ansible 2.8
description - added in 2.5 |  | Description of the disk image to manage.
download_image_path - |  | Path on a file system where disk should be downloaded. Note that you must have an valid oVirt/RHV engine CA in your system trust store or you must provide it in `ca_file` parameter. Note that the disk is not downloaded when the file already exists, but you can forcibly download the disk when using `force` I (true).
fetch_nested boolean | Choices: no yes | 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`.
force boolean | Choices: no yes | Please take a look at `image_path` documentation to see the correct usage of this parameter.
format - | Choices: raw cow ← | Specify format of the disk. Note that this option isn't idempotent as it's not currently possible to change format of the disk via API.
host - added in 2.8 |  | When the hypervisor name is specified the newly created disk or an existing disk will refresh its information about the underlying storage( Disk size, Serial, Product ID, Vendor ID ...) The specified host will be used for gathering the storage related information. This option is only valid for passthrough disks. This option requires at least the logical_unit.id to be specified
id - |  | ID of the disk to manage. Either `id` or `name` is required.
image_provider - added in 2.4 |  | When `state` is exported disk is exported to given Glance image provider. `**IMPORTANT**` There is no reliable way to achieve idempotency, so every time you specify this parameter the disk is exported, so please handle your playbook accordingly to not export the disk all the time. This option is valid only for template disks.
interface - | Choices: virtio ide virtio_scsi | Driver of the storage interface. It's required parameter when creating the new disk.
logical_unit - |  | Dictionary which describes LUN to be directly attached to VM:
| address - |  | Address of the storage server. Used by iSCSI.
| lun_id - |  | LUN id.
| password - |  | CHAP Password of the user to be used to access storage server. Used by iSCSI.
| port - |  | Port of the storage server. Used by iSCSI.
| storage_type - |  | Storage type either fcp or iscsi.
| target - |  | iSCSI target.
| username - |  | CHAP Username to be used to access storage server. Used by iSCSI.
name - |  | Name of the disk to manage. Either `id` or `name`/`alias` is required. aliases: alias
nested_attributes list |  | Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
openstack_volume_type - added in 2.4 |  | Name of the openstack volume type. This is valid when working with cinder.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.
profile - |  | Disk profile name to be attached to disk. By default profile is chosen by oVirt/RHV engine.
quota_id - added in 2.5 |  | Disk quota ID to be used for disk. By default quota is chosen by oVirt/RHV engine.
shareable boolean | Choices: no yes | True if the disk should be shareable. By default when disk is created it isn't shareable.
size - |  | Size of the disk. Size should be specified using IEC standard units. For example 10GiB, 1024MiB, etc. Size can be only increased, not decreased.
sparse boolean added in 2.5 | Choices: no yes | True if the disk should be sparse (also known as thin provision). If the parameter is omitted, cow disks will be created as sparse and raw disks as preallocated Note that this option isn't idempotent as it's not currently possible to change sparseness of the disk via API.
sparsify boolean added in 2.4 | Choices: no yes | True if the disk should be sparsified. Sparsification frees space in the disk image that is not used by its filesystem. As a result, the image will occupy less space on the storage. Note that this parameter isn't idempotent, as it's not possible to check if the disk should be or should not be sparsified.
state - | Choices: present ← absent attached detached exported | Should the Virtual Machine disk be present/absent/attached/detached/exported.
storage_domain - |  | Storage domain name where disk should be created.
storage_domains - |  | Storage domain names where disk should be copied. `**IMPORTANT**` There is no reliable way to achieve idempotency, so every time you specify this parameter the disks are copied, so please handle your playbook accordingly to not copy the disks all the time. This is valid only for VM and floating disks, template disks works as expected.
timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state.
upload_image_path - |  | Path to disk image, which should be uploaded. Note if `size` is not specified the size of the disk will be determined by the size of the specified image. Note that currently we support only compatibility version 0.10 of the qcow disk. Note that you must have an valid oVirt/RHV engine CA in your system trust store or you must provide it in `ca_file` parameter. Note that there is no reliable way to achieve idempotency, so if you want to upload the disk even if the disk with `id` or `name` exists, then please use `force` true. If you will use `force` false, which is default, then the disk image won't be uploaded. Note that to upload iso the `format` should be 'raw'
vm_id - |  | ID of the Virtual Machine to manage. Either `vm_id` or `vm_name` is required if `state` is attached or detached.
vm_name - |  | Name of the Virtual Machine to manage. Either `vm_id` or `vm_name` is required if `state` is attached or detached.
wait boolean | Choices: no yes ← | `yes` if the module should wait for the entity to get into desired state.
wipe_after_delete boolean | Choices: no yes | If the disk's Wipe After Delete is enabled, then the disk is first wiped.

## 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.3.0

## 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_disk:
        name: myvm_disk
        vm_name: rhel7
        size: 10GiB
        format: cow
        interface: virtio
        storage_domain: data

    # Attach logical unit to VM rhel7
    - ovirt_disk:
        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_disk:
        state: detached
        name: myvm_disk
        vm_name: rhel7
        size: 10GiB
        format: cow
        interface: virtio

    # Change Disk Name
    - ovirt_disk:
        id: 00000000-0000-0000-0000-000000000000
        storage_domain: data
        name: "new_disk_name"
        vm_name: rhel7

    # Upload local image to disk and attach it to vm:
    # Since Ansible 2.3
    - ovirt_disk:
        name: mydisk
        vm_name: myvm
        interface: virtio
        size: 10GiB
        format: cow
        image_path: /path/to/mydisk.qcow2
        storage_domain: data

    # Download disk to local file system:
    # Since Ansible 2.3
    - ovirt_disk:
        id: 7de90f31-222c-436c-a1ca-7e655bd5b60c
        download_image_path: /home/user/mydisk.qcow2

    # Export disk as image to Glance domain
    # Since Ansible 2.4
    - ovirt_disk:
        id: 7de90f31-222c-436c-a1ca-7e655bd5b60c
        image_provider: myglance
        state: exported

    # Defining a specific quota while creating a disk image:
    # Since Ansible 2.5
    - ovirt_quotas_info:
        data_center: Default
        name: myquota
      register: quota
    - ovirt_disk:
        name: mydisk
        size: 10GiB
        storage_domain: data
        description: somedescriptionhere
        quota_id: "{{ quota.ovirt_quotas[0]['id'] }}"

    # Upload an ISO image
    # Since Ansible 2.8
    -  ovirt_disk:
         name: myiso
         upload_image_path: /path/to/iso/image
         storage_domain: data
         size: 4 GiB
         wait: true
         bootable: true
         format: raw
         content_type: iso

    # Add fiber chanel disk
    - name: Create disk
      ovirt_disk:
        name: fcp_disk
        host: my_host
        logical_unit:
            id: 3600a09803830447a4f244c4657597777
            storage_type: fcp

## Return Values

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

Key | Returned | Description
--- | --- | ---
disk dictionary | On success if disk is found and `vm_id` or `vm_name` wasn't passed. | Dictionary of all the disk attributes. Disk attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/disk.
disk_attachment dictionary | On success if disk is found and `vm_id` or `vm_name` was passed and VM was found. | Dictionary of all the disk attachment attributes. Disk attachment attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/disk_attachment.
id string | On success if disk is found. | ID of the managed disk Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Ondra Machacek (@machacekondra)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.