ovirt_storage_domains - Module to manage storage domains in oVirt¶

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is an Extras Module

Synopsis ¶

Module to manage storage domains 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.
comment	no			Comment of the storage domain.
data_center	no			Data center name where storage domain should be attached.
description	no			Description of the storage domain.
destroy	no			If True storage domain metadata won't be cleaned, and user have to clean them manually. This parameter is relevant only when `state` is absent.
domain_function	no	data	data iso export	Function of the storage domain. aliases: type
fcp	no			Dictionary with values for fibre channel storage type: `address` - Address of the fibre channel storage server. `port` - Port of the fibre channel storage server. `lun_id` - LUN id.
format	no			If True storage domain will be removed after removing it from oVirt. This parameter is relevant only when `state` is absent.
glusterfs	no			Dictionary with values for GlusterFS storage type: `address` - Address of the NFS server. E.g.: myserver.mydomain.com `path` - Path of the mount point. E.g.: /path/to/my/data `mount_options` - Option which will be passed when mounting storage.
host	no			Host to be used to mount storage.
iscsi	no			Dictionary with values for iSCSI storage type: `address` - Address of the iSCSI storage server. `port` - Port of the iSCSI storage server. `target` - iSCSI target. `lun_id` - LUN id. `username` - Username to be used to access storage server. `password` - Password of the user to be used to access storage server.
name	no			Name of the the storage domain to manage.
nfs	no			Dictionary with values for NFS storage type: `address` - Address of the NFS server. E.g.: myserver.mydomain.com `path` - Path of the mount point. E.g.: /path/to/my/data
poll_interval	no	3		Number of the seconds the module waits until another poll request on entity status is sent.
posixfs	no			Dictionary with values for PosixFS storage type: `path` - Path of the mount point. E.g.: /path/to/my/data `vfs_type` - Virtual File System type. `mount_options` - Option which will be passed when mounting storage.
state	no	present	present absent maintenance unattached	Should the storage domain be present/absent/maintenance/unattached
timeout	no	180		The amount of time in seconds the module should wait for the instance to get into desired state.
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:

# Add data NFS storage domain
- ovirt_storage_domains:
    name: data_nfs
    host: myhost
    data_center: mydatacenter
    nfs:
      address: 10.34.63.199
      path: /path/data

# Add data iSCSI storage domain:
- ovirt_storage_domains:
    name: data_iscsi
    host: myhost
    data_center: mydatacenter
    iscsi:
      target: iqn.2016-08-09.domain-01:nickname
      lun_id: 1IET_000d0002
      address: 10.34.63.204

# Import export NFS storage domain:
- ovirt_storage_domains:
    domain_function: export
    host: myhost
    data_center: mydatacenter
    nfs:
      address: 10.34.63.199
      path: /path/export

# Create ISO NFS storage domain
- ovirt_storage_domains:
    name: myiso
    domain_function: iso
    host: myhost
    data_center: mydatacenter
    nfs:
      address: 10.34.63.199
      path: /path/iso

# Remove storage domain
- ovirt_storage_domains:
    state: absent
    name: mystorage_domain
    format: true

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
storage domain	Dictionary of all the storage domain attributes. Storage domain attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/storage_domain.	On success if storage domain is found.
id	ID of the storage domain which is managed	On success if storage domain is found.	str	7de90f31-222c-436c-a1ca-7e655bd5b60c

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.

ovirt_storage_domains - Module to manage storage domains in oVirt¶

Synopsis¶

Requirements (on host that executes module)¶

Options¶

Examples¶

Return Values¶

Notes¶

This is an Extras Module¶