mso_schema_template_bd – Manage Bridge Domains (BDs) in schema templates

From Get docs
Ansible/docs/2.8/modules/mso schema template bd module


mso_schema_template_bd – Manage Bridge Domains (BDs) in schema templates

New in version 2.8.


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

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.


aliases: hostname

intersite_bum_traffic

boolean

  • no
  • yes

Whether to allow intersite BUM traffic.

layer2_stretch

boolean

  • no
  • yes

Whether to enable L2 stretch.

layer2_unknown_unicast

string

  • flood
  • proxy

Layer2 unknown unicast.

layer3_multicast

boolean

  • no
  • yes

Whether to enable L3 multicast.

optimize_wan_bandwidth

boolean

  • no
  • yes

Whether to optimize WAN bandwidth.

output_level

string

  • debug
  • info
  • normal

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`.

schema

string / required

The name of the schema.

state

string

  • absent
  • present

  • query

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

subnets

list

The subnets associated to this BD.

description

string

The description of this subnet.

ip

string / required

The IP range in CIDR notation.

no_default_gateway

boolean

  • no
  • yes

Whether this subnet has a default gateway.

scope

string

  • private
  • public

The scope of the subnet.

shared

boolean

  • no
  • yes

Whether this subnet is shared between VRFs.

template

string / required

The name of the template.

timeout

integer

Default:

30

The socket level timeout in seconds.

use_proxy

boolean

  • no
  • yes

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

use_ssl

boolean

  • no
  • yes

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

  • no
  • yes

If no, SSL certificates will not be validated.

This should only set to no when used on personally controlled sites using self-signed certificates.

vrf

dictionary

The VRF associated to this BD.



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
  mso_schema_template_bd:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    state: present
  delegate_to: localhost

- name: Remove an BD
  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
  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
  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

Status

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.8/modules/mso_schema_template_bd_module.html