cisco.mso.mso_tenant module – Manage tenants

Note

This module is part of the cisco.mso collection (version 2.11.0).

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 cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.mso_tenant.

Synopsis

• Manage tenants on Cisco ACI Multi-Site.

Requirements

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

• Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
description string	The description for this tenant.
display_name string	The name of the tenant to be displayed in the web UI.
host aliases: hostname string	IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.
login_domain string	The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.
orchestrator_only string	Orchestrator Only no is used to delete the tenant from the MSO and Sites/APIC. yes is used to remove the tenant only from the MSO. Choices: "yes" ← (default) "no"
output_level string	Influence the output of this MSO module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.
remote_users list / elements=dictionary	A list of associated remote users for this tenant.
login_domain string / required	Domain name of the associated remote user for this tenant.
name string / required	The name of the associated remote user for this tenant.
sites list / elements=string	A list of associated sites for this tenant. Using this property will replace any existing associated sites.
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: "absent" "present" ← (default) "query"
tenant aliases: name string	The name of the tenant.
timeout integer	The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.
use_proxy boolean	If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead. The default is true. Choices: false true
use_ssl boolean	If false, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified. The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso). Choices: false true
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
users list / elements=string	A list of associated users for this tenant. Using this property will replace any existing associated users. Admin user is always added to the associated user list irrespective of this parameter being used.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead. The default is true. Choices: false true

Notes

Note

• This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

Examples

- name: Add a new tenant
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    display_name: North European Datacenter
    description: This tenant manages the NEDC environment.
    state: present

- name: Remove a tenant from MSO and Site/APIC
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'no'
    state: absent

- name: Remove a tenant from MSO only
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'yes'
    state: absent

- name: Query a tenant
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    state: query
  register: query_result

- name: Query all tenants
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

Authors

• Dag Wieers (@dagwieers)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)