New in version 2.4.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
certificate_name
string
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
If a
private_key filename was provided, this defaults to the private_key basename, without extension.If PEM-formatted content was provided for
private_key, this defaults to the username value.aliases: cert_name |
|
|
description
string
|
The description for the VRF.
aliases: descr |
|
|
host
string
/ required
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
|
output_level
string
|
|
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
string
/ 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. |
|
|
policy_control_direction
string
|
|
Determines if the policy should be enforced by the fabric on ingress or egress.
|
|
policy_control_preference
string
|
|
Determines if the fabric should enforce contract policies to allow routing and packet forwarding.
|
|
port
integer
|
Port number to be used for REST connection.
The default value depends on parameter
use_ssl. |
|
|
private_key
string
/ required
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication.
This value also influences the default
certificate_name that is used.This option is mutual exclusive with
password. If password is provided too, it will be ignored.aliases: cert_key |
|
|
state
string
|
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
|
tenant
string
|
The name of the Tenant the VRF should belong to.
aliases: tenant_name |
|
|
timeout
integer
|
Default: 30
|
The socket level timeout in seconds.
|
|
use_proxy
boolean
|
|
If
no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
|
use_ssl
boolean
|
|
If
no, an HTTP connection will be used instead of the default HTTPS connection. |
|
username
string
|
Default: "admin"
|
The username to use for authentication.
aliases: user |
|
validate_certs
boolean
|
|
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
string
|
The name of the VRF.
aliases: context, name, vrf_name |
Note
tenant used must exist before using this module in your playbook. The aci_tenant module can be used for this.See also
- name: Add a new VRF to a tenant
aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
descr: Lab VRF
policy_control_preference: enforced
policy_control_direction: ingress
state: present
delegate_to: localhost
- name: Remove a VRF for a tenant
aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
state: absent
delegate_to: localhost
- name: Query a VRF of a tenant
aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
state: query
delegate_to: localhost
register: query_result
- name: Query all VRFs
aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
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
dictionary
|
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
dictionary
|
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
integer
|
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.