cisco.mso.mso_tenant – Manage tenants
Note
This plugin is part of the cisco.mso collection (version 1.2.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
.
To use it in a playbook, specify: cisco.mso.mso_tenant
.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The description for this tenant. |
|
The name of the tenant to be displayed in the web UI. |
|
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 |
|
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 |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
A list of associated sites for this tenant. Using this property will replace any existing associated sites. |
|
Use Use Choices:
|
|
The name of the tenant. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: 30 |
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables Default: “admin” |
|
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. |
|
If This should only set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Please read the mso_guide for more detailed information on how to manage your MSO infrastructure using Ansible.
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
delegate_to: localhost
- name: Remove a tenant
cisco.mso.mso_tenant:
host: mso_host
username: admin
password: SomeSecretPassword
tenant: north_europe
state: absent
delegate_to: localhost
- name: Query a tenant
cisco.mso.mso_tenant:
host: mso_host
username: admin
password: SomeSecretPassword
tenant: north_europe
state: query
delegate_to: localhost
register: query_result
- name: Query all tenants
cisco.mso.mso_tenant:
host: mso_host
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
Authors
Dag Wieers (@dagwieers)