mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 22:00:22 -07:00
Avi Networks Ansible modules. (#20415)
* Avi Networks Ansible modules. Avi Version: 16.3.4 * Fixed Review comments 1. Changed description to be full sentences 2. Fixed Pep8 warnings. 3. Fixed comments and descriptions. * 1. Fixed descriptions and messages as per review comments. 2. Added descriptions for the missing parameters. * Fixed the shippable break due to the incorrect description format * Removed the extra modules so that there is a single module for the first commit * Updated license to BSD based on review comments * updated comments based on review feedback * Refactored code to handle POST and PUT scenarios where playbook does not need to check whether object is present. Moved ansible helper utilities to module_utils as now roles can be patched with module_utils as well. * fixed pep8 warnings
This commit is contained in:
parent
9f3870ddcd
commit
798972c72a
5 changed files with 350 additions and 0 deletions
64
lib/ansible/module_utils/avi.py
Normal file
64
lib/ansible/module_utils/avi.py
Normal file
|
@ -0,0 +1,64 @@
|
|||
# This code is part of Ansible, but is an independent component.
|
||||
# This particular file snippet, and this file snippet only, is BSD licensed.
|
||||
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
||||
# still belong to the author of the module, and may assign their own license
|
||||
# to the complete work.
|
||||
#
|
||||
# Copyright (c), Gaurav Rastogi <grastogi@avinetworks.com>, 2017
|
||||
# All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without modification,
|
||||
# are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||||
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
#
|
||||
|
||||
import os
|
||||
|
||||
|
||||
def avi_common_argument_spec():
|
||||
"""
|
||||
Returns common arguments for all Avi modules
|
||||
:return: dict
|
||||
"""
|
||||
return dict(
|
||||
controller=dict(default=os.environ.get('AVI_CONTROLLER', '')),
|
||||
username=dict(default=os.environ.get('AVI_USERNAME', '')),
|
||||
password=dict(default=os.environ.get('AVI_PASSWORD', ''), no_log=True),
|
||||
tenant=dict(default='admin'),
|
||||
tenant_uuid=dict(default=''))
|
||||
|
||||
|
||||
def ansible_return(module, rsp, changed, req=None, existing_obj=None):
|
||||
"""
|
||||
Helper function to return the right ansible return based on the error code and
|
||||
changed status.
|
||||
:param module: AnsibleModule
|
||||
:param rsp: ApiResponse object returned from ApiSession.
|
||||
:param changed: Whether something changed in this module.
|
||||
:param req: Dict data for Avi API call.
|
||||
:param existing_obj: Dict representing current HTTP resource in Avi Controller.
|
||||
|
||||
Returns: specific ansible module exit function
|
||||
"""
|
||||
if rsp.status_code > 299:
|
||||
return module.fail_json(msg='Error %d Msg %s req: %s' % (
|
||||
rsp.status_code, rsp.text, req))
|
||||
if changed and existing_obj:
|
||||
return module.exit_json(
|
||||
changed=changed, obj=rsp.json(), old_obj=existing_obj)
|
||||
return module.exit_json(changed=changed, obj=rsp.json())
|
Loading…
Add table
Add a link
Reference in a new issue