ngine_io.cloudstack.cs_configuration – Manages configuration on Apache CloudStack based clouds.

Note

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

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

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

New in version 0.1.0: of ngine_io.cloudstack

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

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

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		Ensure the value for corresponding account.
api_http_method string	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.
cluster string		Ensure the value for corresponding cluster.
domain string	Default: "ROOT"	Domain the account is related to. Only considered if account is used.
name string / required		Name of the configuration.
storage string		Ensure the value for corresponding storage pool.
value string / required		Value of the configuration.
zone string		Ensure the value for corresponding zone.

Notes

Note

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

Examples

- name: Ensure global configuration
  ngine_io.cloudstack.cs_configuration:
    name: router.reboot.when.outofband.migrated
    value: false

- name: Ensure zone configuration
  ngine_io.cloudstack.cs_configuration:
    name: router.reboot.when.outofband.migrated
    zone: ch-gva-01
    value: true

- name: Ensure storage configuration
  ngine_io.cloudstack.cs_configuration:
    name: storage.overprovisioning.factor
    storage: storage01
    value: 2.0

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

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/2.11/collections/ngine_io/cloudstack/cs_configuration_module.html