You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.aci.aci_contract module – Manage contract resources (vz:BrCP)

Note

This module is part of the cisco.aci collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_contract.

Synopsis

• Manage Contract resources on Cisco ACI fabrics.

Parameters

Parameter	Comments
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.
certificate_name aliases: cert_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. If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
contract aliases: contract_name, name string	The name of the contract.
description aliases: descr string	Description for the contract.
dscp aliases: target string	The target Differentiated Service (DSCP) value. The APIC defaults to unspecified when unset during creation. Choices: AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS0 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF VA unspecified
host aliases: hostname string / required	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 ACI_HOST will be used instead.
name_alias string	The alias for the current object. This relates to the nameAlias field in ACI.
output_level string	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead. Choices: debug info normal ← (default)
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 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 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 ACI_OWNER_TAG will be used instead.
password string	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. If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for REST connection. The default value depends on parameter use_ssl. If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
priority string	The desired QoS class to be used. The APIC defaults to unspecified when unset during creation. Choices: level1 level2 level3 unspecified
private_key aliases: cert_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 certificate_name that is used. This option is mutual exclusive with password. If password is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.
scope string	The scope of a service contract. The APIC defaults to context when unset during creation. Choices: application-profile context global tenant
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: absent present ← (default) query
tenant aliases: tenant_name string	The name of the tenant.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead. Default: 30
use_proxy boolean	If no, 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 ACI_USE_PROXY will be used instead. Choices: no yes ← (default)
use_ssl boolean	If no, 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 ACI_USE_SSL will be used instead. Choices: no yes ← (default)
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead. Default: “admin”
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. If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead. Choices: no yes ← (default)

Notes

Note

• This module does not manage Contract Subjects, see cisco.aci.aci_contract_subject to do this. Contract Subjects can still be removed using this module.

• The tenant used must exist before using this module in your playbook. The cisco.aci.aci_tenant module can be used for this.

See Also

See also

cisco.aci.aci_contract_subject

The official documentation on the cisco.aci.aci_contract_subject module.

cisco.aci.aci_tenant

The official documentation on the cisco.aci.aci_tenant module.

APIC Management Information Model reference

More information about the internal APIC class vz:BrCP.

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Add a new contract
  cisco.aci.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
  delegate_to: localhost

- name: Remove an existing contract
  cisco.aci.aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    state: absent
  delegate_to: localhost

- name: Query a specific contract
  cisco.aci.aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all contracts
  cisco.aci.aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	The existing configuration from the APIC after the module has finished Returned: success Sample: [{“fvTenant”: {“attributes”: {“descr”: “Production environment”, “dn”: “uni/tn-production”, “name”: “production”, “nameAlias”: “”, “ownerKey”: “”, “ownerTag”: “”}}}]
error dictionary	The error information as returned from the APIC Returned: failure Sample: {“code”: “122”, “text”: “unknown managed object class foo”}
filter_string string	The filter string used for the request Returned: failure or debug Sample: “?rsp-prop-include=config-only”
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: “POST”
previous list / elements=string	The original configuration from the APIC before the module has started Returned: info Sample: [{“fvTenant”: {“attributes”: {“descr”: “Production”, “dn”: “uni/tn-production”, “name”: “production”, “nameAlias”: “”, “ownerKey”: “”, “ownerTag”: “”}}}]
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: {“fvTenant”: {“attributes”: {“descr”: “Production environment”, “name”: “production”}}}
raw string	The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: “\u003c?xml version=\”1.0\” encoding=\”UTF-8\”?\u003e\u003cimdata totalCount=\”1\”\u003e\u003cerror code=\”122\” text=\”unknown managed object class foo\”/\u003e\u003c/imdata\u003e”
response string	The HTTP response from the APIC Returned: failure or debug Sample: “OK (30 bytes)”
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: {“fvTenant”: {“attributes”: {“descr”: “Production environment”}}}
status integer	The HTTP status from the APIC Returned: failure or debug Sample: 200
url string	The HTTP url used for the request to the APIC Returned: failure or debug Sample: “https://10.11.12.13/api/mo/uni/tn-production.json”

Authors

• Dag Wieers (@dagwieers)

Collection links

Issue Tracker Repository (Sources)