aci_l3out
Manage Layer 3 Outside (L3Out) objects (l3ext:Out)
Collection: cisco.aci
Full Name: cisco.aci.aci_l3out
Synopsis
Manage Layer 3 Outside (L3Out) objects (l3ext:Out)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| 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. | |
| asn | int | The AS number for the L3Out. Only applicable when using ’eigrp’ as the l3protocol. | ||
| 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 | Description for the L3Out. | ||
| domain | string | Name of the external L3 domain being associated with the L3Out. | ||
| dscp | string | The target Differentiated Service (DSCP) value. The APIC defaults to C(unspecified) when unset during creation. | ||
| 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. | ||
| l3out | string | Name of L3Out being created. | ||
| l3protocol | list | 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 C([ bgp, ospf ]) even though “ospf” was provided before. Second example, to change the protocol from OSPF to EIGRP, the user must simply enter C([ eigrp ]) and the previous OSPF protocol will be deleted. To remove all existing protocols, the user must enter C([ static ]). SR-MPLS Infra L3out requires the l3protocol to be ‘bgp’. | ||
| mpls | string | Indicate whether MPLS (Multi-Protocol Label Switching) is enabled or not. The APIC defaults to C(no) when unset during creation. SR-MPLS is only supported in APIC v5.0 and above. The child classes C(mplsExtP), C(mplsRsLabelPol) and C(l3extProvLbl) will be displayed in output only when C(yes). | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| ospf | dict | Parameters for the OSPF protocol. | ||
| 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. | ||
| owner_key | string | 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 C(ACI_OWNER_KEY) will be used instead. | ||
| owner_tag | string | 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 C(ACI_OWNER_TAG) 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. | ||
| 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. | ||
| route_control | list | Route Control enforcement direction. The only allowed values are export or import,export. The APIC defaults to C(export) when unset during creation. | ||
| 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 | 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. | ||
| vrf | string | Name of the VRF being associated with the L3Out. SR-MPLS Infra L3out requires the VRF to be ‘overlay-1’. |
Example
yaml
- {"cisco.aci.aci_l3out": {"description": "L3Out for Production tenant", "domain": "l3dom_prod", "host": "apic", "l3protocol": "ospf", "name": "prod_l3out", "ospf": {"area_cost": 1, "area_ctrl": ["summary", "redistribute"], "area_id": "0.0.0.1", "area_type": "regular", "multipod_internal": "no"}, "password": "SomeSecretPassword", "state": "present", "tenant": "production", "username": "admin", "vrf": "prod"}, "delegate_to": "localhost", "name": "Add a new L3Out"}
- {"cisco.aci.aci_l3out": {"host": "apic", "name": "prod_l3out", "password": "SomeSecretPassword", "state": "absent", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Delete L3Out"}
- {"cisco.aci.aci_l3out": {"host": "apic", "name": "prod_l3out", "password": "SomeSecretPassword", "state": "query", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Query L3Out information", "register": "query_result"}
- {"cisco.aci.aci_l3out": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all L3Outs", "register": "query_all_result"}