Documentation

os_quota - Manage OpenStack Quotas

New in version 2.3.

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 (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade
  • shade > 1.9.0

Options

parameter required default choices comments
api_timeout
no None
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.
auth
no
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 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.
auth_type
no password
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.
availability_zone
no
Ignored. Present for backwards compatability
backup_gigabytes
no None
Maximum size of backups in GB's.
backups
no None
Maximum number of backups allowed.
cacert
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
no None
A path to a client certificate to use as part of the SSL transaction.
cloud
no
Named cloud to operate against. 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.
cores
no None
Maximum number of CPU's per project.
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
fixed_ips
no None
Number of fixed IP's to allow.
floating_ips
no None
Number of floating IP's to allow in Compute.

aliases: compute_floating_ips
floatingip
no None
Number of floating IP's to allow in Network.

aliases: network_floating_ips
gigabytes
no None
Maximum volume storage allowed for project.
gigabytes_lvm
no None
Maximum size in GB's of individual lvm volumes.
injected_file_size
no None
Maximum file size in bytes.
injected_files
no None
Number of injected files to allow.
injected_path_size
no None
Maximum path size.
instances
no None
Maximum number of instances allowed.
key
no None
A path to a client key to use as part of the SSL transaction.
key_pairs
no None
Number of key pairs to allow.
name
yes
Name of the OpenStack Project to manage.
network
no None
Number of networks to allow.
per_volume_gigabytes
no None
Maximum size in GB's of individual volumes.
port
no None
Number of Network ports to allow, this needs to be greater than the instances limit.
properties
no None
Number of properties to allow.
ram
no None
Maximum amount of ram in MB to allow.
rbac_policy
no None
Number of policies to allow.
region_name
no
Name of the region.
router
no None
Number of routers to allow.
security_group
no None
Number of security groups to allow.
security_group_rule
no None
Number of rules per security group to allow.
server_group_members
no None
Number of server group members to allow.
server_groups
no None
Number of server groups to allow.
snapshots
no None
Number of snapshots to allow.
snapshots_lvm
no None
Number of LVM snapshots to allow.
state
no present
A value of present sets the quota and a value of absent resets the quota to system defaults.
subnet
no None
Number of subnets to allow.
subnetpool
no None
Number of subnet pools to allow.
timeout
no 180
How long should ansible wait for the requested resource.
validate_certs
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
volumes
no None
Number of volumes to allow.
volumes_lvm
no None
Number of LVM volumes to allow.
wait
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

Examples

# List a Project Quota
- os_quota:
    cloud: mycloud
    name: demoproject

# Set a Project back to the defaults
- os_quota:
    cloud: mycloud
    name: demoproject
    state: absent

# Update a Project Quota for cores
- os_quota:
    cloud: mycloud
    name: demoproject
    cores: 100

# Update a Project Quota
- os_quota:
    name: demoproject
    cores: 1000
    volumes: 20
    volumes_type:
      - volume_lvm: 10

# Complete example based on list of projects
- name: Update quotas
  os_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 }}"
    port: "{{ item.port }}"
    key_pairs: "{{ item.key_pairs }}"
    per_volume_gigabytes: "{{ item.per_volume_gigabytes }}"
    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 Return Values, the following are the fields unique to this module:

name description returned type sample
openstack_quotas Dictionary describing the project quota. Regardless if changes where made or note dictionary
contains:
name description returned type sample


Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.