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.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_external_epg.

Synopsis
Requirements
Parameters
Notes
Examples

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. aliases: name, externalepg
host 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. aliases: hostname
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 `MSO_LOGIN_DOMAIN` will be used instead.
output_level string		Choices: debug info normal ←	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.
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.
preferred_group boolean		Choices: no yes	Preferred Group is enabled for this External EPG or not.
schema string / required			The name of the schema.
state string		Choices: absent present ← query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
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 `MSO_TIMEOUT` will be used instead.
type string		Choices: on-premise ← cloud	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		Choices: no yes ←	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.
use_ssl boolean		Choices: no yes ←	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.
username string		Default: "admin"	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		Choices: no yes ←	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.
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 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 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/latest/collections/cisco/mso/mso_schema_template_external_epg_module.html