aci_l3out_interface
Manage Layer 3 Outside (L3Out) interfaces (l3ext:RsPathL3OutAtt)
Collection: cisco.aci
Full Name: cisco.aci.aci_l3out_interface
Synopsis
Manage Layer 3 Outside (L3Out) interfaces (l3ext:RsPathL3OutAtt)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| address | string | IP address. | ||
| annotation | string | orchestrator:ansible | 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. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| auto_state | string | SVI auto state. | ||
| certificate_name | string | 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. | ||
| description | string | The description of the interface. | ||
| encap | string | The encapsulation on the interface (e.g. “vlan-500”). | ||
| encap_scope | string | The scope of the encapsulation on the interface. | ||
| host | 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 C(ACI_HOST) will be used instead. | ||
| interface_profile | string | yes | Name of the interface profile. | |
| interface_type | string | Type of interface to build. | ||
| ipv6_dad | string | IPv6 DAD feature. | ||
| l3out | string | yes | Name of an existing L3Out. | |
| mac | string | The MAC address of the interface. | ||
| micro_bfd | bool | Enable micro BFD on the interface. Micro BFD should only be configured on Infra SR-MPLS L3Outs Direct Port Channel Interfaces. | ||
| micro_bfd_destination | string | The micro BFD destination address of the interface. | ||
| micro_bfd_timer | int | The micro BFD start timer in seconds. The APIC defaults to C(0) when unset during creation. | ||
| mode | string | Interface mode, only used if instance_type is ext-svi. | ||
| mtu | string | Interface MTU. | ||
| node_id | string | Node to build the interface on for Port-channels and single ports. Hyphen separated pair of nodes (e.g. “201-202”) for vPCs. | ||
| node_profile | string | yes | Name of the node profile. | |
| output_level | string | normal | 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. | |
| 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 C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | 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. | ||
| path_ep | string | Path to interface. Interface Policy Group name for Port-channels and vPCs. Port number for single ports (e.g. “eth1/12”). | ||
| pod_id | string | Pod to build the interface on. | ||
| port | int | 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. | ||
| private_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 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. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). 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. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). 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. | ||
| tenant | string | yes | Name of an existing tenant. | |
| timeout | int | 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. The default value is 30. | ||
| use_proxy | bool | If C(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 C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(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 C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | 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. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(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 C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_l3out_interface": {"address": "192.168.10.1/27", "host": "apic", "interface_profile": "my_interface_profile", "interface_type": "l3-port", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "pod_id": 1, "state": "present", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new routed interface"}
- {"cisco.aci.aci_l3out_interface": {"encap": "vlan-800", "host": "apic", "interface_profile": "my_interface_profile", "interface_type": "ext-svi", "l3out": "my_l3out", "mode": "regular", "node_id": "201-202", "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "my_vpc_ipg", "pod_id": 1, "state": "present", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new SVI vPC"}
- {"cisco.aci.aci_l3out_interface": {"addr": "192.168.90.1/24", "host": "apic", "interface_profile": "ansible_infra_sr_mpls_l3out_interface_profile", "interface_type": "l3-port", "l3out": "ansible_infra_sr_mpls_l3out", "micro_bfd": true, "micro_bfd_destination": "192.168.90.2", "micro_bfd_timer": 75, "node_id": 101, "password": "SomeSecretPassword", "path_ep": "pc_ansible_test", "pod_id": 1, "state": "present", "tenant": "infra", "username": "admin", node_profile: ansible_infra_sr_mpls_l3out_node_profile}, "delegate_to": "localhost", "name": "Add direct port channel interface in the infra SR-MPLS l3out interface profile with micro BFD enabled"}
- {"cisco.aci.aci_l3out_interface": {"host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "pod_id": 1, "state": "absent", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Delete an interface"}
- {"cisco.aci.aci_l3out_interface": {"host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "pod_id": 1, "state": "query", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Query an interface", "register": "query_result"}