ovirt_quotas - Module to manage datacenter quotas in oVirt

New in version 2.3.

Synopsis

Module to manage datacenter quotas 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_grace
    		 no
      Cluster grace(hard limit) defined in percentage (1-100).
      cluster_threshold
      		 no
        Cluster threshold(soft limit) defined in percentage (0-100).
        clusters
        		 no
          List of dictionary of cluster limits, which is valid to specific cluster.
          If cluster isn't spefied it's valid to all clusters in system:
          cluster - Name of the cluster.
          memory - Memory limit (in GiB).
          cpu - CPU limit.
          datacenter
          		 yes
            Name of the datacenter where quota should be managed.
            description
            		 no
              Description of the the quota to manage.
              name
              		 yes
                Name of the the quota to manage.
                poll_interval
                		 no 3
                  Number of the seconds the module waits until another poll request on entity status is sent.
                  state
                  		 no present
                  • present
                  • absent
                  Should the quota be present/absent.
                  storage_grace
                  		 no
                    Storage grace(hard limit) defined in percentage (1-100).
                    storage_threshold
                    		 no
                      Storage threshold(soft limit) defined in percentage (0-100).
                      storages
                      		 no
                        List of dictionary of storage limits, which is valid to specific storage.
                        If storage isn't spefied it's valid to all storages in system:
                        storage - Name of the storage.
                        size - Size limit (in GiB).
                        timeout
                        		 no 180
                          The amount of time in seconds the module should wait for the instance to get into desired state.
                          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:

# Add cluster quota to cluster cluster1 with memory limit 20GiB and CPU limit to 10:
ovirt_quotas:
    name: quota1
    datacenter: dcX
    clusters:
        - name: cluster1
          memory: 20
          cpu: 10

# Add cluster quota to all clusters with memory limit 30GiB and CPU limit to 15:
ovirt_quotas:
    name: quota2
    datacenter: dcX
    clusters:
        - memory: 30
          cpu: 15

# Add storage quota to storage data1 with size limit to 100GiB
ovirt_quotas:
    name: quota3
    datacenter: dcX
    storage_grace: 40
    storage_threshold: 60
    storages:
        - name: data1
          size: 100

# Remove quota quota1 (Note the quota must not be assigned to any VM/disk):
ovirt_quotas:
    state: absent
    datacenter: dcX
    name: quota1

                            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
                            id ID of the quota which is managed On success if quota is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
                            quota Dictionary of all the quota attributes. Quota attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/quota. On success if quota is found.


                            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.