Vhd% z d dl mZmZmZ eZddgddZdZdZdZ d d l
m Z d d
l m
Z
mZmZmZ d Zed k( r e y
y
) )absolute_importdivisionprint_functionz1.1preview certified)metadata_versionstatus supported_bya
---
module: aci_contract
short_description: Manage contract resources (vz:BrCP)
description:
- Manage Contract resources on Cisco ACI fabrics.
options:
contract:
description:
- The name of the contract.
type: str
aliases: [ contract_name, name ]
description:
description:
- Description for the contract.
type: str
aliases: [ descr ]
tenant:
description:
- The name of the tenant.
type: str
aliases: [ tenant_name ]
scope:
description:
- The scope of a service contract.
- The APIC defaults to C(context) when unset during creation.
type: str
choices: [ application-profile, context, global, tenant ]
priority:
description:
- The desired QoS class to be used.
- The APIC defaults to C(unspecified) when unset during creation.
type: str
choices: [ level1, level2, level3, unspecified ]
dscp:
description:
- The target Differentiated Service (DSCP) value.
- The APIC defaults to C(unspecified) when unset during creation.
type: str
choices: [ AF11, AF12, AF13, AF21, AF22, AF23, AF31, AF32, AF33, AF41, AF42, AF43, CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, EF, VA, unspecified ]
aliases: [ target ]
state:
description:
- Use C(present) or C(absent) for adding or removing.
- Use C(query) for listing an object or multiple objects.
type: str
choices: [ absent, present, query ]
default: present
name_alias:
description:
- The alias for the current object. This relates to the nameAlias field in ACI.
type: str
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
- cisco.aci.owner
notes:
- This module does not manage Contract Subjects, see M(cisco.aci.aci_contract_subject) to do this.
Contract Subjects can still be removed using this module.
- The C(tenant) used must exist before using this module in your playbook.
The M(cisco.aci.aci_tenant) module can be used for this.
seealso:
- module: cisco.aci.aci_contract_subject
- module: cisco.aci.aci_tenant
- name: APIC Management Information Model reference
description: More information about the internal APIC class B(vz:BrCP).
link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Dag Wieers (@dagwieers)
a
- 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
a
current:
description: The existing configuration from the APIC after the module has finished
returned: success
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
error:
description: The error information as returned from the APIC
returned: failure
type: dict
sample:
{
"code": "122",
"text": "unknown managed object class foo"
}
raw:
description: The raw output returned by the APIC REST API (xml or json)
returned: parse error
type: str
sample: ''
sent:
description: The actual/minimal configuration pushed to the APIC
returned: info
type: list
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment"
}
}
}
previous:
description: The original configuration from the APIC before the module has started
returned: info
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
proposed:
description: The assembled configuration from the user-provided parameters
returned: info
type: dict
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"name": "production"
}
}
}
filter_string:
description: The filter string used for the request
returned: failure or debug
type: str
sample: ?rsp-prop-include=config-only
method:
description: The HTTP method used for the request to the APIC
returned: failure or debug
type: str
sample: POST
response:
description: The HTTP response from the APIC
returned: failure or debug
type: str
sample: OK (30 bytes)
status:
description: The HTTP status from the APIC
returned: failure or debug
type: int
sample: 200
url:
description: The HTTP url used for the request to the APIC
returned: failure or debug
type: str
sample: https://10.11.12.13/api/mo/uni/tn-production.json
)
AnsibleModule) ACIModuleaci_argument_specaci_annotation_specaci_owner_specc t } | j t | j t | j t dddg t ddg t ddg t dg d t dg d t dg d
d g t dd
g d t d t | dddddggdd
ddggg }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d } t | }
|
j t d d j | |d|i t d d!j | |d|i " |
j |d
k( rE|
j d t |||||| # $ |
j d % |
j n|dk( r|
j |
j! y )&Nstr
contract_namename)typealiases tenant_namedescr)zapplication-profilecontextglobaltenant)r choices)level1level2level3 unspecified)AF11AF12AF13AF21AF22AF23AF31AF32AF33AF41AF42AF43CS0CS1CS2CS3CS4CS5CS6CS7EFVAr target)r r r present)absentr7 query)r defaultr )r )contractr descriptionscopeprioritydscpstate
name_aliasTr@ r8 r; r )
argument_specsupports_check_mode required_ifr< r= r> r? rA fvTenantztn-{0}) aci_classaci_rn
module_object
target_filtervzBrCPzbrc-{0})
root_class
subclass_1)r r r= prio
targetDscp nameAlias)rF class_config)rF )r
updater r dictr paramsgetr
construct_urlformat get_existingpayloadget_diff post_config
delete_config exit_json) rB moduler; r< r= r> r? r@ r rA acis j/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_contract.pymainr` sd %'M,./ )*5?F*CD 8egY7']^5*WX
2 J7
: y:XYU#I %N #
hX 6 7
i*h!7 8
F }} ,H--##M2K MM g &E}} ,H == V $D MM g &E
]]
x
(F ""<0J
F
C ??6* !6*
##H-"!8,
! $
x ( ( MMO __main__N)
__future__r r r r
__metaclass__ANSIBLE_METADATA
DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr 6ansible_collections.cisco.aci.plugins.module_utils.acir r
r r r` __name__ ra r_ rm si A @
(-)Vab F
P* Xg
R 5 E EcL zF ra