cisco.aci.aci_contract – Manage contract resources (vz:BrCP)
cisco.aci.aci_contract – Manage contract resources (vz:BrCP)
Note
This plugin is part of the cisco.aci collection (version 2.0.0).
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 | Choices/Defaults | Comments |
---|---|---|
annotation string |
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable | |
certificate_name string |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable
| |
contract string |
The name of the contract.
| |
description string |
Description for the contract.
| |
dscp string |
|
The target Differentiated Service (DSCP) value. The APIC defaults to
|
host 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
| |
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.
If the value is not specified in the task, the value of environment variable |
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 | |
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 | |
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 | |
password string |
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables | |
port integer |
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable | |
priority string |
|
The desired QoS class to be used. The APIC defaults to |
private_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 This option is mutual exclusive with If the value is not specified in the task, the value of environment variable
| |
scope string |
|
The scope of a service contract. The APIC defaults to |
state string |
|
Use Use |
tenant string |
The name of the tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables
|
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
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 | Returned | Description |
---|---|---|
current list / elements=string |
success |
The existing configuration from the APIC after the module has finished
Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
error dictionary |
failure |
The error information as returned from the APIC
Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
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 / elements=string |
info |
The original configuration from the APIC before the module has started
Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
proposed dictionary |
info |
The assembled configuration from the user-provided parameters
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
raw string |
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
|
response string |
failure or debug |
The HTTP response from the APIC
Sample: OK (30 bytes) |
sent list / elements=string |
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: |
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_contract_module.html