ovirt_vmpools - Module to manage VM pools in oVirt

New in version 2.3.

Synopsis

Module to manage VM pools in oVirt.

Requirements (on host that executes module)

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

Options

parameter required default choices comments
auth
 yes
    Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
    username[required] - The name of the user, something like `admin@internal`.
    password[required] - The password of the user.
    url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
    token - Token to be used instead of login with username/password.
    insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.
    ca_file - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used.
    kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
    cluster
    		 no
      Name of the cluster, where VM pool should be created.
      description
      		 no
        Description of the VM pool.
        name
        		 yes
          Name of the the VM pool to manage.
          poll_interval
          		 no 3
            Number of the seconds the module waits until another poll request on entity status is sent.
            prestarted
            		 no
              Number of pre-started VMs defines the number of VMs in run state, that are waiting to be attached to Users.
              Default value is set by engine.
              state
              		 no present
              • present
              • absent
              Should the VM pool be present/absent.
              Note that when state is absent all VMs in VM pool are stopped and removed.
              template
              		 no
                Name of the template, which will be used to create VM pool.
                timeout
                		 no 180
                  The amount of time in seconds the module should wait for the instance to get into desired state.
                  type
                  		 no
                  • manual
                  • automatic
                  Type of the VM pool. Either manual or automatic.
                  manual - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.
                  Automatic - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.
                  Default value is set by engine.
                  vm_count
                  		 no
                    Number of VMs in the pool.
                    Default value is set by engine.
                    vm_per_user
                    		 no
                      Maximum number of VMs a single user can attach to from this pool.
                      Default value is set by engine.
                      wait
                      		 no
                        True if the module should wait for the entity to get into desired state.

                        Examples

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

# Create VM pool from template
- ovirt_vmpools:
    cluster: mycluster
    name: myvmpool
    template: rhel7
    vm_count: 2
    prestarted: 2
    vm_per_user: 1

# Remove vmpool, note that all VMs in pool will be stopped and removed:
- ovirt_vmpools:
    state: absent
    name: myvmpool

                        Return Values

                        Common return values are documented here common_return_values, the following are the fields unique to this module:

                        name description returned type sample
                        vm_pool Dictionary of all the VM pool attributes. VM pool attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm_pool. On success if VM pool is found.
                        id ID of the VM pool which is managed On success if VM pool is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c


                        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.0.0

                        This is an Extras Module

                        For more information on what this means please read modules_extra

                        For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.