1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

cloud: ovirt: add note that modules works with RHV as well (#23808)

This commit is contained in:
Ondra Machacek 2017-04-22 00:20:24 +02:00 committed by René Moser
parent 4594bee65a
commit 13c2c292f2
40 changed files with 159 additions and 159 deletions

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_affinity_groups module: ovirt_affinity_groups
short_description: Module to manage affinity groups in oVirt short_description: Module to manage affinity groups in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "This module manage affinity groups in oVirt. It can also manage assignments - "This module manage affinity groups in oVirt/RHV. It can also manage assignments
of those groups to VMs." of those groups to VMs."
options: options:
name: name:
@ -52,12 +52,12 @@ options:
host_enforcing: host_enforcing:
description: description:
- "If I(true) VM cannot start on host if it does not satisfy the C(host_rule)." - "If I(true) VM cannot start on host if it does not satisfy the C(host_rule)."
- "C(This parameter is support since oVirt 4.1 version.)" - "C(This parameter is support since oVirt/RHV 4.1 version.)"
host_rule: host_rule:
description: description:
- "If I(positive) I(all) VMs in this group should run on the this host." - "If I(positive) I(all) VMs in this group should run on the this host."
- "If I(negative) I(no) VMs in this group should run on the this host." - "If I(negative) I(no) VMs in this group should run on the this host."
- "C(This parameter is support since oVirt 4.1 version.)" - "C(This parameter is support since oVirt/RHV 4.1 version.)"
choices: choices:
- positive - positive
- negative - negative
@ -79,7 +79,7 @@ options:
hosts: hosts:
description: description:
- "List of the hosts names, which should have assigned this affinity group." - "List of the hosts names, which should have assigned this affinity group."
- "C(This parameter is support since oVirt 4.1 version.)" - "C(This parameter is support since oVirt/RHV 4.1 version.)"
extends_documentation_fragment: ovirt extends_documentation_fragment: ovirt
''' '''
@ -128,7 +128,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
affinity_group: affinity_group:
description: "Dictionary of all the affinity group attributes. Affinity group attributes can be found on your oVirt instance description: "Dictionary of all the affinity group attributes. Affinity group attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_group." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_group."
returned: On success if affinity group is found. returned: On success if affinity group is found.
''' '''
@ -175,7 +175,7 @@ class AffinityGroupsModule(BaseModule):
ag_service.vms_service().vm_service(vm).remove() ag_service.vms_service().vm_service(vm).remove()
for vm in to_add: for vm in to_add:
# API return <action> element instead of VM element, so we # API return <action> element instead of VM element, so we
# need to WA this issue, for oVirt versions having this bug: # need to WA this issue, for oVirt/RHV versions having this bug:
try: try:
ag_service.vms_service().add(otypes.Vm(id=vm)) ag_service.vms_service().add(otypes.Vm(id=vm))
except ValueError as ex: except ValueError as ex:

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_affinity_labels module: ovirt_affinity_labels
short_description: Module to manage affinity labels in oVirt short_description: Module to manage affinity labels in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "This module manage affinity labels in oVirt. It can also manage assignments - "This module manage affinity labels in oVirt/RHV. It can also manage assignments
of those labels to hosts and VMs." of those labels to hosts and VMs."
options: options:
name: name:
@ -88,7 +88,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
affinity_label: affinity_label:
description: "Dictionary of all the affinity label attributes. Affinity label attributes can be found on your oVirt instance description: "Dictionary of all the affinity label attributes. Affinity label attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_label." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_label."
returned: On success if affinity label is found. returned: On success if affinity label is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_affinity_labels_facts module: ovirt_affinity_labels_facts
short_description: Retrieve facts about one or more oVirt affinity labels short_description: Retrieve facts about one or more oVirt/RHV affinity labels
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt affinity labels." - "Retrieve facts about one or more oVirt/RHV affinity labels."
notes: notes:
- "This module creates a new top-level C(ovirt_affinity_labels) fact, which - "This module creates a new top-level C(ovirt_affinity_labels) fact, which
contains a list of affinity labels." contains a list of affinity labels."

View file

@ -27,12 +27,12 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_auth module: ovirt_auth
short_description: "Module to manage authentication to oVirt" short_description: "Module to manage authentication to oVirt/RHV"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.2" version_added: "2.2"
description: description:
- "This module authenticates to oVirt engine and creates SSO token, which should be later used in - "This module authenticates to oVirt/RHV engine and creates SSO token, which should be later used in
all other oVirt modules, so all modules don't need to perform login and logout. all other oVirt/RHV modules, so all modules don't need to perform login and logout.
This module returns an Ansible fact called I(ovirt_auth). Every module can use this This module returns an Ansible fact called I(ovirt_auth). Every module can use this
fact as C(auth) parameter, to perform authentication." fact as C(auth) parameter, to perform authentication."
options: options:
@ -91,19 +91,19 @@ notes:
- "Everytime you use ovirt_auth module to obtain ticket, you need to also revoke the ticket, - "Everytime you use ovirt_auth module to obtain ticket, you need to also revoke the ticket,
when you no longer need it, otherwise the ticket would be revoked by engine when it expires. when you no longer need it, otherwise the ticket would be revoked by engine when it expires.
For an example of how to achieve that, please take a look at I(examples) section." For an example of how to achieve that, please take a look at I(examples) section."
- "In order to use this module you have to install oVirt Python SDK. - "In order to use this module you have to install oVirt/RHV Python SDK.
To ensure it's installed with correct version you can create the following task: To ensure it's installed with correct version you can create the following task:
I(pip: name=ovirt-engine-sdk-python version=4.0.0)" I(pip: name=ovirt-engine-sdk-python version=4.0.0)"
- "Note that in oVirt 4.1 if you want to use a user which is not administrator - "Note that in oVirt/RHV 4.1 if you want to use a user which is not administrator
you must enable the I(ENGINE_API_FILTER_BY_DEFAULT) variable in engine. In you must enable the I(ENGINE_API_FILTER_BY_DEFAULT) variable in engine. In
oVirt 4.2 and later it's enabled by default." oVirt/RHV 4.2 and later it's enabled by default."
''' '''
EXAMPLES = ''' EXAMPLES = '''
tasks: tasks:
- block: - block:
# Create a vault with `ovirt_password` variable which store your # Create a vault with `ovirt_password` variable which store your
# oVirt user's password, and include that yaml file with variable: # oVirt/RHV user's password, and include that yaml file with variable:
- include_vars: ovirt_password.yml - include_vars: ovirt_password.yml
- name: Obtain SSO token with using username/password credentials - name: Obtain SSO token with using username/password credentials
@ -129,17 +129,17 @@ tasks:
RETURN = ''' RETURN = '''
ovirt_auth: ovirt_auth:
description: Authentication facts, needed to perform authentication to oVirt. description: Authentication facts, needed to perform authentication to oVirt/RHV.
returned: success returned: success
type: dictionary type: dictionary
contains: contains:
token: token:
description: SSO token which is used for connection to oVirt engine. description: SSO token which is used for connection to oVirt/RHV engine.
returned: success returned: success
type: string type: string
sample: "kdfVWp9ZgeewBXV-iq3Js1-xQJZPSEQ334FLb3eksoEPRaab07DhZ8ED8ghz9lJd-MQ2GqtRIeqhvhCkrUWQPw" sample: "kdfVWp9ZgeewBXV-iq3Js1-xQJZPSEQ334FLb3eksoEPRaab07DhZ8ED8ghz9lJd-MQ2GqtRIeqhvhCkrUWQPw"
url: url:
description: URL of the oVirt engine API endpoint. description: URL of the oVirt/RHV engine API endpoint.
returned: success returned: success
type: string type: string
sample: "https://ovirt.example.com/ovirt-engine/api" sample: "https://ovirt.example.com/ovirt-engine/api"

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_clusters module: ovirt_clusters
short_description: Module to manage clusters in oVirt short_description: Module to manage clusters in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage clusters in oVirt" - "Module to manage clusters in oVirt/RHV"
options: options:
name: name:
description: description:
@ -81,7 +81,7 @@ options:
- "If I(True) enables KSM C(ksm) for best berformance inside NUMA nodes." - "If I(True) enables KSM C(ksm) for best berformance inside NUMA nodes."
ha_reservation: ha_reservation:
description: description:
- "If I(True) enable the oVirt to monitor cluster capacity for highly - "If I(True) enable the oVirt/RHV to monitor cluster capacity for highly
available virtual machines." available virtual machines."
trusted_service: trusted_service:
description: description:
@ -254,7 +254,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
cluster: cluster:
description: "Dictionary of all the cluster attributes. Cluster attributes can be found on your oVirt instance description: "Dictionary of all the cluster attributes. Cluster attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/cluster." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/cluster."
returned: On success if cluster is found. returned: On success if cluster is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_clusters_facts module: ovirt_clusters_facts
short_description: Retrieve facts about one or more oVirt clusters short_description: Retrieve facts about one or more oVirt/RHV clusters
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt clusters." - "Retrieve facts about one or more oVirt/RHV clusters."
notes: notes:
- "This module creates a new top-level C(ovirt_clusters) fact, which - "This module creates a new top-level C(ovirt_clusters) fact, which
contains a list of clusters." contains a list of clusters."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search cluster X from datacenter Y use following pattern: - "For example to search cluster X from datacenter Y use following pattern:
name=X and datacenter=Y" name=X and datacenter=Y"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_datacenters module: ovirt_datacenters
short_description: Module to manage data centers in oVirt short_description: Module to manage data centers in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage data centers in oVirt" - "Module to manage data centers in oVirt/RHV"
options: options:
name: name:
description: description:
@ -62,7 +62,7 @@ options:
mac_pool: mac_pool:
description: description:
- "MAC pool to be used by this datacenter." - "MAC pool to be used by this datacenter."
- "IMPORTANT: This option is deprecated in oVirt 4.1. You should - "IMPORTANT: This option is deprecated in oVirt/RHV 4.1. You should
use C(mac_pool) in C(ovirt_clusters) module, as MAC pools are use C(mac_pool) in C(ovirt_clusters) module, as MAC pools are
set per cluster since 4.1." set per cluster since 4.1."
extends_documentation_fragment: ovirt extends_documentation_fragment: ovirt
@ -92,7 +92,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
data_center: data_center:
description: "Dictionary of all the datacenter attributes. Datacenter attributes can be found on your oVirt instance description: "Dictionary of all the datacenter attributes. Datacenter attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/datacenter." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/datacenter."
returned: "On success if datacenter is found." returned: "On success if datacenter is found."
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_datacenters_facts module: ovirt_datacenters_facts
short_description: Retrieve facts about one or more oVirt datacenters short_description: Retrieve facts about one or more oVirt/RHV datacenters
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt datacenters." - "Retrieve facts about one or more oVirt/RHV datacenters."
notes: notes:
- "This module creates a new top-level C(ovirt_datacenters) fact, which - "This module creates a new top-level C(ovirt_datacenters) fact, which
contains a list of datacenters." contains a list of datacenters."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search datacenter I(X) use following pattern: I(name=X)" - "For example to search datacenter I(X) use following pattern: I(name=X)"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_disks module: ovirt_disks
short_description: "Module to manage Virtual Machine and floating disks in oVirt" short_description: "Module to manage Virtual Machine and floating disks in oVirt/RHV"
version_added: "2.2" version_added: "2.2"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage Virtual Machine and floating disks in oVirt." - "Module to manage Virtual Machine and floating disks in oVirt/RHV."
options: options:
id: id:
description: description:
@ -54,7 +54,7 @@ options:
download_image_path: download_image_path:
description: description:
- "Path on a file system where disk should be downloaded." - "Path on a file system where disk should be downloaded."
- "Note that you must have an valid oVirt engine CA in your system trust store - "Note that you must have an valid oVirt/RHV engine CA in your system trust store
or you must provide it in C(ca_file) parameter." or you must provide it in C(ca_file) parameter."
- "Note that the disk is not downloaded when the file already exists, - "Note that the disk is not downloaded when the file already exists,
but you can forcibly download the disk when using C(force) I (true)." but you can forcibly download the disk when using C(force) I (true)."
@ -63,7 +63,7 @@ options:
description: description:
- "Path to disk image, which should be uploaded." - "Path to disk image, which should be uploaded."
- "Note that currently we support only compability version 0.10 of the qcow disk." - "Note that currently we support only compability version 0.10 of the qcow disk."
- "Note that you must have an valid oVirt engine CA in your system trust store - "Note that you must have an valid oVirt/RHV engine CA in your system trust store
or you must provide it in C(ca_file) parameter." or you must provide it in C(ca_file) parameter."
- "Note that there is no reliable way to achieve idempotency, so - "Note that there is no reliable way to achieve idempotency, so
if you want to upload the disk even if the disk with C(id) or C(name) exists, if you want to upload the disk even if the disk with C(id) or C(name) exists,
@ -89,7 +89,7 @@ options:
choices: ['raw', 'cow'] choices: ['raw', 'cow']
storage_domain: storage_domain:
description: description:
- "Storage domain name where disk should be created. By default storage is chosen by oVirt engine." - "Storage domain name where disk should be created. By default storage is chosen by oVirt/RHV engine."
storage_domains: storage_domains:
description: description:
- "Storage domain names where disk should be copied." - "Storage domain names where disk should be copied."
@ -107,7 +107,7 @@ options:
version_added: "2.3" version_added: "2.3"
profile: profile:
description: description:
- "Disk profile name to be attached to disk. By default profile is chosen by oVirt engine." - "Disk profile name to be attached to disk. By default profile is chosen by oVirt/RHV engine."
bootable: bootable:
description: description:
- "I(True) if the disk should be bootable. By default when disk is created it isn't bootable." - "I(True) if the disk should be bootable. By default when disk is created it isn't bootable."
@ -193,13 +193,13 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
disk: disk:
description: "Dictionary of all the disk attributes. Disk attributes can be found on your oVirt instance description: "Dictionary of all the disk attributes. Disk attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/disk." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/disk."
returned: "On success if disk is found and C(vm_id) or C(vm_name) wasn't passed." returned: "On success if disk is found and C(vm_id) or C(vm_name) wasn't passed."
disk_attachment: disk_attachment:
description: "Dictionary of all the disk attachment attributes. Disk attachment attributes can be found description: "Dictionary of all the disk attachment attributes. Disk attachment attributes can be found
on your oVirt instance at following url: on your oVirt/RHV instance at following url:
https://ovirt.example.com/ovirt-engine/api/model#types/disk_attachment." https://ovirt.example.com/ovirt-engine/api/model#types/disk_attachment."
returned: "On success if disk is found and C(vm_id) or C(vm_name) was passed and VM was found." returned: "On success if disk is found and C(vm_id) or C(vm_name) was passed and VM was found."
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_external_providers module: ovirt_external_providers
short_description: Module to manage external providers in oVirt short_description: Module to manage external providers in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage external providers in oVirt" - "Module to manage external providers in oVirt/RHV"
options: options:
name: name:
description: description:
@ -130,22 +130,22 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
external_host_provider: external_host_provider:
description: "Dictionary of all the external_host_provider attributes. External provider attributes can be found on your oVirt instance description: "Dictionary of all the external_host_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/external_host_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/external_host_provider."
returned: "On success and if parameter 'type: foreman' is used." returned: "On success and if parameter 'type: foreman' is used."
type: dictionary type: dictionary
openstack_image_provider: openstack_image_provider:
description: "Dictionary of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt instance description: "Dictionary of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_image_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_image_provider."
returned: "On success and if parameter 'type: os_image' is used." returned: "On success and if parameter 'type: os_image' is used."
type: dictionary type: dictionary
openstack_volume_provider: openstack_volume_provider:
description: "Dictionary of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt instance description: "Dictionary of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_volume_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_volume_provider."
returned: "On success and if parameter 'type: os_volume' is used." returned: "On success and if parameter 'type: os_volume' is used."
type: dictionary type: dictionary
openstack_network_provider: openstack_network_provider:
description: "Dictionary of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt instance description: "Dictionary of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_network_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_network_provider."
returned: "On success and if parameter 'type: network' is used." returned: "On success and if parameter 'type: network' is used."
type: dictionary type: dictionary

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_external_providers_facts module: ovirt_external_providers_facts
short_description: Retrieve facts about one or more oVirt external providers short_description: Retrieve facts about one or more oVirt/RHV external providers
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt external providers." - "Retrieve facts about one or more oVirt/RHV external providers."
notes: notes:
- "This module creates a new top-level C(ovirt_external_providers) fact, which - "This module creates a new top-level C(ovirt_external_providers) fact, which
contains a list of external_providers." contains a list of external_providers."
@ -61,22 +61,22 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
external_host_providers: external_host_providers:
description: "List of dictionaries of all the external_host_provider attributes. External provider attributes can be found on your oVirt instance description: "List of dictionaries of all the external_host_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/external_host_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/external_host_provider."
returned: "On success and if parameter 'type: foreman' is used." returned: "On success and if parameter 'type: foreman' is used."
type: list type: list
openstack_image_providers: openstack_image_providers:
description: "List of dictionaries of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt instance description: "List of dictionaries of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_image_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_image_provider."
returned: "On success and if parameter 'type: os_image' is used." returned: "On success and if parameter 'type: os_image' is used."
type: list type: list
openstack_volume_providers: openstack_volume_providers:
description: "List of dictionaries of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt instance description: "List of dictionaries of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_volume_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_volume_provider."
returned: "On success and if parameter 'type: os_volume' is used." returned: "On success and if parameter 'type: os_volume' is used."
type: list type: list
openstack_network_providers: openstack_network_providers:
description: "List of dictionaries of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt instance description: "List of dictionaries of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_network_provider." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_network_provider."
returned: "On success and if parameter 'type: os_network' is used." returned: "On success and if parameter 'type: os_network' is used."
type: list type: list

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_groups module: ovirt_groups
short_description: Module to manage groups in oVirt short_description: Module to manage groups in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage groups in oVirt" - "Module to manage groups in oVirt/RHV"
options: options:
name: name:
description: description:
@ -44,7 +44,7 @@ options:
default: present default: present
authz_name: authz_name:
description: description:
- "Authorization provider of the group. In previous versions of oVirt known as domain." - "Authorization provider of the group. In previous versions of oVirt/RHV known as domain."
required: true required: true
aliases: ['domain'] aliases: ['domain']
namespace: namespace:
@ -85,7 +85,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
group: group:
description: "Dictionary of all the group attributes. Group attributes can be found on your oVirt instance description: "Dictionary of all the group attributes. Group attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/group." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/group."
returned: On success if group is found. returned: On success if group is found.
''' '''
@ -116,7 +116,7 @@ def _group(connection, module):
) )
# If found more groups, filter them by namespace and authz name: # If found more groups, filter them by namespace and authz name:
# (filtering here, as oVirt backend doesn't support it) # (filtering here, as oVirt/RHV backend doesn't support it)
if len(groups) > 1: if len(groups) > 1:
groups = [ groups = [
g for g in groups if ( g for g in groups if (

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_groups_facts module: ovirt_groups_facts
short_description: Retrieve facts about one or more oVirt groups short_description: Retrieve facts about one or more oVirt/RHV groups
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt groups." - "Retrieve facts about one or more oVirt/RHV groups."
notes: notes:
- "This module creates a new top-level C(ovirt_groups) fact, which - "This module creates a new top-level C(ovirt_groups) fact, which
contains a list of groups." contains a list of groups."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search group X use following pattern: name=X" - "For example to search group X use following pattern: name=X"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_host_networks module: ovirt_host_networks
short_description: Module to manage host networks in oVirt short_description: Module to manage host networks in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage host networks in oVirt." - "Module to manage host networks in oVirt/RHV."
options: options:
name: name:
description: description:
@ -133,7 +133,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
host_nic: host_nic:
description: "Dictionary of all the host NIC attributes. Host NIC attributes can be found on your oVirt instance description: "Dictionary of all the host NIC attributes. Host NIC attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host_nic." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host_nic."
returned: On success if host NIC is found. returned: On success if host NIC is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_host_pm module: ovirt_host_pm
short_description: Module to manage power management of hosts in oVirt short_description: Module to manage power management of hosts in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage power management of hosts in oVirt." - "Module to manage power management of hosts in oVirt/RHV."
options: options:
name: name:
description: description:
@ -54,7 +54,7 @@ options:
- "Password of the user specified in C(username) parameter." - "Password of the user specified in C(username) parameter."
type: type:
description: description:
- "Type of the power management. oVirt predefined values are I(drac5), I(ipmilan), I(rsa), - "Type of the power management. oVirt/RHV predefined values are I(drac5), I(ipmilan), I(rsa),
I(bladecenter), I(alom), I(apc), I(apc_snmp), I(eps), I(wti), I(rsb), I(cisco_ucs), I(bladecenter), I(alom), I(apc), I(apc_snmp), I(eps), I(wti), I(rsb), I(cisco_ucs),
I(drac7), I(hpblade), I(ilo), I(ilo2), I(ilo3), I(ilo4), I(ilo_ssh), I(drac7), I(hpblade), I(ilo), I(ilo2), I(ilo3), I(ilo4), I(ilo_ssh),
but user can have defined custom type." but user can have defined custom type."
@ -109,7 +109,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
agent: agent:
description: "Dictionary of all the agent attributes. Agent attributes can be found on your oVirt instance description: "Dictionary of all the agent attributes. Agent attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/agent." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/agent."
returned: On success if agent is found. returned: On success if agent is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_hosts module: ovirt_hosts
short_description: Module to manage hosts in oVirt short_description: Module to manage hosts in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage hosts in oVirt" - "Module to manage hosts in oVirt/RHV"
options: options:
name: name:
description: description:
@ -74,7 +74,7 @@ options:
override_iptables: override_iptables:
description: description:
- "If True host iptables will be overridden by host deploy script." - "If True host iptables will be overridden by host deploy script."
- "Note that C(override_iptables) is I(false) by default in oVirt." - "Note that C(override_iptables) is I(false) by default in oVirt/RHV."
force: force:
description: description:
- "If True host will be forcibly moved to desired state." - "If True host will be forcibly moved to desired state."
@ -111,7 +111,7 @@ EXAMPLES = '''
# look at ovirt_auth module to see how to reuse authentication: # look at ovirt_auth module to see how to reuse authentication:
# Add host with username/password supporting SR-IOV. # Add host with username/password supporting SR-IOV.
# Note that override_iptables is false by default in oVirt: # Note that override_iptables is false by default in oVirt/RHV:
- ovirt_hosts: - ovirt_hosts:
cluster: Default cluster: Default
name: myhost name: myhost
@ -173,7 +173,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
host: host:
description: "Dictionary of all the host attributes. Host attributes can be found on your oVirt instance description: "Dictionary of all the host attributes. Host attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host."
returned: On success if host is found. returned: On success if host is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_hosts_facts module: ovirt_hosts_facts
short_description: Retrieve facts about one or more oVirt hosts short_description: Retrieve facts about one or more oVirt/RHV hosts
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt hosts." - "Retrieve facts about one or more oVirt/RHV hosts."
notes: notes:
- "This module creates a new top-level C(ovirt_hosts) fact, which - "This module creates a new top-level C(ovirt_hosts) fact, which
contains a list of hosts." contains a list of hosts."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search host X from datacenter Y use following pattern: - "For example to search host X from datacenter Y use following pattern:
name=X and datacenter=Y" name=X and datacenter=Y"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_mac_pools module: ovirt_mac_pools
short_description: Module to manage MAC pools in oVirt short_description: Module to manage MAC pools in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "This module manage MAC pools in oVirt." - "This module manage MAC pools in oVirt/RHV."
options: options:
name: name:
description: description:
@ -48,7 +48,7 @@ options:
allow_duplicates: allow_duplicates:
description: description:
- "If (true) allow a MAC address to be used multiple times in a pool." - "If (true) allow a MAC address to be used multiple times in a pool."
- "Default value is set by oVirt engine to I(false)." - "Default value is set by oVirt/RHV engine to I(false)."
ranges: ranges:
description: description:
- "List of MAC ranges. The from and to should be splitted by comma." - "List of MAC ranges. The from and to should be splitted by comma."
@ -81,7 +81,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
template: template:
description: "Dictionary of all the MAC pool attributes. MAC pool attributes can be found on your oVirt instance description: "Dictionary of all the MAC pool attributes. MAC pool attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/mac_pool." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/mac_pool."
returned: On success if MAC pool is found. returned: On success if MAC pool is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_networks module: ovirt_networks
short_description: Module to manage logical networks in oVirt short_description: Module to manage logical networks in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage logical networks in oVirt" - "Module to manage logical networks in oVirt/RHV"
options: options:
name: name:
description: description:
@ -98,7 +98,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
network: network:
description: "Dictionary of all the network attributes. Network attributes can be found on your oVirt instance description: "Dictionary of all the network attributes. Network attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/network." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/network."
returned: "On success if network is found." returned: "On success if network is found."
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_networks_facts module: ovirt_networks_facts
short_description: Retrieve facts about one or more oVirt networks short_description: Retrieve facts about one or more oVirt/RHV networks
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt networks." - "Retrieve facts about one or more oVirt/RHV networks."
notes: notes:
- "This module creates a new top-level C(ovirt_networks) fact, which - "This module creates a new top-level C(ovirt_networks) fact, which
contains a list of networks." contains a list of networks."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search network starting with string vlan1 use: name=vlan1*" - "For example to search network starting with string vlan1 use: name=vlan1*"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_nics module: ovirt_nics
short_description: Module to manage network interfaces of Virtual Machines in oVirt short_description: Module to manage network interfaces of Virtual Machines in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage network interfaces of Virtual Machines in oVirt." - "Module to manage network interfaces of Virtual Machines in oVirt/RHV."
options: options:
name: name:
description: description:
@ -104,7 +104,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
nic: nic:
description: "Dictionary of all the network interface attributes. Network interface attributes can be found on your oVirt instance description: "Dictionary of all the network interface attributes. Network interface attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/nic." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/nic."
returned: On success if network interface is found. returned: On success if network interface is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_nics_facts module: ovirt_nics_facts
short_description: Retrieve facts about one or more oVirt virtual machine network interfaces short_description: Retrieve facts about one or more oVirt/RHV virtual machine network interfaces
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt virtual machine network interfaces." - "Retrieve facts about one or more oVirt/RHV virtual machine network interfaces."
notes: notes:
- "This module creates a new top-level C(ovirt_nics) fact, which - "This module creates a new top-level C(ovirt_nics) fact, which
contains a list of NICs." contains a list of NICs."

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_permissions module: ovirt_permissions
short_description: "Module to manage permissions of users/groups in oVirt" short_description: "Module to manage permissions of users/groups in oVirt/RHV"
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage permissions of users/groups in oVirt" - "Module to manage permissions of users/groups in oVirt/RHV"
options: options:
role: role:
description: description:
@ -80,7 +80,7 @@ options:
you should ensure the group exists by using M(ovirt_groups) module." you should ensure the group exists by using M(ovirt_groups) module."
authz_name: authz_name:
description: description:
- "Authorization provider of the user/group. In previous versions of oVirt known as domain." - "Authorization provider of the user/group. In previous versions of oVirt/RHV known as domain."
required: true required: true
aliases: ['domain'] aliases: ['domain']
namespace: namespace:
@ -119,7 +119,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
permission: permission:
description: "Dictionary of all the permission attributes. Permission attributes can be found on your oVirt instance description: "Dictionary of all the permission attributes. Permission attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/permission." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/permission."
returned: On success if permission is found. returned: On success if permission is found.
''' '''
@ -210,7 +210,7 @@ class PermissionsModule(BaseModule):
) )
# If found more groups, filter them by namespace and authz name: # If found more groups, filter them by namespace and authz name:
# (filtering here, as oVirt backend doesn't support it) # (filtering here, as oVirt/RHV backend doesn't support it)
if len(groups) > 1: if len(groups) > 1:
groups = [ groups = [
g for g in groups if ( g for g in groups if (

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_permissions_facts module: ovirt_permissions_facts
short_description: Retrieve facts about one or more oVirt permissions short_description: Retrieve facts about one or more oVirt/RHV permissions
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt permissions." - "Retrieve facts about one or more oVirt/RHV permissions."
notes: notes:
- "This module creates a new top-level C(ovirt_permissions) fact, which - "This module creates a new top-level C(ovirt_permissions) fact, which
contains a list of permissions." contains a list of permissions."
@ -44,7 +44,7 @@ options:
- "Name of the the group to manage." - "Name of the the group to manage."
authz_name: authz_name:
description: description:
- "Authorization provider of the user/group. In previous versions of oVirt known as domain." - "Authorization provider of the user/group. In previous versions of oVirt/RHV known as domain."
required: true required: true
aliases: ['domain'] aliases: ['domain']
namespace: namespace:

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_quotas module: ovirt_quotas
short_description: Module to manage datacenter quotas in oVirt short_description: Module to manage datacenter quotas in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage datacenter quotas in oVirt" - "Module to manage datacenter quotas in oVirt/RHV"
options: options:
name: name:
description: description:
@ -122,7 +122,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
quota: quota:
description: "Dictionary of all the quota attributes. Quota attributes can be found on your oVirt instance description: "Dictionary of all the quota attributes. Quota attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/quota." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/quota."
returned: On success if quota is found. returned: On success if quota is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_quotas_facts module: ovirt_quotas_facts
short_description: Retrieve facts about one or more oVirt quotas short_description: Retrieve facts about one or more oVirt/RHV quotas
version_added: "2.3" version_added: "2.3"
author: "Red Hat" author: "Red Hat"
description: description:
- "Retrieve facts about one or more oVirt quotas." - "Retrieve facts about one or more oVirt/RHV quotas."
notes: notes:
- "This module creates a new top-level C(ovirt_quotas) fact, which - "This module creates a new top-level C(ovirt_quotas) fact, which
contains a list of quotas." contains a list of quotas."

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_snapshots module: ovirt_snapshots
short_description: "Module to manage Virtual Machine Snapshots in oVirt" short_description: "Module to manage Virtual Machine Snapshots in oVirt/RHV"
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage Virtual Machine Snapshots in oVirt" - "Module to manage Virtual Machine Snapshots in oVirt/RHV"
options: options:
snapshot_id: snapshot_id:
description: description:
@ -104,7 +104,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
snapshot: snapshot:
description: "Dictionary of all the snapshot attributes. Snapshot attributes can be found on your oVirt instance description: "Dictionary of all the snapshot attributes. Snapshot attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/snapshot." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/snapshot."
returned: On success if snapshot is found. returned: On success if snapshot is found.
''' '''

View file

@ -28,11 +28,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_snapshots_facts module: ovirt_snapshots_facts
short_description: Retrieve facts about one or more oVirt virtual machine snapshots short_description: Retrieve facts about one or more oVirt/RHV virtual machine snapshots
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt virtual machine snapshots." - "Retrieve facts about one or more oVirt/RHV virtual machine snapshots."
notes: notes:
- "This module creates a new top-level C(ovirt_snapshots) fact, which - "This module creates a new top-level C(ovirt_snapshots) fact, which
contains a list of snapshots." contains a list of snapshots."

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_storage_domains module: ovirt_storage_domains
short_description: Module to manage storage domains in oVirt short_description: Module to manage storage domains in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage storage domains in oVirt" - "Module to manage storage domains in oVirt/RHV"
options: options:
name: name:
description: description:
@ -108,7 +108,7 @@ options:
- "This parameter is relevant only when C(state) is I(absent)." - "This parameter is relevant only when C(state) is I(absent)."
format: format:
description: description:
- "If I(True) storage domain will be formatted after removing it from oVirt." - "If I(True) storage domain will be formatted after removing it from oVirt/RHV."
- "This parameter is relevant only when C(state) is I(absent)." - "This parameter is relevant only when C(state) is I(absent)."
extends_documentation_fragment: ovirt extends_documentation_fragment: ovirt
''' '''
@ -178,7 +178,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
storage_domain: storage_domain:
description: "Dictionary of all the storage domain attributes. Storage domain attributes can be found on your oVirt instance description: "Dictionary of all the storage domain attributes. Storage domain attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/storage_domain." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/storage_domain."
returned: On success if storage domain is found. returned: On success if storage domain is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_storage_domains_facts module: ovirt_storage_domains_facts
short_description: Retrieve facts about one or more oVirt storage domains short_description: Retrieve facts about one or more oVirt/RHV storage domains
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt storage domains." - "Retrieve facts about one or more oVirt/RHV storage domains."
notes: notes:
- "This module creates a new top-level C(ovirt_storage_domains) fact, which - "This module creates a new top-level C(ovirt_storage_domains) fact, which
contains a list of storage domains." contains a list of storage domains."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search storage domain X from datacenter Y use following pattern: - "For example to search storage domain X from datacenter Y use following pattern:
name=X and datacenter=Y" name=X and datacenter=Y"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_tags module: ovirt_tags
short_description: Module to manage tags in oVirt short_description: Module to manage tags in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "This module manage tags in oVirt. It can also manage assignments - "This module manage tags in oVirt/RHV. It can also manage assignments
of those tags to entities." of those tags to entities."
options: options:
name: name:
@ -87,7 +87,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
tag: tag:
description: "Dictionary of all the tag attributes. Tag attributes can be found on your oVirt instance description: "Dictionary of all the tag attributes. Tag attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/tag." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/tag."
returned: On success if tag is found. returned: On success if tag is found.
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_tags_facts module: ovirt_tags_facts
short_description: Retrieve facts about one or more oVirt tags short_description: Retrieve facts about one or more oVirt/RHV tags
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt tags." - "Retrieve facts about one or more oVirt/RHV tags."
notes: notes:
- "This module creates a new top-level C(ovirt_tags) fact, which - "This module creates a new top-level C(ovirt_tags) fact, which
contains a list of tags" contains a list of tags"

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_templates module: ovirt_templates
short_description: Module to manage virtual machine templates in oVirt short_description: Module to manage virtual machine templates in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage virtual machine templates in oVirt." - "Module to manage virtual machine templates in oVirt/RHV."
options: options:
name: name:
description: description:
@ -114,7 +114,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
template: template:
description: "Dictionary of all the template attributes. Template attributes can be found on your oVirt instance description: "Dictionary of all the template attributes. Template attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/template." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/template."
returned: On success if template is found. returned: On success if template is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_templates_facts module: ovirt_templates_facts
short_description: Retrieve facts about one or more oVirt templates short_description: Retrieve facts about one or more oVirt/RHV templates
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt templates." - "Retrieve facts about one or more oVirt/RHV templates."
notes: notes:
- "This module creates a new top-level C(ovirt_templates) fact, which - "This module creates a new top-level C(ovirt_templates) fact, which
contains a list of templates." contains a list of templates."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search template X from datacenter Y use following pattern: - "For example to search template X from datacenter Y use following pattern:
name=X and datacenter=Y" name=X and datacenter=Y"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_users module: ovirt_users
short_description: Module to manage users in oVirt short_description: Module to manage users in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage users in oVirt." - "Module to manage users in oVirt/RHV."
options: options:
name: name:
description: description:
@ -44,7 +44,7 @@ options:
default: present default: present
authz_name: authz_name:
description: description:
- "Authorization provider of the user. In previous versions of oVirt known as domain." - "Authorization provider of the user. In previous versions of oVirt/RHV known as domain."
required: true required: true
aliases: ['domain'] aliases: ['domain']
extends_documentation_fragment: ovirt extends_documentation_fragment: ovirt
@ -79,7 +79,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
user: user:
description: "Dictionary of all the user attributes. User attributes can be found on your oVirt instance description: "Dictionary of all the user attributes. User attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/user." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/user."
returned: On success if user is found. returned: On success if user is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_users_facts module: ovirt_users_facts
short_description: Retrieve facts about one or more oVirt users short_description: Retrieve facts about one or more oVirt/RHV users
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt users." - "Retrieve facts about one or more oVirt/RHV users."
notes: notes:
- "This module creates a new top-level C(ovirt_users) fact, which - "This module creates a new top-level C(ovirt_users) fact, which
contains a list of users." contains a list of users."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search user X use following pattern: name=X" - "For example to search user X use following pattern: name=X"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_vmpools module: ovirt_vmpools
short_description: Module to manage VM pools in oVirt short_description: Module to manage VM pools in oVirt/RHV
version_added: "2.3" version_added: "2.3"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "Module to manage VM pools in oVirt." - "Module to manage VM pools in oVirt/RHV."
options: options:
name: name:
description: description:
@ -103,7 +103,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
vm_pool: vm_pool:
description: "Dictionary of all the VM pool attributes. VM pool attributes can be found on your oVirt instance description: "Dictionary of all the VM pool attributes. VM pool attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm_pool." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm_pool."
returned: On success if VM pool is found. returned: On success if VM pool is found.
''' '''

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_vmpools_facts module: ovirt_vmpools_facts
short_description: Retrieve facts about one or more oVirt vmpools short_description: Retrieve facts about one or more oVirt/RHV vmpools
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt vmpools." - "Retrieve facts about one or more oVirt/RHV vmpools."
notes: notes:
- "This module creates a new top-level C(ovirt_vmpools) fact, which - "This module creates a new top-level C(ovirt_vmpools) fact, which
contains a list of vmpools." contains a list of vmpools."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search vmpool X: name=X" - "For example to search vmpool X: name=X"
extends_documentation_fragment: ovirt_facts extends_documentation_fragment: ovirt_facts
''' '''

View file

@ -27,11 +27,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_vms module: ovirt_vms
short_description: "Module to manage Virtual Machines in oVirt" short_description: "Module to manage Virtual Machines in oVirt/RHV"
version_added: "2.2" version_added: "2.2"
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
description: description:
- "This module manages whole lifecycle of the Virtual Machine(VM) in oVirt. Since VM can hold many states in oVirt, - "This module manages whole lifecycle of the Virtual Machine(VM) in oVirt/RHV. Since VM can hold many states in oVirt/RHV,
this see notes to see how the states of the VM are handled." this see notes to see how the states of the VM are handled."
options: options:
name: name:
@ -77,20 +77,20 @@ options:
- "C(memory_guaranteed) parameter can't be lower than C(memory) parameter. Default value is set by engine." - "C(memory_guaranteed) parameter can't be lower than C(memory) parameter. Default value is set by engine."
cpu_shares: cpu_shares:
description: description:
- "Set a CPU shares for this Virtual Machine. Default value is set by oVirt engine." - "Set a CPU shares for this Virtual Machine. Default value is set by oVirt/RHV engine."
cpu_cores: cpu_cores:
description: description:
- "Number of virtual CPUs cores of the Virtual Machine. Default value is set by oVirt engine." - "Number of virtual CPUs cores of the Virtual Machine. Default value is set by oVirt/RHV engine."
cpu_sockets: cpu_sockets:
description: description:
- "Number of virtual CPUs sockets of the Virtual Machine. Default value is set by oVirt engine." - "Number of virtual CPUs sockets of the Virtual Machine. Default value is set by oVirt/RHV engine."
type: type:
description: description:
- "Type of the Virtual Machine. Default value is set by oVirt engine." - "Type of the Virtual Machine. Default value is set by oVirt/RHV engine."
choices: [server, desktop] choices: [server, desktop]
operating_system: operating_system:
description: description:
- "Operating system of the Virtual Machine. Default value is set by oVirt engine." - "Operating system of the Virtual Machine. Default value is set by oVirt/RHV engine."
choices: [ choices: [
rhel_6_ppc64, other, freebsd, windows_2003x64, windows_10, rhel_6x64, rhel_4x64, windows_2008x64, rhel_6_ppc64, other, freebsd, windows_2003x64, windows_10, rhel_6x64, rhel_4x64, windows_2008x64,
windows_2008R2x64, debian_7, windows_2012x64, ubuntu_14_04, ubuntu_12_04, ubuntu_13_10, windows_8x64, windows_2008R2x64, debian_7, windows_2012x64, ubuntu_14_04, ubuntu_12_04, ubuntu_13_10, windows_8x64,
@ -102,7 +102,7 @@ options:
boot_devices: boot_devices:
description: description:
- "List of boot devices which should be used to boot. Choices I(network), I(hd) and I(cdrom)." - "List of boot devices which should be used to boot. Choices I(network), I(hd) and I(cdrom)."
- "For example: ['cdrom', 'hd']. Default value is set by oVirt engine." - "For example: ['cdrom', 'hd']. Default value is set by oVirt/RHV engine."
host: host:
description: description:
- "Specify host where Virtual Machine should be running. By default the host is chosen by engine scheduler." - "Specify host where Virtual Machine should be running. By default the host is chosen by engine scheduler."
@ -111,17 +111,17 @@ options:
description: description:
- "If I(True) Virtual Machine will be set as highly available." - "If I(True) Virtual Machine will be set as highly available."
- "If I(False) Virtual Machine won't be set as highly available." - "If I(False) Virtual Machine won't be set as highly available."
- "If no value is passed, default value is set by oVirt engine." - "If no value is passed, default value is set by oVirt/RHV engine."
delete_protected: delete_protected:
description: description:
- "If I(True) Virtual Machine will be set as delete protected." - "If I(True) Virtual Machine will be set as delete protected."
- "If I(False) Virtual Machine won't be set as delete protected." - "If I(False) Virtual Machine won't be set as delete protected."
- "If no value is passed, default value is set by oVirt engine." - "If no value is passed, default value is set by oVirt/RHV engine."
stateless: stateless:
description: description:
- "If I(True) Virtual Machine will be set as stateless." - "If I(True) Virtual Machine will be set as stateless."
- "If I(False) Virtual Machine will be unset as stateless." - "If I(False) Virtual Machine will be unset as stateless."
- "If no value is passed, default value is set by oVirt engine." - "If no value is passed, default value is set by oVirt/RHV engine."
clone: clone:
description: description:
- "If I(True) then the disks of the created virtual machine will be cloned and independent of the template." - "If I(True) then the disks of the created virtual machine will be cloned and independent of the template."
@ -426,7 +426,7 @@ id:
type: str type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
vm: vm:
description: "Dictionary of all the VM attributes. VM attributes can be found on your oVirt instance description: "Dictionary of all the VM attributes. VM attributes can be found on your oVirt/RHV instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm." at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm."
returned: On success if VM is found. returned: On success if VM is found.
''' '''
@ -459,7 +459,7 @@ class VmsModule(BaseModule):
def __get_template_with_version(self): def __get_template_with_version(self):
""" """
oVirt in version 4.1 doesn't support search by template+version_number, oVirt/RHV in version 4.1 doesn't support search by template+version_number,
so we need to list all templates with specific name and then iterate so we need to list all templates with specific name and then iterate
through it's version until we find the version we look for. through it's version until we find the version we look for.
""" """

View file

@ -27,18 +27,18 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ovirt_vms_facts module: ovirt_vms_facts
short_description: Retrieve facts about one or more oVirt virtual machines short_description: Retrieve facts about one or more oVirt/RHV virtual machines
author: "Ondra Machacek (@machacekondra)" author: "Ondra Machacek (@machacekondra)"
version_added: "2.3" version_added: "2.3"
description: description:
- "Retrieve facts about one or more oVirt virtual machines." - "Retrieve facts about one or more oVirt/RHV virtual machines."
notes: notes:
- "This module creates a new top-level C(ovirt_vms) fact, which - "This module creates a new top-level C(ovirt_vms) fact, which
contains a list of virtual machines." contains a list of virtual machines."
options: options:
pattern: pattern:
description: description:
- "Search term which is accepted by oVirt search backend." - "Search term which is accepted by oVirt/RHV search backend."
- "For example to search VM X from cluster Y use following pattern: - "For example to search VM X from cluster Y use following pattern:
name=X and cluster=Y" name=X and cluster=Y"
all_content: all_content: