Docs4dev
Docs
ansible / latest / collections / ngine_io / cloudstack / cs_facts_module.html

ngine_io.cloudstack.cs_facts – Gather facts on instances of Apache CloudStack based clouds.

Note

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

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.

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

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • This module fetches data from the metadata API in CloudStack. The module must be called from within the instance itself.

Requirements

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

  • yaml

Parameters

Parameter Choices/Defaults Comments
filter
string
    Choices:
  • cloudstack_service_offering
  • cloudstack_availability_zone
  • cloudstack_public_hostname
  • cloudstack_public_ipv4
  • cloudstack_local_hostname
  • cloudstack_local_ipv4
  • cloudstack_instance_id
  • cloudstack_user_data
Filter for a specific fact.
meta_data_host
string
Host or IP of the meta data API service.
If not set, determination by parsing the dhcp lease file.

Examples

# Gather all facts on instances
- name: Gather cloudstack facts
  ngine_io.cloudstack.cs_facts:

# Gather specific fact on instances
- name: Gather cloudstack facts
  ngine_io.cloudstack.cs_facts: filter=cloudstack_instance_id

# Gather specific fact on instances with a given meta_data_host
- name: Gather cloudstack facts
  ngine_io.cloudstack.cs_facts:
    filter: cloudstack_instance_id
    meta_data_host: 169.254.169.254

Return Values

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

Key Returned Description
cloudstack_availability_zone
string
success
zone the instance is deployed in.

Sample:
ch-gva-2
cloudstack_instance_id
string
success
UUID of the instance.

Sample:
ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_local_hostname
string
success
local hostname of the instance.

Sample:
VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_local_ipv4
string
success
local IPv4 of the instance.

Sample:
185.19.28.35
cloudstack_public_hostname
string
success
public IPv4 of the router. Same as cloudstack_public_ipv4.

Sample:
VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_public_ipv4
string
success
public IPv4 of the router.

Sample:
185.19.28.35
cloudstack_service_offering
string
success
service offering of the instance.

Sample:
Micro 512mb 1cpu
cloudstack_user_data
dictionary
success
data of the instance provided by users.

Sample:
{'bla': 'foo'}


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/latest/collections/ngine_io/cloudstack/cs_facts_module.html