-
Notifications
You must be signed in to change notification settings - Fork 18
ND4.1: Validation of cisco.nd.rest module #503
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
sivakasi-cisco
wants to merge
12
commits into
netascode:develop
Choose a base branch
from
sivakasi-cisco:changes_for_nd_rest
base: develop
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
12 commits
Select commit
Hold shift + click to select a range
1d7c0a0
Changes in ansible-dc-vxlan to support nd_rest
sivakasi-cisco 4e9c967
Changes to support dynamic selection of rest modules
sivakasi-cisco 4cb496d
Changes in tasks file
sivakasi-cisco 772b281
Fixing networks.yml changes
sivakasi-cisco 73df401
plugin introduced to select dcnm_rest or nd_rest
sivakasi-cisco 478765f
Changes to rest module to choose from the OS using utils and action p…
sivakasi-cisco 0f32945
More changes to previous commit
sivakasi-cisco f3d293d
intermediatory changes
sivakasi-cisco fd26e1c
moving get_rest_module to common helper function
sivakasi-cisco 8176d1c
Merge branch 'develop' of https://github.com/sivakasi-cisco/ansible-d…
sivakasi-cisco fdad3c4
Resolving sanity errors
sivakasi-cisco 264394a
Removed debugs
sivakasi-cisco 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
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
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
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
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
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,105 @@ | ||
# Copyright (c) 2024 Cisco Systems, Inc. and its affiliates | ||
# | ||
# Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
# this software and associated documentation files (the "Software"), to deal in | ||
# the Software without restriction, including without limitation the rights to | ||
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
# the Software, and to permit persons to whom the Software is furnished to do so, | ||
# subject to the following conditions: | ||
# | ||
# The above copyright notice and this permission notice shall be included in all | ||
# copies or substantial portions of the Software. | ||
# | ||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
from __future__ import absolute_import, division, print_function | ||
|
||
__metaclass__ = type | ||
|
||
from ansible.utils.display import Display | ||
from ansible.plugins.action import ActionBase | ||
from ...plugin_utils.helper_functions import get_rest_module | ||
|
||
display = Display() | ||
|
||
|
||
class ActionModule(ActionBase): | ||
""" | ||
Action plugin to dynamically select between cisco.nd.nd_rest and cisco.dcnm.dcnm_rest | ||
based on the ansible_network_os variable. | ||
""" | ||
|
||
def run(self, tmp=None, task_vars=None): | ||
""" | ||
Execute the action plugin. | ||
|
||
Args: | ||
tmp (str, optional): Temporary directory. Defaults to None. | ||
task_vars (dict, optional): Dictionary of task variables. Defaults to None. | ||
|
||
Returns: | ||
dict: Results of the REST API call | ||
""" | ||
# Initialize results dictionary | ||
results = super(ActionModule, self).run(tmp, task_vars) | ||
results['changed'] = False | ||
results['failed'] = False | ||
|
||
# Get task arguments | ||
module_args = self._task.args.copy() | ||
|
||
# Get the network OS from task variables or module arguments | ||
network_os = task_vars.get('ansible_network_os') | ||
display.vvvv(f"Using OS module: {network_os}") | ||
|
||
# Determine which module to use based on network_os | ||
rest_module = get_rest_module(network_os) | ||
if not rest_module: | ||
results['failed'] = True | ||
results['msg'] = f"Unsupported network_os: {network_os}" | ||
return results | ||
|
||
display.vvvv(f"Using REST module: {rest_module}") | ||
|
||
try: | ||
display.vvvv(f"Executing module: {rest_module} with args: {module_args}") | ||
|
||
self._task.vars['ansible_rest_os_module'] = rest_module | ||
|
||
# Set the connection to httpapi | ||
if 'connection' not in task_vars: | ||
task_vars['connection'] = 'httpapi' | ||
|
||
# Execute the appropriate REST module | ||
result = self._execute_module( | ||
module_name=rest_module, | ||
module_args=module_args, | ||
task_vars=task_vars, | ||
tmp=tmp, | ||
wrap_async=False | ||
) | ||
|
||
# Update results with the module's results | ||
if result.get('failed'): | ||
results.update(result) | ||
display.error(f"Module execution failed: {result.get('msg')}") | ||
else: | ||
results['changed'] = result.get('changed', False) | ||
results.update(result) | ||
display.vvvv(f"Module execution successful: {result}") | ||
|
||
except Exception as e: | ||
import traceback | ||
error_trace = traceback.format_exc() | ||
results['failed'] = True | ||
results['msg'] = f"Failed to execute {rest_module}: {str(e)}\n{error_trace}" | ||
display.error(results['msg'], wrap_text=False) | ||
|
||
return results |
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.