cisco.mso.mso_schema_template_l3out – Manage l3outs in schema templates
Note
This plugin is part of the cisco.mso collection (version 1.2.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_l3out
.
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 as displayed on the MSO web interface. |
|
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 |
|
The name of the l3out to manage. |
|
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 |
|
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 |
|
The name of the schema. |
|
Use Use Choices:
|
|
The name of the template. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: 30 |
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
If If the value is not specified in the task, the value of environment variable Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables Default: “admin” |
|
If This should only set to If the value is not specified in the task, the value of environment variable Choices:
|
|
The VRF associated to this L3out. |
|
The name of the VRF to associate with. |
|
The schema that defines the referenced VRF. If this parameter is unspecified, it defaults to the current schema. |
|
The template that defines the referenced VRF. If this parameter is unspecified, it defaults to the current schema. |
Notes
Note
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 L3out
cisco.mso.mso_schema_template_l3out:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
schema: Schema 1
template: Template 1
l3out: L3out 1
vrf:
name: vrfName
schema: vrfSchema
template: vrfTemplate
state: present
delegate_to: localhost
- name: Remove an L3out
cisco.mso.mso_schema_template_l3out:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
l3out: L3out 1
state: absent
delegate_to: localhost
- name: Query a specific L3outs
cisco.mso.mso_schema_template_l3out:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
schema: Schema 1
template: Template 1
l3out: L3out 1
state: query
delegate_to: localhost
register: query_result
- name: Query all L3outs
cisco.mso.mso_schema_template_l3out:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
schema: Schema 1
template: Template 1
state: query
delegate_to: localhost
register: query_result
Authors
Dag Wieers (@dagwieers)