tenant_module.rst

orphan:

morpheus.core.tenant module -- Manage Tenants

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.

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

New in morpheus.core 0.7.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Create, Update and Remove 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`	Additional Tenant Identifier.
.. rst-class:: ansible-option-title account_number .. ansible-option-type-line:: :ansible-option-type:`string`	Additional Tenant Identifier.
.. rst-class:: ansible-option-title currency .. ansible-option-type-line:: :ansible-option-type:`string`	ISO Currency Code. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"AUD"` :ansible-option-choices-entry:`"BGN"` :ansible-option-choices-entry:`"BRL"` :ansible-option-choices-entry:`"CAD"` :ansible-option-choices-entry:`"CHF"` :ansible-option-choices-entry:`"CLF"` :ansible-option-choices-entry:`"CLP"` :ansible-option-choices-entry:`"CNY"` :ansible-option-choices-entry:`"CZK"` :ansible-option-choices-entry:`"DKK"` :ansible-option-choices-entry:`"EUR"` :ansible-option-choices-entry:`"GBP"` :ansible-option-choices-entry:`"HKD"` :ansible-option-choices-entry:`"HRK"` :ansible-option-choices-entry:`"HUF"` :ansible-option-choices-entry:`"IDR"` :ansible-option-choices-entry:`"ILS"` :ansible-option-choices-entry:`"INR"` :ansible-option-choices-entry:`"JPY"` :ansible-option-choices-entry:`"KRW"` :ansible-option-choices-entry:`"MXN"` :ansible-option-choices-entry:`"MYR"` :ansible-option-choices-entry:`"NOK"` :ansible-option-choices-entry:`"NZD"` :ansible-option-choices-entry:`"PHP"` :ansible-option-choices-entry:`"PLN"` :ansible-option-choices-entry:`"RON"` :ansible-option-choices-entry:`"RUB"` :ansible-option-choices-entry:`"SEK"` :ansible-option-choices-entry:`"SGD"` :ansible-option-choices-entry:`"THB"` :ansible-option-choices-entry:`"TRY"` :ansible-option-choices-entry:`"USD"` :ansible-option-choices-entry:`"ZAR"`
.. rst-class:: ansible-option-title customer_number .. ansible-option-type-line:: :ansible-option-type:`string`	Additional Tenant Identifier.
.. rst-class:: ansible-option-title description .. ansible-option-type-line:: :ansible-option-type:`string`	Description for the Tenant.
.. rst-class:: ansible-option-title id .. ansible-option-type-line:: :ansible-option-type:`integer`	The Id of an existing Tenant.
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	The name of the Tenant.
.. rst-class:: ansible-option-title role .. ansible-option-type-line:: :ansible-option-type:`integer`	Id of a Role to act as the Tenant base role.
.. rst-class:: ansible-option-title state .. ansible-option-type-line:: :ansible-option-type:`string`	The state of the Tenant. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
.. rst-class:: ansible-option-title subdomain .. ansible-option-type-line:: :ansible-option-type:`string`	Subdomain name used in login URL and subtenant users.

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-full:`full`	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-full:`full`	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: Create / Update Tenant
  morpheus.core.tenant:
    name: Test Tenant
    description: Testing Tenant
    role: 4
    subdomain: test
    currency: GBP

- name: Remove Tenant
  morpheus.core.tenant:
    state: absent
    name: Test Tenant

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 tenant .. ansible-option-type-line:: :ansible-option-type:`dictionary`

Details of the Tenant state. .. 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:`{"tenant": {"account\_name": null, "account\_number": null, "active": true, "currency": "GBP", "customer\_number": null, "date\_created": "2024-01-01T00:00:01Z", "description": "Testing Tenant", "external\_id": null, "id": 30, "last\_updated": "2024-01-01T00:00:01Z", "master": false, "name": "Test Tenant", "role": {"authority": "Customer Base Role", "description": null, "id": 4, "name": "Customer Base Role"}, "stats": {"instance\_count": 0, "user\_count": 0}, "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