mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
252 lines
11 KiB
Python
252 lines
11 KiB
Python
# Copyright (c) 2019 Extreme Networks.
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# 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
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author:
|
|
- "Ujwal Komarla (@ujwalkomarla)"
|
|
httpapi: exos
|
|
short_description: Use EXOS REST APIs to communicate with EXOS platform
|
|
description:
|
|
- This plugin provides low level abstraction api's to send REST API
|
|
requests to EXOS network devices and receive JSON responses.
|
|
'''
|
|
|
|
import json
|
|
import re
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.connection import ConnectionError
|
|
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
|
|
from ansible.plugins.httpapi import HttpApiBase
|
|
import ansible.module_utils.six.moves.http_cookiejar as cookiejar
|
|
from ansible.module_utils.common._collections_compat import Mapping
|
|
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, dumps
|
|
|
|
|
|
class HttpApi(HttpApiBase):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(HttpApi, self).__init__(*args, **kwargs)
|
|
self._device_info = None
|
|
self._auth_token = cookiejar.CookieJar()
|
|
|
|
def login(self, username, password):
|
|
auth_path = '/auth/token'
|
|
credentials = {'username': username, 'password': password}
|
|
self.send_request(path=auth_path, data=json.dumps(credentials), method='POST')
|
|
|
|
def logout(self):
|
|
pass
|
|
|
|
def handle_httperror(self, exc):
|
|
return False
|
|
|
|
def send_request(self, path, data=None, method='GET', **message_kwargs):
|
|
headers = {'Content-Type': 'application/json'}
|
|
response, response_data = self.connection.send(path, data, method=method, cookies=self._auth_token, headers=headers, **message_kwargs)
|
|
try:
|
|
if response.status == 204:
|
|
response_data = {}
|
|
else:
|
|
response_data = json.loads(to_text(response_data.getvalue()))
|
|
except ValueError:
|
|
raise ConnectionError('Response was not valid JSON, got {0}'.format(
|
|
to_text(response_data.getvalue())
|
|
))
|
|
return response_data
|
|
|
|
def run_commands(self, commands, check_rc=True):
|
|
if commands is None:
|
|
raise ValueError("'commands' value is required")
|
|
|
|
headers = {'Content-Type': 'application/json'}
|
|
responses = list()
|
|
for cmd in to_list(commands):
|
|
if not isinstance(cmd, Mapping):
|
|
cmd = {'command': cmd}
|
|
|
|
cmd['command'] = strip_run_script_cli2json(cmd['command'])
|
|
|
|
output = cmd.pop('output', None)
|
|
if output and output not in self.get_option_values().get('output'):
|
|
raise ValueError("'output' value is %s is invalid. Valid values are %s" % (output, ','.join(self.get_option_values().get('output'))))
|
|
|
|
data = request_builder(cmd['command'])
|
|
|
|
response, response_data = self.connection.send('/jsonrpc', data, cookies=self._auth_token, headers=headers, method='POST')
|
|
try:
|
|
response_data = json.loads(to_text(response_data.getvalue()))
|
|
except ValueError:
|
|
raise ConnectionError('Response was not valid JSON, got {0}'.format(
|
|
to_text(response_data.getvalue())
|
|
))
|
|
|
|
if response_data.get('error', None):
|
|
raise ConnectionError("Request Error, got {0}".format(response_data['error']))
|
|
if not response_data.get('result', None):
|
|
raise ConnectionError("Request Error, got {0}".format(response_data))
|
|
|
|
response_data = response_data['result']
|
|
|
|
if output and output == 'text':
|
|
statusOut = getKeyInResponse(response_data, 'status')
|
|
cliOut = getKeyInResponse(response_data, 'CLIoutput')
|
|
if statusOut == "ERROR":
|
|
raise ConnectionError("Command error({1}) for request {0}".format(cmd['command'], cliOut))
|
|
if cliOut is None:
|
|
raise ValueError("Response for request {0} doesn't have the CLIoutput field, got {1}".format(cmd['command'], response_data))
|
|
response_data = cliOut
|
|
|
|
responses.append(response_data)
|
|
return responses
|
|
|
|
def get_device_info(self):
|
|
device_info = {}
|
|
device_info['network_os'] = 'exos'
|
|
|
|
reply = self.run_commands({'command': 'show switch detail', 'output': 'text'})
|
|
data = to_text(reply, errors='surrogate_or_strict').strip()
|
|
|
|
match = re.search(r'ExtremeXOS version (\S+)', data)
|
|
if match:
|
|
device_info['network_os_version'] = match.group(1)
|
|
|
|
match = re.search(r'System Type: +(\S+)', data)
|
|
if match:
|
|
device_info['network_os_model'] = match.group(1)
|
|
|
|
match = re.search(r'SysName: +(\S+)', data)
|
|
if match:
|
|
device_info['network_os_hostname'] = match.group(1)
|
|
|
|
return device_info
|
|
|
|
def get_device_operations(self):
|
|
return {
|
|
'supports_diff_replace': False, # identify if config should be merged or replaced is supported
|
|
'supports_commit': False, # identify if commit is supported by device or not
|
|
'supports_rollback': False, # identify if rollback is supported or not
|
|
'supports_defaults': True, # identify if fetching running config with default is supported
|
|
'supports_commit_comment': False, # identify if adding comment to commit is supported of not
|
|
'supports_onbox_diff': False, # identify if on box diff capability is supported or not
|
|
'supports_generate_diff': True, # identify if diff capability is supported within plugin
|
|
'supports_multiline_delimiter': False, # identify if multiline demiliter is supported within config
|
|
'supports_diff_match': True, # identify if match is supported
|
|
'supports_diff_ignore_lines': True, # identify if ignore line in diff is supported
|
|
'supports_config_replace': False, # identify if running config replace with candidate config is supported
|
|
'supports_admin': False, # identify if admin configure mode is supported or not
|
|
'supports_commit_label': False # identify if commit label is supported or not
|
|
}
|
|
|
|
def get_option_values(self):
|
|
return {
|
|
'format': ['text', 'json'],
|
|
'diff_match': ['line', 'strict', 'exact', 'none'],
|
|
'diff_replace': ['line', 'block'],
|
|
'output': ['text', 'json']
|
|
}
|
|
|
|
def get_capabilities(self):
|
|
result = {}
|
|
result['rpc'] = ['get_default_flag', 'run_commands', 'get_config', 'send_request', 'get_capabilities', 'get_diff']
|
|
result['device_info'] = self.get_device_info()
|
|
result['device_operations'] = self.get_device_operations()
|
|
result.update(self.get_option_values())
|
|
result['network_api'] = 'exosapi'
|
|
return json.dumps(result)
|
|
|
|
def get_default_flag(self):
|
|
# The flag to modify the command to collect configuration with defaults
|
|
return 'detail'
|
|
|
|
def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
|
|
diff = {}
|
|
device_operations = self.get_device_operations()
|
|
option_values = self.get_option_values()
|
|
|
|
if candidate is None and device_operations['supports_generate_diff']:
|
|
raise ValueError("candidate configuration is required to generate diff")
|
|
|
|
if diff_match not in option_values['diff_match']:
|
|
raise ValueError("'match' value %s in invalid, valid values are %s" % (diff_match, ', '.join(option_values['diff_match'])))
|
|
|
|
if diff_replace not in option_values['diff_replace']:
|
|
raise ValueError("'replace' value %s in invalid, valid values are %s" % (diff_replace, ', '.join(option_values['diff_replace'])))
|
|
|
|
# prepare candidate configuration
|
|
candidate_obj = NetworkConfig(indent=1)
|
|
candidate_obj.load(candidate)
|
|
|
|
if running and diff_match != 'none' and diff_replace != 'config':
|
|
# running configuration
|
|
running_obj = NetworkConfig(indent=1, contents=running, ignore_lines=diff_ignore_lines)
|
|
configdiffobjs = candidate_obj.difference(running_obj, path=path, match=diff_match, replace=diff_replace)
|
|
|
|
else:
|
|
configdiffobjs = candidate_obj.items
|
|
|
|
diff['config_diff'] = dumps(configdiffobjs, 'commands') if configdiffobjs else ''
|
|
return diff
|
|
|
|
def get_config(self, source='running', format='text', flags=None):
|
|
options_values = self.get_option_values()
|
|
if format not in options_values['format']:
|
|
raise ValueError("'format' value %s is invalid. Valid values are %s" % (format, ','.join(options_values['format'])))
|
|
|
|
lookup = {'running': 'show configuration', 'startup': 'debug cfgmgr show configuration file'}
|
|
if source not in lookup:
|
|
raise ValueError("fetching configuration from %s is not supported" % source)
|
|
|
|
cmd = {'command': lookup[source], 'output': 'text'}
|
|
|
|
if source == 'startup':
|
|
reply = self.run_commands({'command': 'show switch', 'format': 'text'})
|
|
data = to_text(reply, errors='surrogate_or_strict').strip()
|
|
match = re.search(r'Config Selected: +(\S+)\.cfg', data, re.MULTILINE)
|
|
if match:
|
|
cmd['command'] += match.group(1)
|
|
else:
|
|
# No Startup(/Selected) Config
|
|
return {}
|
|
|
|
cmd['command'] += ' '.join(to_list(flags))
|
|
cmd['command'] = cmd['command'].strip()
|
|
|
|
return self.run_commands(cmd)[0]
|
|
|
|
|
|
def request_builder(command, reqid=""):
|
|
return json.dumps(dict(jsonrpc='2.0', id=reqid, method='cli', params=to_list(command)))
|
|
|
|
|
|
def strip_run_script_cli2json(command):
|
|
if to_text(command, errors="surrogate_then_replace").startswith('run script cli2json.py'):
|
|
command = str(command).replace('run script cli2json.py', '')
|
|
return command
|
|
|
|
|
|
def getKeyInResponse(response, key):
|
|
keyOut = None
|
|
for item in response:
|
|
if key in item:
|
|
keyOut = item[key]
|
|
break
|
|
return keyOut
|