cisco.mso.mso_schema_template_external_epg – Manage external EPGs in schema templates
cisco.mso.mso_schema_template_external_epg – Manage external EPGs in schema templates
Note
This plugin is part of the cisco.mso collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_schema_template_external_epg
.
Synopsis
- Manage external EPGs 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 | |
---|---|---|---|
anp dictionary |
The anp associated with the external epg. | ||
name string / required |
The name of the anp to associate with. | ||
schema string |
The schema that defines the referenced anp. If this parameter is unspecified, it defaults to the current schema. | ||
template string |
The template that defines the referenced anp. If this parameter is unspecified, it defaults to the current template. | ||
display_name string |
The name as displayed on the MSO web interface. | ||
external_epg string |
The name of the external EPG to manage.
| ||
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
| ||
l3out dictionary |
The L3Out associated with the external epg. | ||
name string / required |
The name of the L3Out to associate with. | ||
schema string |
The schema that defines the referenced L3Out. If this parameter is unspecified, it defaults to the current schema. | ||
template string |
The template that defines the referenced L3Out. If this parameter is unspecified, it defaults to the current template. | ||
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 | ||
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable | |
password string / required |
The password to use for authentication. If the value is not specified in the task, the value of environment variables | ||
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 | ||
preferred_group boolean |
|
Preferred Group is enabled for this External EPG or not. | |
schema string / required |
The name of the schema. | ||
state string |
|
Use Use | |
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 | |
type string |
|
The type of external epg. anp needs to be associated with external epg when the type is cloud. l3out can be associated with external epg when the type is on-premise. | |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable | |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable | |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables | |
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable | |
vrf dictionary |
The VRF associated with the external epg. | ||
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 external EPG
cisco.mso.mso_schema_template_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: External EPG 1
vrf:
name: VRF
schema: Schema 1
template: Template 1
state: present
delegate_to: localhost
- name: Add a new external EPG with external epg in cloud
cisco.mso.mso_schema_template_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: External EPG 1
type: cloud
vrf:
name: VRF
schema: Schema 1
template: Template 1
anp:
name: ANP1
schema: Schema 1
template: Template 1
state: present
delegate_to: localhost
- name: Remove an external EPG
cisco.mso.mso_schema_template_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: external EPG1
state: absent
delegate_to: localhost
- name: Query a specific external EPGs
cisco.mso.mso_schema_template_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: external EPG1
state: query
delegate_to: localhost
register: query_result
- name: Query all external EPGs
cisco.mso.mso_schema_template_external_epg:
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_schema_template_external_epg_module.html