openstack.cloud.quota module – Manage OpenStack Quotas
Note
This module is part of the openstack.cloud collection (version 2.2.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.
python >= 3.6
openstacksdk >= 1.0.0
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. |
|
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. Available until Nova API version 2.35. |
|
Number of floating IP’s to allow. |
|
Maximum volume storage allowed for project. |
|
Number of groups that are allowed for the project |
|
Maximum file size in bytes. Available until Nova API version 2.56. |
|
Maximum path size. Available until Nova API version 2.56. |
|
Number of injected files to allow. Available until Nova API version 2.56. |
|
Maximum number of instances allowed. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Number of key pairs to allow. |
|
The maximum amount of load balancers you can create |
|
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. |
|
The maximum number of pools you can create |
|
Number of Network ports to allow, this needs to be greater than the instances limit. |
|
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 rules per security group to allow. |
|
Number of security groups to allow. |
|
Number of server group members to allow. |
|
Number of server groups to allow. |
|
Number of snapshots to allow. |
|
A value of Choices:
|
|
Number of subnet pools to allow. |
|
Number of subnets 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. |
|
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
- name: Fetch current project quota
openstack.cloud.quota:
cloud: mycloud
name: demoproject
- name: Reset project quota back to defaults
openstack.cloud.quota:
cloud: mycloud
name: demoproject
state: absent
- name: Change number of cores and volumes
openstack.cloud.quota:
cloud: mycloud
name: demoproject
cores: 100
volumes: 20
- name: Update quota again
openstack.cloud.quota:
cloud: mycloud
name: demo_project
floating_ips: 5
networks: 50
ports: 300
rbac_policies: 5
routers: 5
subnets: 5
subnet_pools: 5
security_group_rules: 5
security_groups: 5
backup_gigabytes: 500
backups: 5
gigabytes: 500
groups: 1
pools: 5
per_volume_gigabytes: 10
snapshots: 5
volumes: 5
cores: 5
instances: 5
key_pairs: 5
metadata_items: 5
ram: 5
server_groups: 5
server_group_members: 5
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: |
|
Compute service quotas Returned: success |
|
Maximum number of CPU’s per project. Returned: success |
|
Maximum file size in bytes. Returned: success |
|
Maximum path size. Returned: success |
|
Number of injected files to allow. Returned: success |
|
Maximum number of instances allowed. Returned: success |
|
Number of key pairs to allow. Returned: success |
|
Number of metadata items allowed per instance. Returned: success |
|
Maximum amount of ram in MB to allow. Returned: success |
|
Number of server group members to allow. Returned: success |
|
Number of server groups to allow. Returned: success |
|
Network service quotas Returned: success |
|
Number of floating IP’s to allow. Returned: success |
|
The maximum amount of load balancers one can create Returned: success |
|
Number of networks to allow. Returned: success |
|
The maximum amount of pools one can create. Returned: success |
|
Number of Network ports to allow, this needs to be greater than the instances limit. Returned: success |
|
Number of policies to allow. Returned: success |
|
Number of routers to allow. Returned: success |
|
Number of rules per security group to allow. Returned: success |
|
Number of security groups to allow. Returned: success |
|
Number of subnet pools to allow. Returned: success |
|
Number of subnets to allow. Returned: success |
|
Block storage service quotas Returned: success |
|
Maximum size of backups in GB’s. Returned: success |
|
Maximum number of backups allowed. Returned: success |
|
Maximum volume storage allowed for project. Returned: success |
|
Number of groups that are allowed for the project Returned: success |
|
Maximum size in GB’s of individual volumes. Returned: success |
|
Number of snapshots to allow. Returned: success |
|
Number of volumes to allow. Returned: success |