# (c) 2018 Red Hat Inc. # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import (absolute_import, division, print_function) __metaclass__ = type import json from ansible.module_utils._text import to_text from ansible.module_utils.connection import ConnectionError from ansible.module_utils.network.common.utils import to_list from ansible.plugins.httpapi import HttpApiBase try: from __main__ import display except ImportError: from ansible.utils.display import Display display = Display() class HttpApi(HttpApiBase): def _run_queue(self, queue, output): if self._become: display.vvvv('firing event: on_become') queue.insert(0, 'enable') request = request_builder(queue, output) headers = {'Content-Type': 'application/json'} response, response_data = self.connection.send('/ins', request, 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()) )) results = handle_response(response_data) if self._become: results = results[1:] return results def send_request(self, data, **message_kwargs): output = None queue = list() responses = list() for item in to_list(data): cmd_output = message_kwargs.get('output', 'text') if isinstance(item, dict): command = item['command'] if 'output' in item: cmd_output = item['output'] else: command = item # Emulate '| json' from CLI if command.endswith('| json'): command = command.rsplit('|', 1)[0] cmd_output = 'json' if output and output != cmd_output: responses.extend(self._run_queue(queue, output)) queue = list() output = cmd_output queue.append(command) if queue: responses.extend(self._run_queue(queue, output)) if len(responses) == 1: return responses[0] return responses def edit_config(self, candidate=None, commit=True, replace=None, comment=None): resp = list() operations = self.connection.get_device_operations() self.connection.check_edit_config_capability(operations, candidate, commit, replace, comment) if replace: device_info = self.connection.get_device_info() if '9K' not in device_info.get('network_os_platform', ''): raise ConnectionError(msg=u'replace is supported only on Nexus 9K devices') candidate = 'config replace {0}'.format(replace) responses = self.send_request(candidate, output='config') for response in to_list(responses): if response != '{}': resp.append(response) if not resp: resp = [''] return resp def run_commands(self, commands, check_rc=True): """Runs list of commands on remote device and returns results """ try: out = self.send_request(commands) except ConnectionError as exc: if check_rc is True: raise out = to_text(exc) out = to_list(out) if not out[0]: return out for index, response in enumerate(out): if response[0] == '{': out[index] = json.loads(response) return out def handle_response(response): results = [] if response['ins_api'].get('outputs'): for output in to_list(response['ins_api']['outputs']['output']): if output['code'] != '200': raise ConnectionError('%s: %s' % (output['input'], output['msg'])) elif 'body' in output: result = output['body'] if isinstance(result, dict): result = json.dumps(result) results.append(result.strip()) return results def request_builder(commands, output, version='1.0', chunk='0', sid=None): """Encodes a NXAPI JSON request message """ output_to_command_type = { 'text': 'cli_show_ascii', 'json': 'cli_show', 'bash': 'bash', 'config': 'cli_conf' } maybe_output = commands[0].split('|')[-1].strip() if maybe_output in output_to_command_type: command_type = output_to_command_type[maybe_output] commands = [command.split('|')[0].strip() for command in commands] else: try: command_type = output_to_command_type[output] except KeyError: msg = 'invalid format, received %s, expected one of %s' % \ (output, ','.join(output_to_command_type.keys())) raise ConnectionError(msg) if isinstance(commands, (list, set, tuple)): commands = ' ;'.join(commands) msg = { 'version': version, 'type': command_type, 'chunk': chunk, 'sid': sid, 'input': commands, 'output_format': 'json' } return json.dumps(dict(ins_api=msg))