W3cubDocs

/Ansible

ngine_io.cloudstack.cs_resourcelimit – Manages resource limits on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).

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 ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_resourcelimit.

New in version 0.1.0: of ngine_io.cloudstack

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.9.0

Parameters

Parameter Choices/Defaults Comments
account
string
Account the resource is related to.
api_http_method
string
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
domain
string
Domain the resource is related to.
limit
integer
Default:
-1
Maximum number of the resource.
Default is unlimited -1.

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

aliases: type

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Update a resource limit for instances of a domain
  ngine_io.cloudstack.cs_resourcelimit:
    type: instance
    limit: 10
    domain: customers

- name: Update a resource limit for instances of an account
  ngine_io.cloudstack.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
integer
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


Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_resourcelimit_module.html