mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
9e2ff3e4d5
* Updated Avi Modules with following 1. Support to perform patch operation using the modules. The data update method is selected using avi_api_update_method=patch and patch operation is determined by avi_api_patch_op. The patch data is the normal params that are provided in the modules 2. Support for avi_credentials as single authentication dictionary for all API calls. This is preferred way as opposed to previously all credentials details would pollute the individual Ansible tasks. It also allows the module development to be enhanced without breaking compatibility for new authentication schemes like SAML etc. 3. Support for sharing api_context between the module invocations. This is a workaround to not do multiple logins to Avi Controller and be able to re-use single login across multiple REST API calls. 4. Documentation update for new parameters and existing ones with Units data. * Fixed the pylint and pep8 errors caused due to pycharm editor auto formatting
90 lines
4.1 KiB
Python
90 lines
4.1 KiB
Python
# 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.
|
|
|
|
# This module initially matched the namespace of network module avi. However,
|
|
# that causes namespace import error when other modules from avi namespaces
|
|
# are imported. Added import of absolute_import to avoid import collisions for
|
|
# avi.sdk.
|
|
|
|
from __future__ import absolute_import
|
|
import os
|
|
from distutils.version import LooseVersion
|
|
|
|
HAS_AVI = True
|
|
try:
|
|
import avi.sdk
|
|
sdk_version = getattr(avi.sdk, '__version__', None)
|
|
if ((sdk_version is None) or (sdk_version and (LooseVersion(sdk_version) < LooseVersion('17.2.4')))):
|
|
# It allows the __version__ to be '' as that value is used in development builds
|
|
raise ImportError
|
|
from avi.sdk.utils.ansible_utils import avi_ansible_api
|
|
except ImportError:
|
|
HAS_AVI = False
|
|
|
|
|
|
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=''),
|
|
api_version=dict(default='16.4.4'),
|
|
avi_credentials=dict(default=None, no_log=True, type='dict'),
|
|
api_context=dict(type='dict'))
|
|
|
|
|
|
def ansible_return(module, rsp, changed, req=None, existing_obj=None,
|
|
api_context=None):
|
|
"""
|
|
Helper function to return the right ansible return based on the error code and
|
|
changed status.
|
|
:param module: AnsibleModule
|
|
:param rsp: ApiResponse from avi_api
|
|
:param changed: boolean
|
|
:param req: Actual req dictionary used in Avi API
|
|
:param existing_obj: Existing Avi resource. Used for allowing caller to do
|
|
diff if desired.
|
|
:param api_context: Avi API context information like CSRF token, session_id
|
|
used. This can be passed to the next API call to avoid re-login.
|
|
|
|
Returns: specific ansible module exit function
|
|
"""
|
|
if rsp.status_code > 299:
|
|
return module.fail_json(msg='Error %d Msg %s req: %s api_context:%s ' % (
|
|
rsp.status_code, rsp.text, req, api_context))
|
|
if changed and existing_obj:
|
|
return module.exit_json(
|
|
changed=changed, obj=rsp.json(), old_obj=existing_obj,
|
|
api_context=api_context)
|
|
return module.exit_json(changed=changed, obj=rsp.json(),
|
|
api_context=api_context)
|