On this page
cisco.mso.mso_schema_template_bd – Manage Bridge Domains (BDs) in schema templates
Note
This plugin is part of the cisco.mso collection (version 1.0.1).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_schema_template_bd
.
Synopsis
- Manage BDs in schema templates 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 | ||
---|---|---|---|---|
bd
string
|
The name of the BD to manage.
aliases: name |
|||
dhcp_policy
dictionary
|
The DHCP Policy
|
|||
dhcp_option_policy
dictionary
|
The DHCP Option Policy
|
|||
name
string
|
The name of the DHCP Option Policy
|
|||
version
integer
|
The version of the DHCP Option Policy
|
|||
name
string / required
|
The name of the DHCP Relay Policy
|
|||
version
integer / required
|
The version of DHCP Relay Policy
|
|||
display_name
string
|
The name as displayed on the MSO web interface.
|
|||
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
MSO_HOST will be used instead.
aliases: hostname |
|||
intersite_bum_traffic
boolean
|
|
Whether to allow intersite BUM traffic.
|
||
layer2_stretch
boolean
|
|
Whether to enable L2 stretch.
|
||
layer2_unknown_unicast
string
|
|
Layer2 unknown unicast.
|
||
layer3_multicast
boolean
|
|
Whether to enable L3 multicast.
|
||
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.
|
|||
optimize_wan_bandwidth
boolean
|
|
Whether to optimize WAN bandwidth.
|
||
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
If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.
|
||
password
string / required
|
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.
|
|||
schema
string / required
|
The name of the schema.
|
|||
state
string
|
|
Use
present or absent for adding or removing.
Use query for listing an object or multiple objects.
|
||
subnets
list / elements=dictionary
|
The subnets associated to this BD.
|
|||
description
string
|
The description of this subnet.
|
|||
no_default_gateway
boolean
|
|
Whether this subnet has a default gateway.
|
||
querier
boolean
|
|
Whether this subnet is an IGMP querier.
|
||
scope
string
|
|
The scope of the subnet.
|
||
shared
boolean
|
|
Whether this subnet is shared between VRFs.
|
||
subnet
string / required
|
The IP range in CIDR notation.
aliases: ip |
|||
template
string / required
|
The name of the template.
|
|||
timeout
integer
|
Default:
30
|
The socket level timeout in 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
no , 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.
|
||
use_ssl
boolean
|
|
If
no , 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.
|
||
username
string
|
Default:
"admin"
|
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.
|
||
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.
If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.
|
||
vrf
dictionary
|
The VRF associated to this BD. This is required only when creating a new BD.
|
|||
name
string / required
|
The name of the VRF to associate with.
|
|||
schema
string
|
The schema that defines the referenced VRF.
If this parameter is unspecified, it defaults to the current schema.
|
|||
template
string
|
The template that defines the referenced VRF.
If this parameter is unspecified, it defaults to the current template.
|
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 BD
cisco.mso.mso_schema_template_bd:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
bd: BD 1
vrf:
name: VRF1
state: present
delegate_to: localhost
- name: Add a new BD from another Schema
mso_schema_template_bd:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
bd: BD 1
vrf:
name: VRF1
schema: Schema Origin
template: Template Origin
state: present
delegate_to: localhost
- name: Remove an BD
cisco.mso.mso_schema_template_bd:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
bd: BD1
state: absent
delegate_to: localhost
- name: Query a specific BDs
cisco.mso.mso_schema_template_bd:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
bd: BD1
state: query
delegate_to: localhost
register: query_result
- name: Query all BDs
cisco.mso.mso_schema_template_bd:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
state: query
delegate_to: localhost
register: query_result
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/mso/mso_schema_template_bd_module.html