mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates

New in version 2.8.

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.

aliases: hostname
intersite_multicaste_source
boolean
    Choices:
  • no
  • yes
Whether intersite multicast source is enabled.
When not specified, this parameter defaults to no.
intra_epg_isolation
string
    Choices:
  • enforced
  • unenforced
Whether intra EPG isolation is enforced.
When not specified, this parameter defaults to unenforced.
output_level
string
    Choices:
  • 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
password
string / required
The password to use for authentication.
This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
port
integer
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
preferred_group
boolean
added in 2.9
    Choices:
  • no
  • yes
Whether this EPG is added to preferred group or not.
When not specified, this parameter defaults to no.
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.
subnets
list
The subnets associated to this ANP.
description
string
The description of this subnet.
ip
string / required
The IP range in CIDR notation.
no_default_gateway
boolean
    Choices:
  • no
  • yes
Whether this subnet has a default gateway.
scope
string
    Choices:
  • private
  • public
The scope of the subnet.
shared
boolean
    Choices:
  • no
  • yes
Whether this subnet is shared between VRFs.
template
string / required
The name of the template.
timeout
integer
Default:
30
The socket level timeout in seconds.
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.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
useg_epg
boolean
    Choices:
  • no
  • yes
Whether this is a USEG EPG.
username
string
Default:
"admin"
The username to use for authentication.
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.
vrf
dictionary
added in 2.9
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

mso_schema_template_anp – Manage Application Network Profiles (ANPs) in schema templates
The official documentation on the mso_schema_template_anp module.
mso_schema_template_anp_epg_subnet – Manage EPG subnets in schema templates
The official documentation on the mso_schema_template_anp_epg_subnet module.
mso_schema_template_bd – Manage Bridge Domains (BDs) in schema templates
The official documentation on the mso_schema_template_bd module.
mso_schema_template_contract_filter – Manage contract filters in schema templates
The official documentation on the mso_schema_template_contract_filter module.

Examples

- name: Add a new EPG
  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.
  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
  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
  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
  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

Status

Authors

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.