cisco.mso.mso_schema_template_bd_subnet module – Manage BD subnets in schema templates

Note

This module is part of the cisco.mso collection (version 1.4.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_schema_template_bd_subnet.

Synopsis

  • Manage BD subnets 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

Comments

bd

string / required

The name of the BD to manage.

description

string

The description of this subnet.

host

aliases: hostname

string

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.

is_virtual_ip

boolean

Treat as Virtual IP Address

Choices:

  • no ← (default)

  • yes

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.

no_default_gateway

boolean

Whether this subnet has a default gateway.

Choices:

  • no ← (default)

  • yes

output_level

string

Influence the output of this MSO 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.

Choices:

  • debug

  • info

  • normal ← (default)

password

string

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.

primary

boolean

Treat as Primary Subnet.

There can be only one primary subnet per address family under a BD.

This option can only be used on versions of MSO that are 3.1.1h or greater.

Choices:

  • no ← (default)

  • yes

querier

boolean

Whether this subnet is an IGMP querier.

Choices:

  • no ← (default)

  • yes

schema

string / required

The name of the schema.

scope

string

The scope of the subnet.

Choices:

  • private

  • public

shared

boolean

Whether this subnet is shared between VRFs.

Choices:

  • no ← (default)

  • yes

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • absent

  • present ← (default)

  • query

subnet

aliases: ip

string

The IP range in CIDR notation.

template

string / required

The name of the template to change.

timeout

integer

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.

Default: 30

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.

The default is yes.

Choices:

  • no

  • yes

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.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is no when using a HTTPAPI connection plugin (mso or nd) and yes when using the legacy connection method (only for mso).

Choices:

  • no

  • yes

username

string

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.

The default is yes.

Choices:

  • no

  • yes

Notes

Note

  • Due to restrictions of the MSO REST API concurrent modifications to BD subnets can be dangerous and corrupt data.

  • 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 subnet to a BD
  cisco.mso.mso_schema_template_bd_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    subnet: 10.0.0.0/24
    state: present
  delegate_to: localhost

- name: Remove a subset from a BD
  cisco.mso.mso_schema_template_bd_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    subnet: 10.0.0.0/24
    state: absent
  delegate_to: localhost

- name: Query a specific BD subnet
  cisco.mso.mso_schema_template_bd_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    subnet: 10.0.0.0/24
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all BD subnets
  cisco.mso.mso_schema_template_bd_subnet:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    bd: BD 1
    state: query
  delegate_to: localhost
  register: query_result

Authors

  • Dag Wieers (@dagwieers)