cisco.mso.mso_schema_site_external_epg module – Manage External EPG in schema of sites.
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_site_external_epg
.
Synopsis
Manage External EPG in schema of sites on Cisco ACI Multi-Site.
This module can only be used on versions of MSO that are 3.3 or greater.
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 External EPG to be managed. |
|
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 L3Out associated with the external epg. Required when site is of type on-premise. In NDO versions over 4.2, the parameter is accessible only when an external EPG is linked to the current schema-template’s VRF. |
|
If this parameter is specified, the constructed l3out reference will refer to a distinguished name (DN) in APIC. Choices:
|
|
The schema that defines the referenced L3Out. If this parameter is unspecified, it defaults to the current schema. |
|
The template that defines the referenced L3Out. If this parameter is unspecified, it defaults to the current template. |
|
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 |
|
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 |
|
Configures if an external EPG route is pointing to the internet or to an external remote network. Only available when associated with an azure site. Choices:
|
|
The name of the schema. |
|
The name of the site. |
|
Use Use Choices:
|
|
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
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
See Also
See also
- cisco.mso.mso_schema_template_external_epg
Manage external EPGs in schema templates.
Examples
- name: Add a Site External EPG
cisco.mso.mso_schema_site_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: External EPG 1
l3out: L3out1
state: present
- name: Remove a Site External EPG
cisco.mso.mso_schema_site_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: External EPG 1
l3out: L3out1
state: absent
- name: Query a Site External EPG
cisco.mso.mso_schema_site_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
external_epg: External EPG 1
l3out: L3out1
state: query
register: query_result
- name: Query all Site External EPGs
cisco.mso.mso_schema_site_external_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
state: query
register: query_result