mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Support for Openswitch (OPX) Control Plane Services (CPS) Module (#44745)
* Generic module to support Openswitch (OPX) Contorl Plane Services (CPS) * Address ansible-test sanity issues
This commit is contained in:
Senthil Kumar Ganesan
John R Barker
parent
4b9c2cb97d
commit
a64b97da42
12 changed files with 724 additions and 0 deletions
0
lib/ansible/modules/network/opx/__init__.py
Normal file
0
lib/ansible/modules/network/opx/__init__.py
Normal file
365
lib/ansible/modules/network/opx/opx_cps.py
Normal file
365
lib/ansible/modules/network/opx/opx_cps.py
Normal file
|
|
@ -0,0 +1,365 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2018 Dell Inc. or its subsidiaries. All Rights Reserved.
|
||||
#
|
||||
# This file is part of Ansible by Red Hat
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: opx_cps
|
||||
version_added: "2.7"
|
||||
author: "Senthil Kumar Ganesan (@skg-net)"
|
||||
short_description: CPS operations on networking device running Openswitch (OPX)
|
||||
description:
|
||||
- Executes the given operation on the YANG object, using CPS API in the
|
||||
networking device running OpenSwitch (OPX). It uses the YANG models
|
||||
provided in https://github.com/open-switch/opx-base-model.
|
||||
options:
|
||||
module_name:
|
||||
description:
|
||||
- Yang path to be configured.
|
||||
attr_type:
|
||||
description:
|
||||
- Attribute Yang type.
|
||||
attr_data:
|
||||
description:
|
||||
- Attribute Yang path and thier correspoding data.
|
||||
operation:
|
||||
description:
|
||||
- Operation to be performed on the object.
|
||||
default: create
|
||||
choices: ['delete', 'create', 'set', 'action', 'get']
|
||||
db:
|
||||
description:
|
||||
- Queries/Writes the specified yang path from/to the db.
|
||||
type: bool
|
||||
default: 'no'
|
||||
qualifier:
|
||||
description:
|
||||
- A qualifier provides the type of object data to retrieve or act on.
|
||||
default: target
|
||||
choices: ['target', 'observed', 'proposed', 'realtime', 'registration', 'running', 'startup']
|
||||
commit_event:
|
||||
description:
|
||||
- Attempts to force the auto-commit event to the specified yang object.
|
||||
type: bool
|
||||
default: 'no'
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Create VLAN
|
||||
opx_cps:
|
||||
module_name: "dell-base-if-cmn/if/interfaces/interface"
|
||||
attr_data: {
|
||||
"base-if-vlan/if/interfaces/interface/id": 230,
|
||||
"if/interfaces/interface/name": "br230",
|
||||
"if/interfaces/interface/type": "ianaift:l2vlan"
|
||||
}
|
||||
operation: "create"
|
||||
- name: Get VLAN
|
||||
opx_cps:
|
||||
module_name: "dell-base-if-cmn/if/interfaces/interface"
|
||||
attr_data: {
|
||||
"if/interfaces/interface/name": "br230",
|
||||
}
|
||||
operation: "get"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
response:
|
||||
description: Output from the CPS transaction.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {'...':'...'}
|
||||
changed:
|
||||
description: Returns if the CPS transaction was performed.
|
||||
returned: when a CPS traction is performed.
|
||||
type: dict
|
||||
sample: {'...':'...'}
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six import iteritems
|
||||
|
||||
try:
|
||||
import cps
|
||||
import cps_object
|
||||
import cps_utils
|
||||
HAS_CPS = True
|
||||
except ImportError:
|
||||
HAS_CPS = False
|
||||
|
||||
|
||||
def get_config(module):
|
||||
|
||||
qualifier = module.params['qualifier']
|
||||
module_name = module.params['module_name']
|
||||
attr_type = module.params["attr_type"]
|
||||
attr_data = module.params["attr_data"]
|
||||
db = module.params["db"]
|
||||
commit_event = module.params["commit_event"]
|
||||
config = dict()
|
||||
|
||||
configobj = parse_cps_parameters(module_name, qualifier,
|
||||
attr_type, attr_data, "get",
|
||||
db, commit_event)
|
||||
cpsconfig = cps_get(configobj)
|
||||
|
||||
if cpsconfig['response']:
|
||||
for key, val in iteritems(cpsconfig['response'][0]['data']):
|
||||
if key == 'cps/key_data':
|
||||
config.update(val)
|
||||
else:
|
||||
config[key] = val
|
||||
|
||||
return config
|
||||
|
||||
|
||||
def diff_dict(base_data, compare_with_data):
|
||||
"""
|
||||
Wrapper API for gives difference between 2 dicts
|
||||
with base_data as the base reference
|
||||
|
||||
Parameters
|
||||
----------
|
||||
base_data : dict
|
||||
compare_with_data : dict
|
||||
|
||||
Return
|
||||
------
|
||||
returns difference of 2 input
|
||||
|
||||
Raises
|
||||
------
|
||||
"""
|
||||
planned_set = set(base_data.keys())
|
||||
discovered_set = set(compare_with_data.keys())
|
||||
intersect_set = planned_set.intersection(discovered_set)
|
||||
changed_dict = {}
|
||||
added_set = planned_set - intersect_set
|
||||
# Keys part of added are new and put into changed_dict
|
||||
if added_set:
|
||||
for key in added_set:
|
||||
changed_dict[key] = base_data[key]
|
||||
|
||||
for key in intersect_set:
|
||||
value = base_data[key]
|
||||
|
||||
if isinstance(value, list):
|
||||
p_list = base_data[key] if key in base_data else []
|
||||
d_list = compare_with_data[key] if key in compare_with_data else []
|
||||
set_diff = set(p_list) - set(d_list)
|
||||
if set_diff:
|
||||
changed_dict[key] = list(set_diff)
|
||||
elif isinstance(value, dict):
|
||||
dict_diff = diff_dict(base_data[key],
|
||||
compare_with_data[key])
|
||||
if dict_diff:
|
||||
changed_dict[key] = dict_diff
|
||||
else:
|
||||
if compare_with_data[key] != base_data[key]:
|
||||
changed_dict[key] = base_data[key]
|
||||
return changed_dict
|
||||
|
||||
|
||||
def convert_cps_raw_list(raw_list):
|
||||
resp_list = []
|
||||
if raw_list:
|
||||
for raw_elem in raw_list:
|
||||
processed_element = convert_cps_raw_data(raw_elem)
|
||||
if processed_element:
|
||||
raw_key = raw_elem['key']
|
||||
individual_element = {}
|
||||
individual_element['data'] = processed_element
|
||||
individual_element['key'] = (cps.qual_from_key(raw_key) + "/" +
|
||||
cps.name_from_key(raw_key, 1))
|
||||
resp_list.append(individual_element)
|
||||
return resp_list
|
||||
|
||||
|
||||
def convert_cps_raw_data(raw_elem):
|
||||
d = {}
|
||||
obj = cps_object.CPSObject(obj=raw_elem)
|
||||
for attr in raw_elem['data']:
|
||||
d[attr] = obj.get_attr_data(attr)
|
||||
return d
|
||||
|
||||
|
||||
def parse_cps_parameters(module_name, qualifier, attr_type,
|
||||
attr_data, operation=None, db=None,
|
||||
commit_event=None):
|
||||
|
||||
obj = cps_object.CPSObject(module=module_name, qual=qualifier)
|
||||
|
||||
if operation:
|
||||
obj.set_property('oper', operation)
|
||||
|
||||
if attr_type:
|
||||
for key, val in iteritems(attr_type):
|
||||
cps_utils.cps_attr_types_map.add_type(key, val)
|
||||
|
||||
for key, val in iteritems(attr_data):
|
||||
|
||||
embed_attrs = key.split(',')
|
||||
embed_attrs_len = len(embed_attrs)
|
||||
if embed_attrs_len >= 3:
|
||||
obj.add_embed_attr(embed_attrs, val, embed_attrs_len - 2)
|
||||
else:
|
||||
if isinstance(val, str):
|
||||
val_list = val.split(',')
|
||||
# Treat as list if value contains ',' but is not
|
||||
# enclosed within {}
|
||||
if len(val_list) == 1 or val.startswith('{'):
|
||||
obj.add_attr(key, val)
|
||||
else:
|
||||
obj.add_attr(key, val_list)
|
||||
else:
|
||||
obj.add_attr(key, val)
|
||||
|
||||
if db:
|
||||
cps.set_ownership_type(obj.get_key(), 'db')
|
||||
obj.set_property('db', True)
|
||||
else:
|
||||
obj.set_property('db', False)
|
||||
|
||||
if commit_event:
|
||||
cps.set_auto_commit_event(obj.get_key(), True)
|
||||
obj.set_property('commit-event', True)
|
||||
return obj
|
||||
|
||||
|
||||
def cps_get(obj):
|
||||
|
||||
RESULT = dict()
|
||||
key = obj.get()
|
||||
l = []
|
||||
cps.get([key], l)
|
||||
|
||||
resp_list = convert_cps_raw_list(l)
|
||||
|
||||
RESULT["response"] = resp_list
|
||||
RESULT["changed"] = False
|
||||
return RESULT
|
||||
|
||||
|
||||
def cps_transaction(obj):
|
||||
|
||||
RESULT = dict()
|
||||
ch = {'operation': obj.get_property('oper'), 'change': obj.get()}
|
||||
if cps.transaction([ch]):
|
||||
RESULT["response"] = convert_cps_raw_list([ch['change']])
|
||||
RESULT["changed"] = True
|
||||
else:
|
||||
error_msg = "Transaction error while " + obj.get_property('oper')
|
||||
raise RuntimeError(error_msg)
|
||||
return RESULT
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
main entry point for module execution
|
||||
"""
|
||||
argument_spec = dict(
|
||||
qualifier=dict(required=False,
|
||||
default="target",
|
||||
type='str',
|
||||
choices=['target', 'observed', 'proposed', 'realtime',
|
||||
'registration', 'running', 'startup']),
|
||||
module_name=dict(required=True, type='str'),
|
||||
attr_type=dict(required=False, type='dict'),
|
||||
attr_data=dict(required=True, type='dict'),
|
||||
operation=dict(required=False,
|
||||
default="create",
|
||||
type='str',
|
||||
choices=['delete', 'create', 'set', 'action', 'get']),
|
||||
db=dict(required=False, default=False, type='bool'),
|
||||
commit_event=dict(required=False, default=False, type='bool')
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
supports_check_mode=False)
|
||||
|
||||
if not HAS_CPS:
|
||||
module.fail_json(msg='CPS library required for this module')
|
||||
|
||||
qualifier = module.params['qualifier']
|
||||
module_name = module.params['module_name']
|
||||
attr_type = module.params["attr_type"]
|
||||
attr_data = module.params["attr_data"]
|
||||
operation = module.params['operation']
|
||||
db = module.params["db"]
|
||||
commit_event = module.params["commit_event"]
|
||||
RESULT = dict(changed=False, db=False, commit_event=False)
|
||||
obj = parse_cps_parameters(module_name, qualifier, attr_type,
|
||||
attr_data, operation, db, commit_event)
|
||||
|
||||
if db:
|
||||
RESULT['db'] = True
|
||||
if commit_event:
|
||||
RESULT['commit_event'] = True
|
||||
|
||||
try:
|
||||
if operation == 'get':
|
||||
RESULT.update(cps_get(obj))
|
||||
else:
|
||||
config = get_config(module)
|
||||
diff = attr_data
|
||||
|
||||
if config:
|
||||
candidate = dict()
|
||||
for key, val in iteritems(attr_data):
|
||||
if key == 'cps/key_data':
|
||||
candidate.update(val)
|
||||
else:
|
||||
candidate[key] = val
|
||||
diff = diff_dict(candidate, config)
|
||||
|
||||
if operation == "delete":
|
||||
if config:
|
||||
RESULT.update({"config": config,
|
||||
"candidate": attr_data,
|
||||
"diff": diff})
|
||||
RESULT.update(cps_transaction(obj))
|
||||
else:
|
||||
if diff:
|
||||
if 'cps/key_data' in attr_data:
|
||||
diff.update(attr_data['cps/key_data'])
|
||||
obj = parse_cps_parameters(module_name, qualifier,
|
||||
attr_type, diff, operation,
|
||||
db, commit_event)
|
||||
RESULT.update({"config": config,
|
||||
"candidate": attr_data,
|
||||
"diff": diff})
|
||||
RESULT.update(cps_transaction(obj))
|
||||
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(type(e).__name__) + ": " + str(e))
|
||||
|
||||
module.exit_json(**RESULT)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue