cisco.mso.mso_site – Manage sites
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_site
.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The AAA login domain for the username for the APICs. The apic_login_domain attribute is not supported when using with ND platform. See the ND collection for complete site management. |
|
The password for the APICs. The apic_password attribute is not supported when using with ND platform. See the ND collection for complete site management. |
|
The site ID of the APICs. |
|
The username for the APICs. The apic_username attribute is not supported when using with ND platform. See the ND collection for complete site management. Default: “admin” |
|
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 labels for this site. Labels that do not already exist will be automatically created. The labels attribute is not supported when using with ND platform. See the ND collection for complete site management. |
|
Location of the site. The location attribute is not supported when using with ND platform. See the ND collection for complete site management. |
|
The latitude of the location of the site. |
|
The longitude of the location of the site. |
|
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 |
|
The name of the site. |
|
Use Use Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: 30 |
|
A list of URLs to reference the APICs. The urls attribute is not supported when using with ND platform. See the ND collection for complete site management. |
|
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” |
|
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 site
cisco.mso.mso_site:
host: mso_host
username: admin
password: SomeSecretPassword
site: north_europe
description: North European Datacenter
apic_username: mso_admin
apic_password: AnotherSecretPassword
apic_site_id: 12
urls:
- 10.2.3.4
- 10.2.4.5
- 10.3.5.6
labels:
- NEDC
- Europe
- Diegem
location:
latitude: 50.887318
longitude: 4.447084
state: present
delegate_to: localhost
- name: Remove a site
cisco.mso.mso_site:
host: mso_host
username: admin
password: SomeSecretPassword
site: north_europe
state: absent
delegate_to: localhost
- name: Query a site
cisco.mso.mso_site:
host: mso_host
username: admin
password: SomeSecretPassword
site: north_europe
state: query
delegate_to: localhost
register: query_result
- name: Query all sites
cisco.mso.mso_site:
host: mso_host
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
Authors
Dag Wieers (@dagwieers)