ovirt_datacenter – Module to manage data centers in oVirt/RHV
ovirt_datacenter – Module to manage data centers in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage data centers in oVirt/RHV
Aliases: ovirt_datacenters
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:
| |
comment - |
Comment of the data center. | |
compatibility_version - |
Compatibility version of the data center. | |
description - |
Description of the data center. | |
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 |
force - added in 2.5 |
Default: "no" |
This parameter can be used only when removing a data center. If True data center will be forcibly removed, even though it contains some clusters. Default value is False, which means that only empty data center can be removed. |
local - |
True if the data center should be local, False if should be shared. Default value is set by engine. | |
mac_pool - |
MAC pool to be used by this datacenter. IMPORTANT: This option is deprecated in oVirt/RHV 4.1. You should use | |
name - / required |
Name of the data center to manage. | |
nested_attributes - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
quota_mode - |
|
Quota mode of the data center. One of disabled, audit or enabled |
state - |
|
Should the data center be present or absent. |
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. |
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:
# Create datacenter
- ovirt_datacenter:
name: mydatacenter
local: True
compatibility_version: 4.0
quota_mode: enabled
# Remove datacenter
- ovirt_datacenter:
state: absent
name: mydatacenter
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
data_center dictionary |
On success if datacenter is found. |
Dictionary of all the datacenter attributes. Datacenter attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/datacenter.
|
id string |
On success if datacenter is found. |
ID of the managed datacenter
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)
© 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_datacenter_module.html