cisco.aci.aci_l3out module – Manage Layer 3 Outside (L3Out) objects (l3ext:Out)
Note
This module is part of the cisco.aci collection (version 2.10.1).
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
.
Synopsis
Manage Layer 3 Outside (L3Out) on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
The AS number for the L3Out. Only applicable when using ‘eigrp’ as the l3protocol. |
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable |
|
Description for the L3Out. |
|
Name of the external L3 domain being associated with the L3Out. |
|
The target Differentiated Service (DSCP) value. The APIC defaults to Choices:
|
|
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 |
|
Name of L3Out being created. |
|
Routing protocol for the L3Out. Protocols already associated with an l3out must be provided again when the l3out is modified if the associated protocols are to be kept. The Protocols are otherwise deleted if not provided each time an l3out is modified. First example, to add BGP protocol to an l3out with OSPF protocol, the user must enter Second example, to change the protocol from OSPF to EIGRP, the user must simply enter To remove all existing protocols, the user must enter SR-MPLS Infra L3out requires the l3protocol to be ‘bgp’. Choices:
|
|
Indicate whether MPLS (Multi-Protocol Label Switching) is enabled or not. The APIC defaults to SR-MPLS is only supported in APIC v5.0 and above. The child classes Choices:
|
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
Parameters for the OSPF protocol. |
|
The OSPF area cost. The APIC defaults to |
|
The controls of redistribution and summary LSA generation into NSSA and Stub areas. The APIC defaults to Choices:
|
|
The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn’t have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same. However, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate-by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0. The APIC defaults to |
|
The OSPF area type. The APIC defaults to Choices:
|
|
Specifies the description of a policy component. |
|
Start OSPF in WAN instance instead of default. The APIC defaults to Choices:
|
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
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 |
|
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 |
|
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables |
|
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable |
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with If the value is not specified in the task, the value of environment variable |
|
Route Control enforcement direction. The only allowed values are export or import,export. The APIC defaults to Choices:
|
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
Name of an existing tenant. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
Name of the VRF being associated with the L3Out. SR-MPLS Infra L3out requires the VRF to be ‘overlay-1’. |
Notes
Note
The
tenant
anddomain
andvrf
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.
See Also
See also
- cisco.aci.aci_tenant
Manage tenants (fv:Tenant).
- cisco.aci.aci_domain
Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, and fc:DomP).
- cisco.aci.aci_vrf
Manage contexts or VRFs (fv:Ctx).
- 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 L3Out
cisco.aci.aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
description: L3Out for Production tenant
domain: l3dom_prod
vrf: prod
l3protocol: ospf
ospf:
area_cost: 1
area_ctrl: [summary, redistribute]
area_id: 0.0.0.1
area_type: regular
multipod_internal: 'no'
state: present
delegate_to: localhost
- name: Delete L3Out
cisco.aci.aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
state: absent
delegate_to: localhost
- name: Query L3Out information
cisco.aci.aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
state: query
delegate_to: localhost
register: query_result
- name: Query all L3Outs
cisco.aci.aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_all_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |