You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.aci.aci_l3out_extepg module – Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Note

This module is part of the cisco.aci collection (version 2.8.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.aci.

To use it in a playbook, specify: cisco.aci.aci_l3out_extepg.

Synopsis 

Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Parameters 

Parameter	Comments
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable `ACI_ANNOTATION` will be used instead. If the value is not specified in the task and environment variable `ACI_ANNOTATION` then the default value will be used. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a `private_key` filename was provided, this defaults to the `private_key` basename, without extension. If PEM-formatted content was provided for `private_key`, this defaults to the `username` value. If the value is not specified in the task, the value of environment variable `ACI_CERTIFICATE_NAME` will be used instead.
contract_exception_tag string	The tag for contract exception.
description aliases: descr string	Description for the ExtEpg.
dscp aliases: target string	The target Differentiated Service (DSCP) value. The APIC defaults to `unspecified` when unset during creation. Choices: `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
extepg aliases: extepg_name, name string	Name of ExtEpg being created.
host aliases: hostname string	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 `ACI_HOST` will be used instead.
intra_ext_epg_isolation string	The preferred policy control. Choices: `"enforced"` `"unenforced"`
l3out aliases: l3out_name string	Name of an existing L3Out.
name_alias string	The alias for the current object. This relates to the nameAlias field in ACI.
output_level string	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 `ACI_OUTPUT_LEVEL` will be used instead. Choices: `"debug"` `"info"` `"normal"` ← (default)
output_path string	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 `ACI_OUTPUT_PATH` will be used instead.
password string	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. If the value is not specified in the task, the value of environment variables `ACI_PASSWORD` or `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	Port number to be used for REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable `ACI_PORT` will be used instead.
preferred_group boolean	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. The APIC defaults to `false` when unset during creation. Choices: `false` `true`
private_key aliases: cert_key string	Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default `certificate_name` that is used. This option is mutual exclusive with `password`. If `password` is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable `ACI_PRIVATE_KEY` or `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
qos_class string	The priority class identifier. Choices: `"level1"` `"level2"` `"level3"` ← (default) `"level4"` `"level5"` `"level6"` `"unspecified"`
route_control_profiles dictionary	The route control profiles.
export_profile aliases: export string	The route control profile whose direction is export. To remove a route export policy pass an empty string (see Examples).
import_profile aliases: import string	The route control profile whose direction is import. To remove a route import policy pass an empty string (see Examples).
state string	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects. Choices: `"absent"` `"present"` ← (default) `"query"`
tenant aliases: tenant_name string	Name of an existing tenant.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable `ACI_TIMEOUT` will be used instead. The default value is 30.
use_proxy boolean	If `false`, 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 `ACI_USE_PROXY` will be used instead. The default value is true. Choices: `false` `true`
use_ssl boolean	If `false`, 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 `ACI_USE_SSL` will be used instead. The default value is true when the connection is local. Choices: `false` `true`
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables `ACI_USERNAME` or `ANSIBLE_NET_USERNAME` will be used instead. The default value is admin.
validate_certs boolean	If `false`, SSL certificates will not be validated. This should only set to `false` when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable `ACI_VALIDATE_CERTS` will be used instead. The default value is true. Choices: `false` `true`

Notes 

Note

The tenant and domain and vrf used must exist before using this module in your playbook. The cisco.aci.aci_tenant and cisco.aci.aci_domain and cisco.aci.aci_vrf modules can be used for this.

Examples 

- name: Add a new ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    description: ExtEpg for Production L3Out
    contract_exception_tag: test
    qos_class: level6
    route_control_profiles:
      import_profile: test1
      export_profile: test2
    state: present
  delegate_to: localhost

- name: Delete ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: absent
  delegate_to: localhost

- name: Delete the export route control profile in an ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    route_control_profiles:
      import_profile: test1
      export_profile: ""
    state: present
  delegate_to: localhost

- name: Query ExtEpg information
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: query
  delegate_to: localhost
  register: query_result

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	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": ""}}}]`
error dictionary	The error information as returned from the APIC Returned: failure Sample: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	The filter string used for the request Returned: failure or debug Sample: `"?rsp-prop-include=config-only"`
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: `"POST"`
previous list / elements=string	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": ""}}}]`
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	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>"`
response string	The HTTP response from the APIC Returned: failure or debug Sample: `"OK (30 bytes)"`
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	The HTTP status from the APIC Returned: failure or debug Sample: `200`
url string	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"`

Authors

Rostyslav Davydenko (@rost-d)

cisco.aci.aci_l3out_extepg module – Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Synopsis 

Parameters 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links

cisco.aci.aci_l3out_extepg module – Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Synopsis

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Parameters 

Notes 

See Also 

Examples 

Return Values 