ovirt.ovirt.ovirt_disk_profile module – Module to manage storage domain disk profiles in ovirt

Note

This module is part of the ovirt.ovirt collection (version 3.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ovirt.ovirt. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ovirt.ovirt.ovirt_disk_profile.

Synopsis 

Module to manage storage domain disk profiles in ovirt.

Requirements 

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

python >= 2.7
ovirt-engine-sdk-python >= 4.4.0

Parameters 

Parameter	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.
compress boolean	Flag indicating if compression is used for connection. Choices: `false` `true` ← (default)
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. Choices: `false` ← (default) `true`
kerberos boolean	A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. Choices: `false` `true`
password string	The password of the user. Default value is set by `OVIRT_PASSWORD` environment variable.
timeout integer	Number of seconds to wait for response.
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	The name of the user, something like admin@internal. Default value is set by `OVIRT_USERNAME` environment variable.
comment string	Comment of the disk profile.
data_center string	Name of the data center where the qos entry has been created.
description string	Description of the disk profile.
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`. Choices: `false` ← (default) `true`
id string	ID of the disk profile to manage. Either `id` or `name` is required.
name string	Name of the disk profile to manage. Either `id` or `name`/`alias` is required.
nested_attributes list / elements=string	Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval integer	Number of the seconds the module waits until another poll request on entity status is sent. Default: `3`
qos string	Name of the QoS entry on the disk profile. If not passed defaults to ovirt HE default
state string	Should the disk profile be present/absent. Choices: `"present"` ← (default) `"absent"`
storage_domain string	Name of the storage domain where the disk profile should be created.
timeout integer	The amount of time in seconds the module should wait for the instance to get into desired state. Default: `180`
wait boolean	`yes` if the module should wait for the entity to get into desired state. Choices: `false` `true` ← (default)

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

Examples 

- name: Create a new disk profile on storage_domain_01 using the test_qos QoS in the Default datacenter
  ovirt.ovirt.ovirt_disk_profile:
    auth: "{{ ovirt_auth }}"
    data_center: "Default"
    name: "test_disk_profile"
    state: "present"
    storage_domain: "storage_domain_01"
    qos: "test_qos"

- name: Create a new disk profile on storage_domain_01 in the Default datacenter using the HE default qos
  ovirt.ovirt.ovirt_disk_profile:
    auth: "{{ ovirt_auth }}"
    data_center: "Default"
    name: "test_disk_profile"
    state: "present"
    storage_domain: "storage_domain_01"

- name: Remove the test_qos disk profile
  ovirt.ovirt.ovirt_disk_profile:
    auth: "{{ ovirt_auth }}"
    data_center: "Default"
    name: "test_disk_profile"
    state: "absent"
    storage_domain: "storage_domain_01"
    qos: "test_qos"

Return Values 

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

Key	Description
disk_profile dictionary	Dictionary of all the disk profile attributes. Disk profile attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/disk_profile. Returned: On success if disk profile is found.
id string	ID of the managed disk profile Returned: On success if disk profile is found. Sample: `"7de90f31-222c-436c-a1ca-7e655bd5b60c"`

Authors

Niall O Donnell (@odonnelln)

ovirt.ovirt.ovirt_disk_profile module – Module to manage storage domain disk profiles in ovirt

Synopsis

Requirements

Parameters

Notes

Examples

Return Values