aci_l3out_extepg – Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP) — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

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

New in version 2.9.

- Synopsis
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## Synopsis

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

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
certificate_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. aliases: cert_name
description string |  | Description for the ExtEpg. aliases: descr
dscp string | Choices: AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS0 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF VA unspecified | The target Differentiated Service (DSCP) value. The APIC defaults to `unspecified` when unset during creation. aliases: target
extepg string / required |  | Name of ExtEpg being created. aliases: extepg_name, name
host string / required |  | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname
l3out string / required |  | Name of an existing L3Out. aliases: l3out_name
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 REST connection. The default value depends on parameter `use_ssl`.
preferred_group boolean | Choices: no yes | 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 `no` when unset during creation.
private_key string / required |  | 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. aliases: cert_key
state string | Choices: absent present ← query | Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
tenant string / required |  | Name of an existing tenant. aliases: tenant_name
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.
username string | Default: "admin" | The username to use for authentication. aliases: user
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.

## Notes

Note

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

## See Also

See also

aci_tenant – Manage tenants (fv:Tenant)
  The official documentation on the aci_tenant module.
aci_domain – Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)
  The official documentation on the aci_domain module.
aci_vrf – Manage contexts or VRFs (fv:Ctx)
  The official documentation on the aci_vrf module.
APIC Management Information Model reference
  More information about the internal APIC class l3ext:Out.
Cisco ACI Guide
  Detailed information on how to manage your ACI infrastructure using Ansible.
Developing Cisco ACI modules
  Detailed guide on how to write your own Cisco ACI modules to contribute.

## Examples

    - name: Add a new ExtEpg
      aci_l3out_extepg:
        host: apic
        username: admin
        password: SomeSecretPassword
        tenant: production
        l3out: prod_l3out
        name: prod_extepg
        description: ExtEpg for Production L3Out
        state: present
      delegate_to: localhost

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

    - name: Query ExtEpg information
      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 | Returned | Description
--- | --- | ---
current list | success | The existing configuration from the APIC after the module has finished Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error dictionary | failure | The error information as returned from the APIC Sample: {'code': '122', 'text': 'unknown managed object class foo'}
filter_string string | failure or debug | The filter string used for the request Sample: ?rsp-prop-include=config-only
method string | failure or debug | The HTTP method used for the request to the APIC Sample: POST
previous list | info | The original configuration from the APIC before the module has started Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed dictionary | info | The assembled configuration from the user-provided parameters Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
raw string | parse error | The raw output returned by the APIC REST API (xml or json) Sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response string | failure or debug | The HTTP response from the APIC Sample: OK (30 bytes)
sent list | info | The actual/minimal configuration pushed to the APIC Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status integer | failure or debug | The HTTP status from the APIC Sample: 200
url string | failure or debug | The HTTP url used for the request to the APIC Sample: https://10.11.12.13/api/mo/uni/tn-production.json

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Rostyslav Davydenko (@rost-d)

Hint

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