ovirt.ovirt.ovirt_datacenter – Module to manage data centers in oVirt/RHV
ovirt.ovirt.ovirt_datacenter – Module to manage data centers in oVirt/RHV
Note
This plugin is part of the ovirt.ovirt collection (version 1.3.0).
To install it use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt_datacenter
.
New in version 1.0.0: of ovirt.ovirt
Synopsis
- Module to manage data centers in oVirt/RHV
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 | Choices/Defaults | 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 Default value is set by | ||
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 Either | ||
insecure boolean |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. | |
kerberos boolean |
|
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 | ||
token string |
Token to be used instead of login with username/password. Default value is set by | ||
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 Either | ||
username string / required |
The name of the user, something like admin@internal. Default value is set by | ||
comment string |
Comment of the data center. | ||
compatibility_version string |
Compatibility version of the data center. | ||
description string |
Description of the data center. | ||
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 | |
force boolean |
|
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. | |
id string |
ID of the datacenter to manage. | ||
iscsi_bonds list / elements=dictionary |
List of iscsi bonds, which should be created in datacenter. | ||
name string |
Name of the iscsi bond. | ||
networks list / elements=string |
List of network names in bond. | ||
storage_connections list / elements=string |
Default: [] |
List of storage_connection IDs. Used when you want to use specific storage connection instead of all in storage domain. | |
storage_domains list / elements=string |
Default: [] |
List of storage domain names and it will automatically get all storage_connections in the domain. | |
local boolean |
|
True if the data center should be local, False if should be shared. Default value is set by engine. | |
mac_pool string |
MAC pool to be used by this datacenter. IMPORTANT: This option is deprecated in oVirt/RHV 4.1. You should use | ||
name string / required |
Name of the data center to manage. | ||
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | ||
poll_interval integer |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. | |
quota_mode string |
|
Quota mode of the data center. One of disabled, audit or enabled | |
state string |
|
Should the data center be present or absent. | |
timeout integer |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. | |
wait boolean |
|
|
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
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create datacenter
- ovirt.ovirt.ovirt_datacenter:
name: mydatacenter
local: True
compatibility_version: 4.0
quota_mode: enabled
# Remove datacenter
- ovirt.ovirt.ovirt_datacenter:
state: absent
name: mydatacenter
# Change Datacenter Name
- ovirt.ovirt.ovirt_datacenter:
id: 00000000-0000-0000-0000-000000000000
name: "new_datacenter_name"
# Create datacenter with iscsi bond
- ovirt.ovirt.ovirt_datacenter:
name: mydatacenter
iscsi_bonds:
- name: bond1
networks:
- network1
- network2
storage_domains:
- storage1
- name: bond2
networks:
- network3
storage_connections:
- cf780201-6a4f-43c1-a019-e65c4220ab73
# Remove all iscsi bonds
- ovirt.ovirt.ovirt_datacenter:
name: mydatacenter
iscsi_bonds: []
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 |
Authors
- Ondra Machacek (@machacekondra)
- Martin Necas (@mnecas)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ovirt/ovirt/ovirt_datacenter_module.html