mso_site – Manage sites
New in version 2.8.
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_password
string /
required
|
The password for the APICs.
|
||
apic_site_id
string /
required
|
The site ID of the APICs.
|
||
apic_username
string /
required
|
Default:
"admin"
|
The username for the APICs.
|
|
host
string /
required
|
IP Address or hostname of the ACI Multi Site Orchestrator host.
aliases: hostname |
||
labels
list
|
The labels for this site.
Labels that do not already exist will be automatically created.
|
||
location
-
|
Location of the site.
|
||
latitude
float
|
The latitude of the location of the site.
|
||
longitude
float
|
The longitude of the location of the site.
|
||
output_level
string
|
|
Influence the output of this ACI 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
|
|
password
string /
required
|
The password to use for authentication.
This option is mutual exclusive with
private_key . If
private_key is provided too, it will be used instead.
|
||
port
integer
|
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
|
||
site
string /
required
|
The name of the site.
aliases: name |
||
state
string
|
|
Use
present or
absent for adding or removing.
Use
query for listing an object or multiple objects.
|
|
timeout
integer
|
Default:
30
|
The socket level timeout in seconds.
|
|
urls
list
|
A list of URLs to reference the APICs.
|
||
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
|
use_ssl
boolean
|
|
If
no , an HTTP connection will be used instead of the default HTTPS connection.
|
|
username
string
|
Default:
"admin"
|
The username to use for authentication.
|
|
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated.
This should only set to
no when used on personally controlled sites using self-signed certificates.
|
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 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 mso_site: host: mso_host username: admin password: SomeSecretPassword site: north_europe state: absent delegate_to: localhost - name: Query a site mso_site: host: mso_host username: admin password: SomeSecretPassword site: north_europe state: query delegate_to: localhost register: query_result - name: Query all sites mso_site: host: mso_host username: admin password: SomeSecretPassword state: query delegate_to: localhost register: query_result
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/mso_site_module.html