ovirt_storage_domain – Module to manage storage domains in oVirt/RHV
ovirt_storage_domain – Module to manage storage domains in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage storage domains in oVirt/RHV
Aliases: ovirt_storage_domains
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth - / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
backup boolean added in 2.5 |
|
Boolean flag which indicates whether the storage domain is configured as backup or not. |
comment - |
Comment of the storage domain. | |
critical_space_action_blocker - added in 2.5 |
Indicates the minimal free space the storage domain should contain in percentages. | |
data_center - |
Data center name where storage domain should be attached. This parameter isn't idempotent, it's not possible to change data center of storage domain. | |
description - |
Description of the storage domain. | |
destroy boolean |
|
Logical remove of the storage domain. If true retains the storage domain's data for import. This parameter is relevant only when |
discard_after_delete boolean added in 2.5 |
|
If True storage domain blocks will be discarded upon deletion. Enabled by default. This parameter is relevant only for block based storage domains. |
domain_function - |
|
Function of the storage domain. This parameter isn't idempotent, it's not possible to change domain function of storage domain.
|
fcp - |
Dictionary with values for fibre channel storage type:
Note that these parameters are not idempotent. | |
fetch_nested boolean added in 2.3 |
|
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 |
format boolean |
|
If True storage domain will be formatted after removing it from oVirt/RHV. This parameter is relevant only when |
glusterfs - |
Dictionary with values for GlusterFS storage type:
Note that these parameters are not idempotent. | |
host - |
Host to be used to mount storage. | |
id - added in 2.4 |
Id of the storage domain to be imported. | |
iscsi - |
Dictionary with values for iSCSI storage type:
Note that these parameters are not idempotent. Parameter | |
localfs - added in 2.4 |
Dictionary with values for localfs storage type:
Note that these parameters are not idempotent. | |
name - |
Name of the storage domain to manage. (Not required when state is imported) | |
nested_attributes - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
nfs - |
Dictionary with values for NFS storage type:
Note that these parameters are not idempotent. | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
posixfs - |
Dictionary with values for PosixFS storage type:
Note that these parameters are not idempotent. | |
state - |
|
Should the storage domain be present/absent/maintenance/unattached/imported/update_ovf_store imported is supported since version 2.4. update_ovf_store is supported since version 2.5, currently if |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
wait boolean |
|
True if the module should wait for the entity to get into desired state. |
warning_low_space - added in 2.5 |
Indicates the minimum percentage of a free space in a storage domain to present a warning. | |
wipe_after_delete boolean added in 2.5 |
|
Boolean flag which indicates whether the storage domain should wipe the data after delete. |
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.2.4
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Add data NFS storage domain
- ovirt_storage_domain:
name: data_nfs
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/data
# Add data NFS storage domain with id for data center
- ovirt_storage_domain:
name: data_nfs
host: myhost
data_center: 11111
nfs:
address: 10.34.63.199
path: /path/data
mount_options: noexec,nosuid
# Add data localfs storage domain
- ovirt_storage_domain:
name: data_localfs
host: myhost
data_center: mydatacenter
localfs:
path: /path/to/data
# Add data iSCSI storage domain:
- ovirt_storage_domain:
name: data_iscsi
host: myhost
data_center: mydatacenter
iscsi:
target: iqn.2016-08-09.domain-01:nickname
lun_id:
- 1IET_000d0001
- 1IET_000d0002
address: 10.34.63.204
discard_after_delete: True
backup: False
critical_space_action_blocker: 5
warning_low_space: 10
# Since Ansible 2.5 you can specify multiple targets for storage domain,
# Add data iSCSI storage domain with multiple targets:
- ovirt_storage_domain:
name: data_iscsi
host: myhost
data_center: mydatacenter
iscsi:
target_lun_map:
- target: iqn.2016-08-09.domain-01:nickname
lun_id: 1IET_000d0001
- target: iqn.2016-08-09.domain-02:nickname
lun_id: 1IET_000d0002
address: 10.34.63.204
discard_after_delete: True
# Add data glusterfs storage domain
- ovirt_storage_domain:
name: glusterfs_1
host: myhost
data_center: mydatacenter
glusterfs:
address: 10.10.10.10
path: /path/data
# Create export NFS storage domain:
- ovirt_storage_domain:
name: myexportdomain
domain_function: export
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/export
wipe_after_delete: False
backup: True
critical_space_action_blocker: 2
warning_low_space: 5
# Import export NFS storage domain:
- ovirt_storage_domain:
state: imported
domain_function: export
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/export
# Import FCP storage domain:
- ovirt_storage_domain:
state: imported
name: data_fcp
host: myhost
data_center: mydatacenter
fcp: {}
# Update OVF_STORE:
- ovirt_storage_domain:
state: update_ovf_store
name: domain
# Create ISO NFS storage domain
- ovirt_storage_domain:
name: myiso
domain_function: iso
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/iso
# Remove storage domain
- ovirt_storage_domain:
state: absent
name: mystorage_domain
format: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
On success if storage domain is found. |
ID of the storage domain which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
storage_domain dictionary |
On success if storage domain is found. |
Dictionary of all the storage domain attributes. Storage domain attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain.
|
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_storage_domain_module.html