cisco.mso.mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates

cisco.mso.mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates

Note

This plugin is part of the cisco.mso collection (version 1.0.1).

To install it use: ansible-galaxy collection install cisco.mso.

To use it in a playbook, specify: cisco.mso.mso_schema_template_anp_epg.

• Synopsis
• Requirements
• Parameters
• Notes
• See Also
• Examples

Synopsis

• Manage 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 string / required			The name of the ANP.
bd dictionary			The BD associated to this ANP.
	name string / required		The name of the BD to associate with.
	schema string		The schema that defines the referenced BD. If this parameter is unspecified, it defaults to the current schema.
	template string		The template that defines the referenced BD.
display_name string			The name as displayed on the MSO web interface.
epg string			The name of the EPG to manage. aliases: name
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 MSO_HOST will be used instead. aliases: hostname
intersite_multicast_source boolean		no yes	Whether intersite multicast source is enabled. When not specified, this parameter defaults to no.
intra_epg_isolation string		enforced unenforced	Whether intra EPG isolation is enforced. When not specified, this parameter defaults to unenforced.
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		debug info normal ←	Influence the output of this ACI 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 / required			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		no yes	Whether this EPG is added to preferred group or not. When not specified, this parameter defaults to no.
proxy_arp boolean		no yes	Whether proxy arp is enabled. When not specified, this parameter defaults to no.
schema string / required			The name of the schema.
state string		absent present ← query	Use present or absent for adding or removing. Use query for listing an object or multiple objects.
subnets list / elements=dictionary			The subnets associated to this ANP.
	description string		The description of this subnet.
	no_default_gateway boolean	no yes	Whether this subnet has a default gateway.
	querier boolean	no yes	Whether this subnet is an IGMP querier.
	scope string	private ← public	The scope of the subnet.
	shared boolean	no yes	Whether this subnet is shared between VRFs.
	subnet string / required		The IP range in CIDR notation. aliases: ip
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.
use_proxy boolean		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		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.
useg_epg boolean		no yes	Whether this is a USEG EPG.
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		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 to this ANP.
	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.

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.

See Also

See also

cisco.mso.mso_schema_template_anp

The official documentation on the cisco.mso.mso_schema_template_anp module.

cisco.mso.mso_schema_template_anp_epg_subnet

The official documentation on the cisco.mso.mso_schema_template_anp_epg_subnet module.

cisco.mso.mso_schema_template_bd

The official documentation on the cisco.mso.mso_schema_template_bd module.

cisco.mso.mso_schema_template_contract_filter

The official documentation on the cisco.mso.mso_schema_template_contract_filter module.

Examples

- name: Add a new EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
     name: bd1
    vrf:
     name: vrf1
    state: present
  delegate_to: localhost

- name: Add a new EPG with preferred group.
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    state: present
    preferred_group: yes
  delegate_to: localhost

- name: Remove an EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
     name: bd1
    vrf:
     name: vrf1
    state: absent
  delegate_to: localhost

- name: Query a specific EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
     name: bd1
    vrf:
     name: vrf1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPGs
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
     name: bd1
    vrf:
     name: vrf1
    state: query
  delegate_to: localhost
  register: query_result

Authors

• Dag Wieers (@dagwieers)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/mso/mso_schema_template_anp_epg_module.html