ansible / ansible.builtin / v2.5.10 / module / aci_epg Manage End Point Groups (EPG) objects (fv:AEPg) | "added in version" 2.4 of ansible.builtin" Authors: Swetha Chunduri (@schunduri) preview | supported by communityansible.builtin.aci_epg (v2.5.10) — module
pip
Install with pip install ansible==2.5.10
Manage End Point Groups (EPG) on Cisco ACI fabrics.
- name: Add a new EPG aci_epg: host: apic username: admin password: SomeSecretPassword tenant: production ap: intranet epg: web_epg description: Web Intranet EPG bd: prod_bd preferred_group: yes
- aci_epg: host: 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: host: apic username: admin password: SomeSecretPassword validate_certs: no tenant: production app_profile: intranet epg: web_epg state: absent
- name: Query an EPG aci_epg: host: apic username: admin password: SomeSecretPassword tenant: production ap: ticketing epg: web_epg state: query
- name: Query all EPGs aci_epg: host: apic username: admin password: SomeSecretPassword state: query
- name: Query all EPGs with a Specific Name aci_epg: host: apic username: admin password: SomeSecretPassword validate_certs: no epg: web_epg state: query
- name: Query all EPGs of an App Profile aci_epg: host: apic username: admin password: SomeSecretPassword validate_certs: no ap: ticketing state: query
ap: aliases: - app_profile - app_profile_name description: - Name of an existing application network profile, that will contain the EPGs. required: true bd: aliases: - bd_name - bridge_domain description: - Name of the bridge domain being associated with the EPG. required: true epg: aliases: - epg_name - name description: - Name of the end point group. required: true host: aliases: - hostname description: - IP Address or hostname of APIC resolvable by Ansible control host. - If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. required: true type: str port: description: - Port number to be used for REST connection. - The default value depends on parameter C(use_ssl). - If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. type: int state: choices: - absent - present - query default: present description: - Use C(present) or C(absent) for adding or removing. - Use C(query) for listing an object or multiple objects. tenant: aliases: - tenant_name description: - Name of an existing tenant. timeout: default: 30 description: - The socket level timeout in seconds. - If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. type: int use_ssl: default: true description: - If C(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 C(ACI_USE_SSL) will be used instead. type: bool password: description: - The password to use for authentication. - This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. - If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. type: str priority: choices: - level1 - level2 - level3 - unspecified default: unspecified description: - QoS class. username: aliases: - user default: admin description: - The username to use for authentication. - If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. type: str owner_key: description: - User-defined string for the ownerKey attribute of an ACI object. - This attribute represents a key for enabling clients to own their data for entity correlation. - If the value is not specified in the task, the value of environment variable C(ACI_OWNER_KEY) will be used instead. type: str owner_tag: description: - User-defined string for the ownerTag attribute of an ACI object. - This attribute represents a tag for enabling clients to add their own data. - For example, to indicate who created this object. - If the value is not specified in the task, the value of environment variable C(ACI_OWNER_TAG) will be used instead. type: str use_proxy: default: true description: - If C(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 C(ACI_USE_PROXY) will be used instead. type: bool annotation: description: - User-defined string for annotating an object. - If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. type: str description: aliases: - descr description: - Description for the EPG. fwd_control: choices: - none - proxy-arp default: none description: - The forwarding control used by the EPG. - The APIC defaults new EPGs to C(none). output_path: description: - Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. - If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. type: str private_key: aliases: - cert_key description: - Either a PEM-formatted private key file or the private key content used for signature-based authentication. - This value also influences the default C(certificate_name) that is used. - This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. - If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str output_level: choices: - debug - info - normal default: normal description: - Influence the output of this ACI module. - C(normal) means the standard output, incl. C(current) dict - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. type: str validate_certs: default: true description: - If C(no), SSL certificates will not be validated. - This should only set to C(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 C(ACI_VALIDATE_CERTS) will be used instead. type: bool preferred_group: default: 'no' description: - Whether ot not the EPG is part of the Preferred Group and can communicate without contracts. - This is very convenient for migration scenarios, or when ACI is used for network automation but not for policy. type: bool version_added: '2.5' version_added_collection: ansible.builtin certificate_name: aliases: - cert_name description: - The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. - If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. - If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. - If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. type: str intra_epg_isolation: choices: - enforced - unenforced default: unenforced description: - Intra EPG Isolation.
current: description: The existing configuration from the APIC after the module has finished returned: success sample: - fvTenant: attributes: descr: Production environment dn: uni/tn-production name: production nameAlias: '' ownerKey: '' ownerTag: '' type: list error: description: The error information as returned from the APIC returned: failure sample: code: '122' text: unknown managed object class foo type: dict filter_string: description: The filter string used for the request returned: failure or debug sample: ?rsp-prop-include=config-only type: string method: description: The HTTP method used for the request to the APIC returned: failure or debug sample: POST type: string previous: description: The original configuration from the APIC before the module has started returned: info sample: - fvTenant: attributes: descr: Production dn: uni/tn-production name: production nameAlias: '' ownerKey: '' ownerTag: '' type: list proposed: description: The assembled configuration from the user-provided parameters returned: info sample: fvTenant: attributes: descr: Production environment name: production type: dict raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata> type: string response: description: The HTTP response from the APIC returned: failure or debug sample: OK (30 bytes) type: string sent: description: The actual/minimal configuration pushed to the APIC returned: info sample: fvTenant: attributes: descr: Production environment type: list status: description: The HTTP status from the APIC returned: failure or debug sample: 200 type: int url: description: The HTTP url used for the request to the APIC returned: failure or debug sample: https://10.11.12.13/api/mo/uni/tn-production.json type: string