tenant_info_module.rst

orphan:

morpheus.core.tenant_info module -- Retrieves Tenant 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.tenant_info.

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

New in morpheus.core 0.7.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Returns information about Morpheus Tenants.

Parameters

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

Parameter	Comments
.. rst-class:: ansible-option-title account_name .. ansible-option-type-line:: :ansible-option-type:`string`	Filter tenants by account name.
.. rst-class:: ansible-option-title account_number .. ansible-option-type-line:: :ansible-option-type:`string`	Filter tenants by account number.
.. rst-class:: ansible-option-title customer_number .. ansible-option-type-line:: :ansible-option-type:`string`	Filter tenants by customer number.
.. 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`

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: Get Info for a Specific Tenant by id
  morpheus.core.tenant_info:
    id: 50

- name: Get Tenants Matching Regex Name
  morpheus.core.tenant_info:
    name: ^tenant.*$
    regex_name: true

- name: Get Tenant with Matching Customer Number
  morpheus.core.tenant_info:
    customer_number: T3ST

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 tenants .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

List of matching tenants. .. 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:`{"tenants": [{"account\_name": null, "account\_number": null, "active": true, "currency": "GBP", "customer\_number": "T3ST", "date\_created": "2022-01-01T0:00:01Z", "description": null, "external\_id": null, "id": 10, "last\_updated": "2022-01-01T0:00:01Z", "master": true, "name": "TestTenant", "role": {"authority": "Tenant Base Role", "description": null, "id": 5, "name": "Tenant Base Role"}, "stats": {"instance\_count": 5, "user\_count": 10}, "subdomain": "test"}]}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

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