mnecas / mnecas.ovirt / 1.5.5 / module / ovirt_affinity_group Module to manage affinity groups in oVirt/RHV | "added in version" 1.0.0 of mnecas.ovirt" Authors: Ondra Machacek (@machacekondra), Martin Necas (@mnecas)mnecas.ovirt.ovirt_affinity_group (1.5.5) — module
Install with ansible-galaxy collection install mnecas.ovirt:==1.5.5
collections: - name: mnecas.ovirt version: 1.5.5
This module manage affinity groups in oVirt/RHV. It can also manage assignments of those groups to VMs.
# Examples don't contain auth parameter for simplicity, # look at ovirt_auth module to see how to reuse authentication: - name: Create(if not exists) and assign affinity group to VMs vm1 and vm2 and host host1 mnecas.ovirt.ovirt_affinity_group: name: mygroup cluster: mycluster vm_enforcing: true vm_rule: positive host_enforcing: true host_rule: positive vms: - vm1 - vm2 hosts: - host1
- name: Detach VMs from affinity group and disable VM rule mnecas.ovirt.ovirt_affinity_group: name: mygroup cluster: mycluster vm_enforcing: false vm_rule: disabled host_enforcing: true host_rule: positive vms: [] hosts: - host1 - host2
- name: Remove affinity group mnecas.ovirt.ovirt_affinity_group: state: absent cluster: mycluster name: mygroup
vms: description: - List of the VMs names, which should have assigned this affinity group. elements: str type: list 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 compress: default: true description: Flag indicating if compression is used for connection. type: bool 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: default: false 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 timeout: description: Number of seconds to wait for response. type: int 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 affinity group to manage. required: true type: str 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 affinity group. - This parameter is support since oVirt/RHV 4.1 version. elements: str type: list state: choices: - absent - present default: present description: - Should the affinity group be present or absent. type: str cluster: description: - Name of the cluster of the affinity group. required: true type: str timeout: default: 180 description: - The amount of time in seconds the module should wait for the instance to get into desired state. type: int vm_rule: choices: - disabled - negative - positive description: - If I(positive) I(all) VMs in this group should run on the host defined by C(host_rule). - If I(negative) I(no) VMs in this group should run on the host defined by C(host_rule). - If I(disabled) this affinity group doesn't take effect. type: str host_rule: choices: - disabled - negative - positive description: - 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(disabled) this affinity group doesn't take effect. - This parameter is support since oVirt/RHV 4.1 version. type: str description: description: - Description of the affinity group. type: str fetch_nested: default: false 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 vm_enforcing: description: - If I(yes) VM cannot start if it does not satisfy the C(vm_rule). 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 host_enforcing: description: - If I(yes) VM cannot start on host if it does not satisfy the C(host_rule). - This parameter is support since oVirt/RHV 4.1 version. type: bool 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). elements: str type: list
affinity_group: description: 'Dictionary of all the affinity group attributes. Affinity group attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_group.' returned: On success if affinity group is found. type: str id: description: ID of the affinity group which is managed returned: On success if affinity group is found. sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c type: str