cisco.mso.mso_site – Manage sites
cisco.mso.mso_site – Manage sites
Note
This plugin is part of the cisco.mso collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_site
.
Synopsis
- Manage sites 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 | Choices/Defaults | Comments | |
---|---|---|---|
apic_login_domain string |
The AAA login domain for the username for the APICs. | ||
apic_password string |
The password for the APICs. | ||
apic_site_id string |
The site ID of the APICs. | ||
apic_username string |
Default: "admin" |
The username for the APICs. | |
host string / required |
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
| ||
labels list / elements=string |
The labels for this site. Labels that do not already exist will be automatically created. | ||
location dictionary |
Location of the site. | ||
latitude float |
The latitude of the location of the site. | ||
longitude float |
The longitude of the location of the site. | ||
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 | ||
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable | |
password string / required |
The password to use for authentication. If the value is not specified in the task, the value of environment variables | ||
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 | ||
site string |
The name of the site.
| ||
state string |
|
Use Use | |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable | |
urls list / elements=string |
A list of URLs to reference the APICs. | ||
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable | |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable | |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables | |
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
Notes
Note
- Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
- This module was written to support ACI 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_site_module.html