Try SpotterModule to manage tags in oVirt/RHV
| "added in version" 1.0.0 of ovirt.ovirt_collection"
Authors: Ondra Machacek (@machacekondra), Martin Necas (@mnecas)
preview | supported by community
Install with ansible-galaxy collection install ovirt.ovirt_collection:==1.0.2
collections:
- name: ovirt.ovirt_collection
version: 1.0.2This module manage tags in oVirt/RHV. It can also manage assignments of those tags to entities.
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create(if not exists) and assign tag to vms vm1 and vm2:
- ovirt_tag:
name: mytag
vms:
- vm1
- vm2
# Attach a tag to VM 'vm3', keeping the rest already attached tags on VM:
- ovirt_tag:
name: mytag
state: attached
vms:
- vm3
# Detach a tag from VM 'vm3', keeping the rest already attached tags on VM:
- ovirt_tag:
name: mytag
state: detached
vms:
- vm3
# To detach all VMs from tag:
- ovirt_tag:
name: mytag
vms: []
# Remove tag
- ovirt_tag:
state: absent
name: mytag
# Change Tag Name
- ovirt_tag:
id: 00000000-0000-0000-0000-000000000000
name: "new_tag_name"
id:
description:
- ID of the tag to manage.
vms:
description:
- List of the VMs names, which should have assigned this tag.
auth:
description:
- 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:'
required: true
suboptions:
ca_file:
description:
- A PEM file containing the trusted CA certificates.
- The certificate presented by the server will be verified using these CA certificates.
- If C(ca_file) parameter is not set, system wide CA certificate store is used.
- Default value is set by C(OVIRT_CAFILE) environment variable.
type: str
headers:
description:
- Dictionary of HTTP headers to be added to each API call.
type: dict
hostname:
description:
- A string containing the hostname of the server, usually something like `I(server.example.com)`.
- Default value is set by C(OVIRT_HOSTNAME) environment variable.
- Either C(url) or C(hostname) is required.
type: str
insecure:
description:
- A boolean flag that indicates if the server TLS certificate and host name should
be checked.
type: bool
kerberos:
description:
- A boolean flag indicating if Kerberos authentication should be used instead
of the default basic authentication.
type: bool
password:
description:
- The password of the user.
- Default value is set by C(OVIRT_PASSWORD) environment variable.
required: true
type: str
token:
description:
- Token to be used instead of login with username/password.
- Default value is set by C(OVIRT_TOKEN) environment variable.
type: str
url:
description:
- A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`.
- Default value is set by C(OVIRT_URL) environment variable.
- Either C(url) or C(hostname) is required.
type: str
username:
description:
- The name of the user, something like I(admin@internal).
- Default value is set by C(OVIRT_USERNAME) environment variable.
required: true
type: str
type: dict
name:
description:
- Name of the tag to manage.
required: true
wait:
default: true
description:
- C(yes) if the module should wait for the entity to get into desired state.
type: bool
hosts:
description:
- List of the hosts names, which should have assigned this tag.
state:
choices:
- present
- absent
- attached
- detached
default: present
description:
- Should the tag be present/absent/attached/detached.
- 'C(Note): I(attached) and I(detached) states are supported since version 2.4.'
parent:
description:
- Name of the parent tag.
timeout:
default: 180
description:
- The amount of time in seconds the module should wait for the instance to get into
desired state.
type: int
description:
description:
- Description of the tag to manage.
fetch_nested:
description:
- If I(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 C(nested_attributes).
type: bool
poll_interval:
default: 3
description:
- Number of the seconds the module waits until another poll request on entity status
is sent.
type: int
nested_attributes:
description:
- Specifies list of the attributes which should be fetched from the API.
- This parameter apply only when C(fetch_nested) is I(true).
type: list
id:
description: ID of the tag which is managed
returned: On success if tag is found.
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
type: str
tag:
description: 'Dictionary of all the tag attributes. Tag attributes can be found
on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag.'
returned: On success if tag is found.
type: dict