pkubica.ovirt.ovirt_vm_info (1.4.3) — module

Install collection

Install with ansible-galaxy collection install pkubica.ovirt:==1.4.3

Add to requirements.yml

  collections:
    - name: pkubica.ovirt
      version: 1.4.3

Description

Retrieve information about one or more oVirt/RHV virtual machines.

This module was called C(ovirt_vm_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(pkubica.ovirt.ovirt_vm_info) module no longer returns C(ansible_facts)!

Requirements

• python >= 2.7
• ovirt-engine-sdk-python >= 4.4.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather information about all VMs which names start with C(centos) and
# belong to cluster C(west):
- pkubica.ovirt.ovirt_vm_info:
    pattern: name=centos* and cluster=west
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.builtin.debug:
    msg: "{{ result.ovirt_vms }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather info about next run configuration of virtual machine named myvm
- pkubica.ovirt.ovirt_vm_info:
    pattern: name=myvm
    next_run: true
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.builtin.debug:
    msg: "{{ result.ovirt_vms[0] }}"

Inputs

    
max:
    description:
    - The maximum number of results to return.
    type: int

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:
        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

pattern:
    description:
    - Search term which is accepted by oVirt/RHV search backend.
    - 'For example to search VM X from cluster Y use following pattern: name=X and cluster=Y'
    type: str

next_run:
    description:
    - Indicates if the returned result describes the virtual machine as it is currently
      running or if describes the virtual machine with the modifications that have already
      been performed but that will only come into effect when the virtual machine is restarted.
      By default the value is set by engine.
    type: bool

current_cd:
    description:
    - If I(true) it will get from all virtual machines current attached cd.
    type: bool
    version_added: 1.2.0
    version_added_collection: pkubica.ovirt

all_content:
    description:
    - If I(true) all the attributes of the virtual machines should be included in the
      response.
    type: bool

fetch_nested:
    description:
    - If I(yes) the module will fetch additional data from the API.
    - It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested
      attributes. Only the attributes of the current entity. User can configure to fetch
      other attributes of the nested entities by specifying C(nested_attributes).
    type: bool

case_sensitive:
    default: true
    description:
    - If I(true) performed search will take case into account.
    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

Outputs

ovirt_vms:
  description: 'List of dictionaries describing the VMs. VM attributes are mapped
    to dictionary keys, all VMs attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm.'
  returned: On success.
  type: list