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 2.9.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
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
---|---|
The name of the BD to manage. |
|
The description of this subnet. |
|
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 |
|
Treat as Virtual IP Address Choices:
|
|
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 When using a HTTPAPI connection plugin the inventory variable |
|
Whether this subnet has a default gateway. Choices:
|
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
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:
|
|
Whether this subnet is an IGMP querier. Choices:
|
|
The name of the schema. |
|
The scope of the subnet. Choices:
|
|
Whether this subnet is shared between VRFs. Choices:
|
|
Use Use Choices:
|
|
The IP range in CIDR notation. |
|
The name of the template to change. |
|
The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
Notes
Note
Due to restrictions of the MSO REST API concurrent modifications to BD subnets can be dangerous and corrupt data.
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
- 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
- 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
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
register: query_result