cisco.aci.aci_l3out_interface module – Manage Layer 3 Outside (L3Out) interfaces (l3ext:RsPathL3OutAtt)
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_interface
.
Synopsis
Manage L3Out interfaces on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
IP address. |
|
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: |
|
SVI auto state. Choices:
|
|
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 |
|
The description of the interface. |
|
The encapsulation on the interface (e.g. “vlan-500”). |
|
The scope of the encapsulation on the interface. 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 the interface profile. |
|
Type of interface to build. Choices:
|
|
IPv6 DAD feature. Choices:
|
|
Name of an existing L3Out. |
|
The MAC address of the interface. |
|
Enable micro BFD on the interface. Micro BFD should only be configured on Infra SR-MPLS L3Outs Direct Port Channel Interfaces. Choices:
|
|
The micro BFD destination address of the interface. |
|
The micro BFD start timer in seconds. The APIC defaults to |
|
Interface mode, only used if instance_type is ext-svi. Choices:
|
|
Interface MTU. |
|
Node to build the interface on for Port-channels and single ports. Hyphen separated pair of nodes (e.g. “201-202”) for vPCs. |
|
Name of the node profile. |
|
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 |
|
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 |
|
Path to interface. Interface Policy Group name for Port-channels and vPCs. Port number for single ports (e.g. “eth1/12”). |
|
Pod to build the interface on. |
|
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 |
|
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:
|
Notes
Note
The
tenant
,l3out
,node_profile
and theinterface_profile
must exist before using this module in your playbook. The cisco.aci.aci_tenant, cisco.aci.aci_l3out, cisco.aci.aci_l3out_logical_node_profile and cisco.aci.aci_l3out_logical_interface_profile can be used for this.
See Also
See also
- aci_tenant
The official documentation on the aci_tenant module.
- aci_l3out
The official documentation on the aci_l3out module.
- aci_l3out_logical_node_profile
The official documentation on the aci_l3out_logical_node_profile module.
- aci_l3out_logical_interface_profile
The official documentation on the aci_l3out_logical_interface_profile module.
- APIC Management Information Model reference
More information about the internal APIC class l3ext:RsPathL3OutAtt
- 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 routed interface
cisco.aci.aci_l3out_interface:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
interface_type: l3-port
address: 192.168.10.1/27
state: present
delegate_to: localhost
- name: Add a new SVI vPC
cisco.aci.aci_l3out_interface:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201-202
path_ep: my_vpc_ipg
interface_type: ext-svi
encap: vlan-800
mode: regular
state: present
delegate_to: localhost
- name: Add direct port channel interface in the infra SR-MPLS l3out interface profile with micro BFD enabled
aci_l3out_interface:
host: apic
username: admin
password: SomeSecretPassword
tenant: infra
l3out: ansible_infra_sr_mpls_l3out
interface_profile: ansible_infra_sr_mpls_l3out_interface_profile
pod_id: 1
node_id: 101
path_ep: pc_ansible_test
interface_type: l3-port
addr: 192.168.90.1/24
micro_bfd: true
micro_bfd_destination: 192.168.90.2
micro_bfd_timer: 75
state: present
delegate_to: localhost
- name: Delete an interface
cisco.aci.aci_l3out_interface:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
state: absent
delegate_to: localhost
- name: Query an interface
cisco.aci.aci_l3out_interface:
host: apic
username: admin
password: SomeSecretPassword
tenant: my_tenant
l3out: my_l3out
node_profile: my_node_profile
interface_profile: my_interface_profile
pod_id: 1
node_id: 201
path_ep: eth1/12
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 |
---|---|
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: |