New in version 2.4.
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 |
|
contract
required |
|
The name of the contract.
aliases: contract_name, name |
|
description
|
|
Description for the contract.
aliases: descr |
|
dscp
|
|
The target Differentiated Service (DSCP) value.
aliases: target |
|
host
required |
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
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
|
Default:
443 (https), 80 (http)
|
Port number to be used for REST connection.
The default value depends on parameter `use_ssl`.
|
|
priority
|
|
The desired QoS class to be used.
|
|
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 |
|
scope
|
|
The scope of a service contract.
|
|
state
|
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
|
tenant
required |
|
The name of the tenant.
aliases: tenant_name |
|
timeout
|
Default:
30
|
The socket level timeout in seconds.
|
|
use_proxy
|
|
If
no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
|
use_ssl
|
|
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
|
|
If
no, SSL certificates will not be validated.This should only set to
no when used on personally controlled sites using self-signed certificates. |
Note
- name: Add a new contract
aci_contract:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
description: Communication between web-servers and database
scope: application-profile
state: present
- name: Remove an existing contract
aci_contract:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
state: absent
- name: Query a specific contract
aci_contract:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
state: query
- name: Query all contracts
aci_contract:
host: apic
username: admin
password: SomeSecretPassword
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.