cs_zone_facts – Gathering facts of zones from Apache CloudStack based clouds¶
DEPRECATED¶
- Removed in Ansible
version: 2.13
- Why
Transformed into an info module.
- Alternative
Use cs_zone_info instead.
Synopsis¶
Gathering facts from the API of a zone.
Sets Ansible facts accessible by the key
cloudstack_zoneand since version 2.6 also returns results.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.6.10
Parameters¶
Notes¶
Note
Ansible uses the
cslibrary’s configuration method if credentials are not provided by the argumentsapi_url,api_key,api_secret. Configuration is read from several locations, in the following order. TheCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETandCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTenvironment variables. ACLOUDSTACK_CONFIGenvironment variable pointing to an.inifile. Acloudstack.inifile in the current working directory. A.cloudstack.inifile in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini. Use the argumentapi_regionto select the section name, default section iscloudstack. See https://github.com/exoscale/cs for more information.A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples¶
- name: Gather facts from a zone
cs_zone_facts:
name: ch-gva-1
register: zone
delegate_to: localhost
- name: Show the returned results of the registered variable
debug:
var: zone
- name: Show the facts by the ansible_facts key cloudstack_zone
debug:
var: cloudstack_zone
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module will be removed in version 2.13. [deprecated]
For more information see DEPRECATED.
Authors¶
René Moser (@resmo)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.