aci_contract – Manage contract resources (vz:BrCP)¶
New in version 2.4.
Parameters¶
Notes¶
Note
- This module does not manage Contract Subjects, see aci_contract_subject to do this. Contract Subjects can still be removed using this module.
- The tenantused must exist before using this module in your playbook. The aci_tenant module can be used for this.
See Also¶
See also
- aci_contract_subject – Manage initial Contract Subjects (vz:Subj)
- The official documentation on the aci_contract_subject module.
- aci_tenant – Manage tenants (fv:Tenant)
- The official documentation on the 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
  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
  aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    state: absent
  delegate_to: localhost
- name: Query a specific contract
  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
  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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors¶
- Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
