-
Notifications
You must be signed in to change notification settings - Fork 103
enhancement for node_mgmt_epg_to_contract (DCNE-87) #658
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Ziaf007
wants to merge
16
commits into
CiscoDevNet:master
Choose a base branch
from
Ziaf007:node_mgmt_epg_to_contract
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
2873077
[minor change] New module for node_mgmt_epg to contract binding
Ziaf007 b9278da
fixed syntax in aci_node_mgmt_epg_to_contract test yml file
Ziaf007 5ab580a
fixed the provider match mapping
Ziaf007 5b7f5f4
fixed errors in node_mgmt_epg_to_contract test.yml file. Only query_c…
Ziaf007 84c9550
fixed all errors and removed debug blocks. test.yml passes all checks…
Ziaf007 0a94b86
fixed black formatting
Ziaf007 804e758
modified module and test file for accomodating all the comments of th…
Ziaf007 788ec4c
1) merged root class and Subclass 1 as per request
Ziaf007 6772728
all changes made as requested. Tests are pending and for some reason …
Ziaf007 34d7092
moved the common block aci_class/rn/name outside of the individual ep…
Ziaf007 4c45f4f
reformatted constants.py with black -l 159. Should pass sanity now
Ziaf007 abebab6
replaced aci_name with respective contract MO name
Ziaf007 a7dbc41
sent-->proposed. some asserts remaining
Ziaf007 4d1c845
test file changes needed
Ziaf007 0d36e15
all assertions completed as requested. Tests pass as well
Ziaf007 4039642
all tests pass. module completely ready
Ziaf007 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,366 @@ | ||
#!/usr/bin/python | ||
# -*- coding: utf-8 -*- | ||
|
||
# Copyright: (c) 2025, Faiz Mohammad (@Ziaf007) <[email protected]> | ||
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) | ||
|
||
from __future__ import absolute_import, division, print_function | ||
|
||
__metaclass__ = type | ||
|
||
ANSIBLE_METADATA = {"metadata_version": "1.1", "status": ["preview"], "supported_by": "certified"} | ||
|
||
DOCUMENTATION = r""" | ||
--- | ||
module: aci_node_mgmt_epg_to_contract | ||
short_description: Bind Node Management EPGs to Contracts (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf and mgmt:RsOoBProv) | ||
description: | ||
- Bind Node Management EPGs to Contracts on Cisco ACI fabrics. | ||
notes: | ||
- The C(epg) and C(contract) used must exist before using this module in your playbook. | ||
The M(cisco.aci.aci_node_mgmt_epg), M(cisco.aci.aci_oob_contract) and M(cisco.aci.aci_contract) modules can be used for this. | ||
options: | ||
contract: | ||
description: | ||
- The name of the contract or contract interface. | ||
type: str | ||
aliases: [ contract_name, contract_interface ] | ||
contract_type: | ||
description: | ||
- Determines the type of the Contract. | ||
type: str | ||
required: true | ||
choices: [ consumer, provider, taboo, interface ] | ||
epg: | ||
description: | ||
- The name of the Node Management end point group. | ||
type: str | ||
aliases: [ epg_name ] | ||
epg_type: | ||
description: | ||
- The type of the Node Management end point group. | ||
type: str | ||
required: true | ||
aliases: [ type ] | ||
choices: [ in_band, out_of_band ] | ||
priority: | ||
description: | ||
- Quality of Service (QoS) class. | ||
- The APIC defaults to C(unspecified) when unset during creation. | ||
type: str | ||
choices: [ level1, level2, level3, level4, level5, level6, unspecified ] | ||
provider_match: | ||
description: | ||
- The matching algorithm for Provided Contracts. | ||
- The APIC defaults to C(at_least_one) when unset during creation. | ||
type: str | ||
choices: [ all, at_least_one, at_most_one, none ] | ||
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 | ||
extends_documentation_fragment: | ||
- cisco.aci.aci | ||
- cisco.aci.annotation | ||
|
||
seealso: | ||
- module: cisco.aci.aci_node_mgmt_epg | ||
- module: cisco.aci.aci_contract | ||
- module: cisco.aci.aci_oob_contract | ||
- name: APIC Management Information Model reference | ||
description: More information about the internal APIC classes B(fv:RsCons), B(fv:RsProv), B(fv:RsProtBy), B(fv:RsConsIf), and B(mgmt:RsOoBProv). | ||
link: https://developer.cisco.com/docs/apic-mim-ref/ | ||
author: | ||
- Faiz Mohammad (@Ziaf007) | ||
""" | ||
|
||
EXAMPLES = r""" | ||
- name: Add a new contract to Inband EPG binding | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
epg: anstest | ||
epg_type: in_band | ||
contract: anstest_http | ||
contract_type: provider | ||
priority: level2 | ||
provider_match: at_least_one | ||
state: present | ||
delegate_to: localhost | ||
|
||
- name: Add a new contract to Out-of-Band EPG binding | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
epg: anstest | ||
epg_type: out_of_band | ||
contract: anstest_http | ||
contract_type: provider | ||
priority: level3 | ||
state: present | ||
delegate_to: localhost | ||
|
||
- name: Update a contract of Inband EPG binding | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
epg: anstest | ||
epg_type: in_band | ||
contract: anstest_http | ||
contract_type: provider | ||
priority: level5 | ||
provider_match: all | ||
state: present | ||
delegate_to: localhost | ||
|
||
- name: Query a specific contract to EPG binding | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
epg: anstest | ||
epg_type: in_band | ||
contract: anstest_http | ||
contract_type: consumer | ||
state: query | ||
delegate_to: localhost | ||
register: query_result | ||
|
||
- name: Query all provider contract to EPG bindings | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
contract_type: provider | ||
state: query | ||
delegate_to: localhost | ||
register: query_result | ||
|
||
- name: Remove an existing contract to Inband EPG binding | ||
cisco.aci.aci_node_mgmt_epg_to_contract: | ||
host: apic | ||
username: admin | ||
password: SomeSecretPassword | ||
epg: anstest | ||
epg_type: in_band | ||
contract: anstest_http | ||
contract_type: consumer | ||
state: absent | ||
delegate_to: localhost | ||
""" | ||
|
||
RETURN = r""" | ||
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: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' | ||
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 | ||
""" | ||
|
||
from ansible.module_utils.basic import AnsibleModule | ||
from ansible_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, aci_annotation_spec | ||
from ansible_collections.cisco.aci.plugins.module_utils.constants import ACI_CLASS_MAPPING, MANAGEMENT_EPG_CLASS_MAPPING, PROVIDER_MATCH_MAPPING | ||
|
||
|
||
def main(): | ||
argument_spec = aci_argument_spec() | ||
argument_spec.update(aci_annotation_spec()) | ||
argument_spec.update( | ||
contract_type=dict(type="str", choices=["consumer", "provider", "taboo", "interface"], required=True), | ||
akinross marked this conversation as resolved.
Show resolved
Hide resolved
|
||
epg_type=dict( | ||
Ziaf007 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
type="str", aliases=["type"], choices=["in_band", "out_of_band"], required=True | ||
), # required for querying as provider class for INB and OOB are different | ||
epg=dict(type="str", aliases=["epg_name"]), # Not required for querying all objects | ||
contract=dict(type="str", aliases=["contract_name", "contract_interface"]), # Not required for querying all objects | ||
priority=dict(type="str", choices=["level1", "level2", "level3", "level4", "level5", "level6", "unspecified"]), | ||
provider_match=dict(type="str", choices=["all", "at_least_one", "at_most_one", "none"]), | ||
state=dict(type="str", default="present", choices=["absent", "present", "query"]), | ||
) | ||
|
||
module = AnsibleModule( | ||
argument_spec=argument_spec, | ||
supports_check_mode=True, | ||
required_if=[ | ||
["state", "absent", ["epg", "contract"]], | ||
["state", "present", ["epg", "contract"]], | ||
], | ||
) | ||
|
||
epg_type = module.params.get("epg_type") | ||
contract = module.params.get("contract") | ||
contract_type = module.params.get("contract_type") | ||
epg = module.params.get("epg") | ||
priority = module.params.get("priority") | ||
provider_match = module.params.get("provider_match") | ||
if provider_match is not None: | ||
provider_match = PROVIDER_MATCH_MAPPING[provider_match] | ||
state = module.params.get("state") | ||
|
||
identifier = None | ||
if epg_type == "in_band": | ||
Ziaf007 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if contract_type != "provider" and provider_match is not None: | ||
module.fail_json(msg="the provider_match is only configurable for Provider Contracts") | ||
|
||
identifier = contract_type | ||
class_config = {"matchT": provider_match, "prio": priority, ACI_CLASS_MAPPING[contract_type]["name"]: contract} | ||
|
||
elif epg_type == "out_of_band": | ||
|
||
if contract_type != "provider": | ||
module.fail_json(msg="only provider contract_type is supported for out_of_band epg_type.") | ||
|
||
if provider_match is not None: | ||
module.fail_json(msg="The provider_match argument is not supported for out_of_band Provider contracts") | ||
|
||
identifier = "oob_provider" | ||
class_config = {"prio": priority, "tnVzOOBBrCPName": contract} | ||
|
||
aci_class = ACI_CLASS_MAPPING[identifier]["class"] | ||
aci_rn = ACI_CLASS_MAPPING[identifier]["rn"] | ||
aci_name = ACI_CLASS_MAPPING[identifier]["name"] | ||
|
||
aci = ACIModule(module) | ||
aci.construct_url( | ||
root_class=dict( | ||
aci_class="mgmtp", | ||
aci_rn="tn-mgmt/mgmtp-default", | ||
module_object=None, | ||
), | ||
subclass_1=dict( | ||
aci_class=MANAGEMENT_EPG_CLASS_MAPPING[epg_type]["epg_class"], | ||
aci_rn="{0}{1}".format(MANAGEMENT_EPG_CLASS_MAPPING[epg_type]["epg_rn"], epg), | ||
module_object=epg, | ||
target_filter={"name": epg}, | ||
), | ||
subclass_2=dict( | ||
aci_class=aci_class, | ||
aci_rn="{0}{1}".format(aci_rn, contract), | ||
module_object=contract, | ||
target_filter={aci_name: contract}, | ||
), | ||
) | ||
|
||
aci.get_existing() | ||
|
||
if state == "present": | ||
aci.payload( | ||
aci_class=aci_class, | ||
class_config=class_config, | ||
) | ||
|
||
aci.get_diff(aci_class=aci_class) | ||
|
||
aci.post_config() | ||
|
||
elif state == "absent": | ||
aci.delete_config() | ||
|
||
aci.exit_json() | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
2 changes: 2 additions & 0 deletions
2
tests/integration/targets/aci_node_mgmt_epg_to_contract/aliases
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# No ACI simulator yet, so not enabled | ||
# unsupported |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.