New in version 2.6.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| certificate_name |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
It defaults to the
private_key basename, without extension.aliases: cert_name |
|
| description |
Description for the L3Out.
aliases: descr |
|
|
domain
required |
Name of the external L3 domain being associated with the L3Out.
aliases: ext_routed_domain_name, routed_domain |
|
| dscp |
|
The target Differentiated Service (DSCP) value.
The APIC defaults to
unspecified when unset during creation.aliases: target |
|
host
required |
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
|
l3out
required |
Name of L3Out being created.
aliases: l3out_name, name |
|
| l3protocol |
|
Routing protocol for the L3Out
|
| output_level |
|
Influence the output of this ACI module.
normal means the standard output, incl. current dictinfo adds informational output, incl. previous, proposed and sent dictsdebug adds debugging output, incl. filter_string, method, response, status and url information |
|
password
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 |
Port number to be used for REST connection.
The default value depends on parameter `use_ssl`.
|
|
|
private_key
required |
PEM formatted file that contains your private key to be used for signature-based authentication.
The name of the key (without extension) is used as the certificate name in ACI, unless
certificate_name is specified.This option is mutual exclusive with
password. If password is provided too, it will be ignored.aliases: cert_key |
|
| route_control |
|
Route Control enforcement direction. The only allowed values are export or import,export.
aliases: route_control_enforcement |
| state |
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
|
tenant
required |
Name of an existing tenant.
aliases: tenant_name |
|
|
timeout
int |
Default: 30
|
The socket level timeout in seconds.
|
|
use_proxy
bool |
|
If
no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
|
use_ssl
bool |
|
If
no, an HTTP connection will be used instead of the default HTTPS connection. |
| username |
Default: admin
|
The username to use for authentication.
aliases: user |
|
validate_certs
bool |
|
If
no, SSL certificates will not be validated.This should only set to
no when used on personally controlled sites using self-signed certificates. |
|
vrf
required |
Name of the VRF being associated with the L3Out.
aliases: vrf_name |
Note
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.- name: Add a new L3Out
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
- name: Delete L3Out
aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
state: absent
- name: Query L3Out information
aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
state: query
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}]
|
|
error
dict
|
failure |
The error information as returned from the APIC
Sample:
{'text': 'unknown managed object class foo', 'code': '122'}
|
|
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production', 'nameAlias': '', 'ownerTag': ''}}}]
|
|
proposed
dict
|
info |
The assembled configuration from the user-provided parameters
Sample:
{'fvTenant': {'attributes': {'name': 'production', 'descr': 'Production environment'}}}
|
|
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
int
|
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
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.