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.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.6.10

Parameters

Parameter Choices/Defaults Comments
account
Account the resource is related to.
api_http_method
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
api_key
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_region Default:
cloudstack
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
api_secret
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_timeout
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
api_url
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
domain
Domain the resource is related to.
limit Default:
-1
Maximum number of the resource.
Default is unlimited -1.

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

aliases: type

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 in the CloudStack Cloud Guide.
  • This module supports check mode.

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, the following are the fields unique to this module:

Key Returned Description
account
string
 success
Account the resource is related to.

Sample:
example account
domain
string
 success
Domain the resource is related to.

Sample:
example domain
limit
int
 success
Maximum number of the resource.

Sample:
-1
project
string
 success
Project the resource is related to.

Sample:
example project
recource_type
string
 success
Type of the resource

Sample:
instance


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.

Author

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.