W3cubDocs

/Ansible

cs_configuration - Manages configuration on Apache CloudStack based clouds.

New in version 2.1.

Synopsis

  • Manages global, zone, account, storage and cluster configurations.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
Ensure the value for corresponding account.
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.
cluster
 no
Ensure the value for corresponding cluster.
domain
 no ROOT
Domain the account is related to.
Only considered if account is used.
name
 yes
Name of the configuration.
storage
 no
Ensure the value for corresponding storage pool.
value
 yes
Value of the configuration.
zone
 no
Ensure the value for corresponding zone.

Examples

# Ensure global configuration
- local_action:
    module: cs_configuration
    name: router.reboot.when.outofband.migrated
    value: false

# Ensure zone configuration
- local_action:
    module: cs_configuration
    name: router.reboot.when.outofband.migrated
    zone: ch-gva-01
    value: true

# Ensure storage configuration
- local_action:
    module: cs_configuration
    name: storage.overprovisioning.factor
    storage: storage01
    value: 2.0

# Ensure account configuration
- local_action:
    module: cs_configuration
    name: allow.public.user.templates
    value: false
    account: acme inc
    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
category
Category of the configuration.
 success string Advanced
account
Account of the configuration.
 success string admin
description
Description of the configuration.
 success string Setup the host to do multipath
zone
Zone of the configuration.
 success string ch-gva-01
storage
Storage of the configuration.
 success string storage01
Domain
Domain of account of the configuration.
 success string ROOT
value
Value of the configuration.
 success string 0.75
cluster
Cluster of the configuration.
 success string cluster01
scope
Scope (zone/cluster/storagepool/account) of the parameter that needs to be updated.
 success string storagepool
name
Name of the configuration.
 success string zone.vlan.capacity.notificationthreshold

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.

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cs_configuration_module.html