Documentation

aci_epg - Manage End Point Groups (EPG) on Cisco ACI fabrics (fv:AEPg)

New in version 2.4.

Synopsis

Options

parameter required default choices comments
ap
 yes
Name of an existing application network profile, that will contain the EPGs.

aliases: app_proifle, app_profile_name
bd
 yes
Name of the bridge domain being associated with the EPG.

aliases: bd_name, bridge_domain
description
 no
Description for the EPG.

aliases: descr
epg
 yes
Name of the end point group.

aliases: name, epg_name
fwd_control
 no none
  • none
  • proxy-arp
The forwarding control used by the EPG.
The APIC defaults new EPGs to none.
hostname
 yes
IP Address or hostname of APIC resolvable by Ansible control host.

aliases: host
intra_epg_isolation
 no unenforced
  • enforced
  • unenforced
Intra EPG Isolation.
password
 yes
The password to use for authentication.
priority
 no unspecified
  • level1
  • level2
  • level3
  • unspecified
QoS class.
state
 no present
  • absent
  • present
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
tenant
 no
Name of an existing tenant.

aliases: tenant_name
timeout
 no 30
The socket level timeout in seconds.
use_proxy
 no yes
  • yes
  • no
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
 no yes
  • yes
  • no
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
 yes admin
The username to use for authentication.

aliases: user
validate_certs
 no yes
  • yes
  • no
If no, SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

- name: Add a new EPG
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    description: Web Intranet EPG
    bd: prod_bd

  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: "{{ item.epg }}"
    description: Ticketing EPG
    bd: "{{ item.bd }}"
    priority: unspecified
    intra_epg_isolation: unenforced
    state: present
  with_items:
    - epg: web
      bd: web_bd
    - epg: database
      bd: database_bd

- name: Remove an EPG
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    tenant: production
    app_profile: intranet
    epg: web_epg
    state: absent

- name: Query an EPG
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: web_epg
    state: query

- name: Query all EPGs
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    state: query

- name: Query all EPGs with a Specific Name
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    epg: web_epg
    state: query

- name: Query all EPGs of an App Profile
  aci_epg:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    ap: ticketing
    state: query

Notes

Note

  • The tenant and app_profile used must exist before using this module in your playbook. The aci_tenant and aci_ap modules can be used for this.
  • By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
  • HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.