mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
Update iosxr cliconf plugin (#43837)
* Update iosxr cliconf plugin Fixes #39056 * Update iosxr cliconf plugin * Modify iosxr module_utils code to support refactored cliconf plugin api's * Other minor changes * Fix unit test failure * Update ios, eos, nxos plugin for diff * Fix review comment
This commit is contained in:
Ganesh Nalawade
GitHub
parent
7b1cc11685
commit
d1de1e0449
14 changed files with 217 additions and 153 deletions
|
|
@ -19,12 +19,13 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import collections
|
||||
import re
|
||||
import json
|
||||
|
||||
from itertools import chain
|
||||
|
||||
from ansible.errors import AnsibleConnectionFailure
|
||||
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.cliconf import CliconfBase
|
||||
|
||||
|
|
@ -56,56 +57,167 @@ class Cliconf(CliconfBase):
|
|||
|
||||
return device_info
|
||||
|
||||
def get_config(self, source='running', format='text', filter=None):
|
||||
def configure(self, admin=False):
|
||||
prompt = to_text(self._connection.get_prompt(), errors='surrogate_or_strict').strip()
|
||||
if not prompt.endswith(')#'):
|
||||
if admin and 'admin-' not in prompt:
|
||||
self.send_command('admin')
|
||||
self.send_command('configure terminal')
|
||||
|
||||
def abort(self, admin=False):
|
||||
prompt = to_text(self._connection.get_prompt(), errors='surrogate_or_strict').strip()
|
||||
if prompt.endswith(')#'):
|
||||
self.send_command('abort')
|
||||
if admin and 'admin-' in prompt:
|
||||
self.send_command('exit')
|
||||
|
||||
def get_config(self, source='running', format='text', flags=None):
|
||||
if source not in ['running']:
|
||||
raise ValueError("fetching configuration from %s is not supported" % source)
|
||||
|
||||
lookup = {'running': 'running-config'}
|
||||
if source not in lookup:
|
||||
return self.invalid_params("fetching configuration from %s is not supported" % source)
|
||||
if filter:
|
||||
cmd = 'show {0} {1}'.format(lookup[source], filter)
|
||||
else:
|
||||
cmd = 'show {0}'.format(lookup[source])
|
||||
|
||||
cmd = 'show {0} '.format(lookup[source])
|
||||
cmd += ' '.join(to_list(flags))
|
||||
cmd = cmd.strip()
|
||||
|
||||
return self.send_command(cmd)
|
||||
|
||||
def edit_config(self, commands=None):
|
||||
for cmd in chain(to_list(commands)):
|
||||
try:
|
||||
if isinstance(cmd, str):
|
||||
cmd = json.loads(cmd)
|
||||
command = cmd.get('command', None)
|
||||
prompt = cmd.get('prompt', None)
|
||||
answer = cmd.get('answer', None)
|
||||
sendonly = cmd.get('sendonly', False)
|
||||
newline = cmd.get('newline', True)
|
||||
except:
|
||||
command = cmd
|
||||
prompt = None
|
||||
answer = None
|
||||
sendonly = None
|
||||
newline = None
|
||||
def edit_config(self, candidate=None, commit=True, admin=False, replace=None, comment=None, label=None):
|
||||
operations = self.get_device_operations()
|
||||
self.check_edit_config_capabiltiy(operations, candidate, commit, replace, comment)
|
||||
|
||||
self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline)
|
||||
resp = {}
|
||||
results = []
|
||||
requests = []
|
||||
|
||||
self.configure(admin=admin)
|
||||
|
||||
if replace:
|
||||
candidate = 'load {0}'.format(replace)
|
||||
|
||||
for line in to_list(candidate):
|
||||
if not isinstance(line, collections.Mapping):
|
||||
line = {'command': line}
|
||||
cmd = line['command']
|
||||
results.append(self.send_command(**line))
|
||||
requests.append(cmd)
|
||||
|
||||
diff = self.get_diff(admin=admin)
|
||||
config_diff = diff.get('config_diff')
|
||||
if config_diff or replace:
|
||||
resp['diff'] = config_diff
|
||||
if commit:
|
||||
self.commit(comment=comment, label=label, replace=replace)
|
||||
else:
|
||||
self.discard_changes()
|
||||
|
||||
self.abort(admin=admin)
|
||||
|
||||
resp['request'] = requests
|
||||
resp['response'] = results
|
||||
return resp
|
||||
|
||||
def get_diff(self, admin=False):
|
||||
self.configure(admin=admin)
|
||||
|
||||
diff = {'config_diff': None}
|
||||
response = self.send_command('show commit changes diff')
|
||||
for item in response.splitlines():
|
||||
if item and item[0] in ['<', '+', '-']:
|
||||
diff['config_diff'] = response
|
||||
break
|
||||
return diff
|
||||
|
||||
def get(self, command=None, prompt=None, answer=None, sendonly=False, newline=True, output=None):
|
||||
if output:
|
||||
raise ValueError("'output' value %s is not supported for get" % output)
|
||||
return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline)
|
||||
|
||||
def commit(self, comment=None, label=None):
|
||||
if comment and label:
|
||||
command = 'commit label {0} comment {1}'.format(label, comment)
|
||||
elif comment:
|
||||
command = 'commit comment {0}'.format(comment)
|
||||
elif label:
|
||||
command = 'commit label {0}'.format(label)
|
||||
def commit(self, comment=None, label=None, replace=None):
|
||||
cmd_obj = {}
|
||||
if replace:
|
||||
cmd_obj['command'] = 'commit replace'
|
||||
cmd_obj['prompt'] = 'This commit will replace or remove the entire running configuration'
|
||||
cmd_obj['answer'] = 'yes'
|
||||
else:
|
||||
command = 'commit'
|
||||
self.send_command(command)
|
||||
if comment and label:
|
||||
cmd_obj['command'] = 'commit label {0} comment {1}'.format(label, comment)
|
||||
elif comment:
|
||||
cmd_obj['command'] = 'commit comment {0}'.format(comment)
|
||||
elif label:
|
||||
cmd_obj['command'] = 'commit label {0}'.format(label)
|
||||
else:
|
||||
cmd_obj['command'] = 'commit'
|
||||
|
||||
self.send_command(**cmd_obj)
|
||||
|
||||
def run_commands(self, commands=None, check_rc=True):
|
||||
if commands is None:
|
||||
raise ValueError("'commands' value is required")
|
||||
responses = list()
|
||||
for cmd in to_list(commands):
|
||||
if not isinstance(cmd, collections.Mapping):
|
||||
cmd = {'command': cmd}
|
||||
|
||||
output = cmd.pop('output', None)
|
||||
if output:
|
||||
raise ValueError("'output' value %s is not supported for run_commands" % output)
|
||||
|
||||
try:
|
||||
out = self.send_command(**cmd)
|
||||
except AnsibleConnectionFailure as e:
|
||||
if check_rc:
|
||||
raise
|
||||
out = getattr(e, 'err', e)
|
||||
|
||||
if out is not None:
|
||||
try:
|
||||
out = to_text(out, errors='surrogate_or_strict').strip()
|
||||
except UnicodeError:
|
||||
raise ConnectionError(msg=u'Failed to decode output from %s: %s' % (cmd, to_text(out)))
|
||||
|
||||
try:
|
||||
out = json.loads(out)
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
responses.append(out)
|
||||
return responses
|
||||
|
||||
def discard_changes(self):
|
||||
self.send_command('abort')
|
||||
|
||||
def get_device_operations(self):
|
||||
return {
|
||||
'supports_diff_replace': False,
|
||||
'supports_commit': True,
|
||||
'supports_rollback': True,
|
||||
'supports_defaults': False,
|
||||
'supports_onbox_diff': True,
|
||||
'supports_commit_comment': True,
|
||||
'supports_multiline_delimiter': False,
|
||||
'supports_diff_match': False,
|
||||
'supports_diff_ignore_lines': False,
|
||||
'supports_generate_diff': False,
|
||||
'supports_replace': True,
|
||||
'supports_admin': True,
|
||||
'supports_commit_label': True
|
||||
}
|
||||
|
||||
def get_option_values(self):
|
||||
return {
|
||||
'format': ['text'],
|
||||
'diff_match': [],
|
||||
'diff_replace': [],
|
||||
'output': []
|
||||
}
|
||||
|
||||
def get_capabilities(self):
|
||||
result = {}
|
||||
result['rpc'] = self.get_base_rpc() + ['commit', 'discard_changes']
|
||||
result['rpc'] = self.get_base_rpc() + ['commit', 'discard_changes', 'get_diff', 'configure', 'exit']
|
||||
result['network_api'] = 'cliconf'
|
||||
result['device_info'] = self.get_device_info()
|
||||
result['device_operations'] = self.get_device_operations()
|
||||
result.update(self.get_option_values())
|
||||
return json.dumps(result)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue