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

Note

This module is part of the ngine_io.cloudstack collection (version 2.3.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 ngine\_io.cloudstack. You need further requirements to be able to use this module, see Requirements for details.

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

New in ngine_io.cloudstack 0.1.0

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

Comments

account

string

Account the resource is related to.

api_http_method

string

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

Choices:

  • "get" ← (default)

  • "post"

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

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

Default: 10

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

aliases: max

integer

Maximum number of the resource.

Default is unlimited -1.

Default: -1

project

string

Name of the project the resource is related to.

resource_type

aliases: type

string / required

Type of the resource.

Choices:

  • "instance"

  • "ip_address"

  • "volume"

  • "snapshot"

  • "template"

  • "network"

  • "vpc"

  • "cpu"

  • "memory"

  • "primary_storage"

  • "secondary_storage"

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

Description

account

string

Account the resource is related to.

Returned: success

Sample: "example account"

domain

string

Domain the resource is related to.

Returned: success

Sample: "example domain"

limit

integer

Maximum number of the resource.

Returned: success

Sample: -1

project

string

Project the resource is related to.

Returned: success

Sample: "example project"

recource_type

string

Type of the resource

Returned: success

Sample: "instance"

Authors

  • René Moser (@resmo)