openstack.cloud.quota module – Manage OpenStack Quotas
Note
This module is part of the openstack.cloud collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.quota
.
Synopsis
Manage OpenStack Quotas. Quotas can be created, updated or deleted using this module. A quota will be updated if matches an existing project and is present.
Requirements
The below requirements are needed on the host that executes this module.
keystoneauth1 >= 3.4.0
openstacksdk >= 0.13.0
openstacksdk >= 0.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
Ignored. Present for backwards compatibility |
|
Maximum size of backups in GB’s. |
|
Maximum number of backups allowed. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Maximum number of CPU’s per project. |
|
Number of fixed IP’s to allow. |
|
Number of floating IP’s to allow in Compute. |
|
Number of floating IP’s to allow in Network. |
|
Maximum volume storage allowed for project. |
|
Per driver volume storage quotas. Keys should be prefixed with |
|
Maximum file size in bytes. |
|
Number of injected files to allow. |
|
Maximum path size. |
|
Maximum number of instances allowed. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Number of key pairs to allow. |
|
Number of load balancers to allow. |
|
Number of metadata items allowed per instance. |
|
Name of the OpenStack Project to manage. |
|
Number of networks to allow. |
|
Maximum size in GB’s of individual volumes. |
|
Number of load balancer pools to allow. |
|
Number of Network ports to allow, this needs to be greater than the instances limit. |
|
Unused, kept for compatability |
|
Number of properties to allow. |
|
Maximum amount of ram in MB to allow. |
|
Number of policies to allow. |
|
Name of the region. |
|
Number of routers to allow. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Number of security groups to allow. |
|
Number of rules per security group to allow. |
|
Number of server group members to allow. |
|
Number of server groups to allow. |
|
Number of snapshots to allow. |
|
Per-driver volume snapshot quotas. Keys should be prefixed with |
|
A value of present sets the quota and a value of absent resets the quota to system defaults. Choices:
|
|
Number of subnets to allow. |
|
Number of subnet pools to allow. |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Number of volumes to allow. |
|
Per-driver volume count quotas. Keys should be prefixed with |
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAME
may be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
# List a Project Quota
- openstack.cloud.quota:
cloud: mycloud
name: demoproject
# Set a Project back to the defaults
- openstack.cloud.quota:
cloud: mycloud
name: demoproject
state: absent
# Update a Project Quota for cores
- openstack.cloud.quota:
cloud: mycloud
name: demoproject
cores: 100
# Update a Project Quota
- openstack.cloud.quota:
name: demoproject
cores: 1000
volumes: 20
volumes_type:
- volume_lvm: 10
# Complete example based on list of projects
- name: Update quotas
openstack.cloud.quota:
name: "{{ item.name }}"
backup_gigabytes: "{{ item.backup_gigabytes }}"
backups: "{{ item.backups }}"
cores: "{{ item.cores }}"
fixed_ips: "{{ item.fixed_ips }}"
floating_ips: "{{ item.floating_ips }}"
floatingip: "{{ item.floatingip }}"
gigabytes: "{{ item.gigabytes }}"
injected_file_size: "{{ item.injected_file_size }}"
injected_files: "{{ item.injected_files }}"
injected_path_size: "{{ item.injected_path_size }}"
instances: "{{ item.instances }}"
key_pairs: "{{ item.key_pairs }}"
loadbalancer: "{{ item.loadbalancer }}"
metadata_items: "{{ item.metadata_items }}"
per_volume_gigabytes: "{{ item.per_volume_gigabytes }}"
pool: "{{ item.pool }}"
port: "{{ item.port }}"
properties: "{{ item.properties }}"
ram: "{{ item.ram }}"
security_group_rule: "{{ item.security_group_rule }}"
security_group: "{{ item.security_group }}"
server_group_members: "{{ item.server_group_members }}"
server_groups: "{{ item.server_groups }}"
snapshots: "{{ item.snapshots }}"
volumes: "{{ item.volumes }}"
volumes_types:
volumes_lvm: "{{ item.volumes_lvm }}"
snapshots_types:
snapshots_lvm: "{{ item.snapshots_lvm }}"
gigabytes_types:
gigabytes_lvm: "{{ item.gigabytes_lvm }}"
with_items:
- "{{ projects }}"
when: item.state == "present"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the project quota. Returned: Regardless if changes where made or not Sample: |