ngine_io.cloudstack.configuration_info module – Gathering information about configurations from Apache CloudStack based clouds.

Note

This module is part of the ngine_io.cloudstack collection (version 3.0.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.configuration_info.

New in ngine_io.cloudstack 3.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Gathering information from the API about configurations.

Requirements

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

python >= 2.6
cs >= 0.9.0

Parameters

Parameter	Comments
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.
name string	Name of the configuration. If not specified, information about all configurations is gathered.
validate_certs boolean added in ngine_io.cloudstack 2.4.0	If `false`, SSL certificates will not be validated. If not given, the `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` env variable is considered. This should only be used on personally controlled sites using self-signed certificates. Choices: `false` `true` ← (default)

Notes

Note

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

Examples

- name: Gather information about a specific configuration
  ngine_io.cloudstack.configuration_info:
    name: consoleproxy.sslEnabled
  register: config

- name: Show the returned results of the registered variable
  debug:
    msg: "{{ config }}"

- name: Gather information about all configurations
  ngine_io.cloudstack.configuration_info:
  register: configs

- name: Show information on all configurations
  debug:
    msg: "{{ configs }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
configurations list / elements=string	A list of matching configurations. Returned: success
description string	Description of the configuration. Returned: success Sample: `"Enable SSL for console proxy"`
name string	Name of the configuration. Returned: success Sample: `"consoleproxy.sslEnabled"`
value string	Value of the configuration. Returned: success Sample: `"True"`

Authors

Francisco Arencibia (@arencibiafrancisco)

Collection links

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