cloud_info_module.rst

orphan:

morpheus.core.cloud_info module -- Retrieves Cloud Info

Note

This module is part of the morpheus.core collection (version 0.7.1).

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 morpheus.core.

To use it in a playbook, specify: morpheus.core.cloud_info.

.. rst-class:: ansible-version-added

New in morpheus.core 0.7.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Retrieves information about Morpheus Clouds.

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title detail .. ansible-option-type-line:: :ansible-option-type:`string`	Level of detail returned. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"summary"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"full"`
.. rst-class:: ansible-option-title id .. ansible-option-type-line:: :ansible-option-type:`integer`	Return specific object by id.
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	Filter by name.
.. rst-class:: ansible-option-title regex_name .. ansible-option-type-line:: :ansible-option-type:`boolean`	Treat the name parameter as a regular expression. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title type .. ansible-option-type-line:: :ansible-option-type:`string`	Filter Clouds by Cloud Type Code.

Attributes

.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}

Attribute	Support	Description
.. rst-class:: ansible-option-title check_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A` Not Required, Module does not make changes.	Can run in check_mode and return changed status prediction without modifying target
.. rst-class:: ansible-option-title diff_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A`	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
.. rst-class:: ansible-option-title platform	:ansible-attribute-support-property:`Platform:` :ansible-attribute-support-full:`httpapi`	Target OS/families that can be operated against

Examples

- name: Return all Clouds
  morpheus.core.cloud_info:

- name: Return all VMware Clouds
  morpheus.core.cloud_info:
    type: vmware

- name: Return Cloud matching Name
  morpheus.core.cloud_info:
    name: ProdCloud

- name: Return all Clouds matching Regex Name
  morpheus.core.cloud_info:
    name: ^Dev.*$
    regex_name: true

- name: Return Clouds with Full Detailed Info
  morpheus.core.cloud_info:
    detail: full

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Key

Description

.. rst-class:: ansible-option-title clouds .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

List of Clouds with Info. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"clouds": [{"agent\_mode": "cloudInit", "code": "linuxCloud", "enabled": true, "id": 20, "location": "UKSouth", "name": "Linux Cloud South", "server\_count": 3, "stats": {"server\_counts": {"all": 3, "baremetal": 0, "container\_host": 0, "host": 3, "hypervisor": 3, "unmanaged": 0, "vm": 0}}}]}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

  - title: "Repository (Sources)"
    url: "https://www.github.com/gomorpheus/ansible-collection-morpheus-core"
    external: true