Documentation

cs_resourcelimit - Manages resource limits on Apache CloudStack based clouds.

New in version 2.1.

Synopsis

  • Manage limits of resources for domains, accounts and projects.

Options

parameter required default choices comments
account
no
Account the resource is related to.
api_http_method
no get
  • get
  • post
HTTP method used.
api_key
no
API key of the CloudStack API.
api_region
no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
no
Secret key of the CloudStack API.
api_timeout
no 10
HTTP timeout.
api_url
no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain
no
Domain the resource is related to.
limit
no -1
Maximum number of the resource.
Default is unlimited -1.

aliases: max
project
no
Name of the project the resource is related to.
resource_type
yes
  • instance
  • ip_address
  • volume
  • snapshot
  • template
  • network
  • vpc
  • cpu
  • memory
  • primary_storage
  • secondary_storage
Type of the resource.

aliases: type

Examples

# Update a resource limit for instances of a domain
local_action:
  module: cs_resourcelimit
  type: instance
  limit: 10
  domain: customers

# Update a resource limit for instances of an account
local_action:
  module: cs_resourcelimit
  type: instance
  limit: 12
  account: moserre
  domain: customers

Return Values

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

name description returned type sample
project Project the resource is related to. success string example project
domain Domain the resource is related to. success string example domain
limit Maximum number of the resource. success int -1
account Account the resource is related to. success string example account
recource_type Type of the resource success string instance


Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

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, Testing Ansible and Developing Modules.