wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix iosxr netconf plugin response namespace (#49238)

Browse source 
* Fix iosxr netconf plugin response namespace

*  iosxr netconf plugin removes namespace by default
   for all the responses as parsing of xml is easier
   without namepsace in iosxr module. However to validate
   the response received from device against yang model requires
   namespace to be present in resposne.
*  Add a parameter in iosxr netconf plugin to control if namespace
   should be removed from response or not.

* Fix CI issues

* Fix review comment

(cherry picked from commit 829fc0feda)
This commit is contained in:
Ganesh Nalawade 2018-11-29 13:21:41 +05:30 committed by Toshio Kuratomi
parent fb39299578
commit 47e0d29a59
3 changed files with 57 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/iosxr_netconf_plugin_fix.yaml Normal file
View file

@ -0,0 +1,2 @@
bugfixes:
- Fix iosxr netconf plugin response namespace (https://github.com/ansible/ansible/pull/49300)

14
lib/ansible/module_utils/network/iosxr/iosxr.py
View file

@ -358,6 +358,9 @@ def get_config_diff(module, running=None, candidate=None):
def discard_config(module):
conn = get_connection(module)
try:
if is_netconf(module):
conn.discard_changes(remove_ns=True)
else:
conn.discard_changes()
except ConnectionError as exc:
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
@ -370,9 +373,9 @@ def commit_config(module, comment=None, confirmed=False, confirm_timeout=None,
try:
if is_netconf(module):
if check:
reply = conn.validate()
reply = conn.validate(remove_ns=True)
else:
reply = conn.commit(confirmed=confirmed, timeout=confirm_timeout, persist=persist)
reply = conn.commit(confirmed=confirmed, timeout=confirm_timeout, persist=persist, remove_ns=True)
elif is_cliconf(module):
if check:
module.fail_json(msg="Validate configuration is not supported with network_cli connection type")
@ -389,6 +392,9 @@ def get_oper(module, filter=None):
if filter is not None:
try:
if is_netconf(module):
response = conn.get(filter=filter, remove_ns=True)
else:
response = conn.get(filter)
except ConnectionError as exc:
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
@ -404,7 +410,7 @@ def get_config(module, config_filter=None, source='running'):
# Note: Does not cache config in favour of latest config on every get operation.
try:
if is_netconf(module):
out = to_xml(conn.get_config(source=source, filter=config_filter))
out = to_xml(conn.get_config(source=source, filter=config_filter, remove_ns=True))
elif is_cliconf(module):
out = conn.get_config(source=source, flags=config_filter)
cfg = out.strip()
@ -436,7 +442,7 @@ def load_config(module, command_filter, commit=False, replace=False,
try:
for filter in to_list(command_filter):
conn.edit_config(filter)
conn.edit_config(config=filter, remove_ns=True)
candidate = get_config(module, source='candidate', config_filter=nc_get_filter)
diff = get_config_diff(module, running, candidate)

60
lib/ansible/plugins/netconf/iosxr.py
View file

@ -124,56 +124,80 @@ class Netconf(NetconfBase):
# TODO: change .xml to .data_xml, when ncclient supports data_xml on all platforms
@ensure_connected
def get(self, filter=None):
def get(self, filter=None, remove_ns=False):
if isinstance(filter, list):
filter = tuple(filter)
try:
response = self.m.get(filter=filter)
return remove_namespaces(response)
resp = self.m.get(filter=filter)
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))
@ensure_connected
def get_config(self, source=None, filter=None):
def get_config(self, source=None, filter=None, remove_ns=False):
if isinstance(filter, list):
filter = tuple(filter)
try:
response = self.m.get_config(source=source, filter=filter)
return remove_namespaces(response)
resp = self.m.get_config(source=source, filter=filter)
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))
@ensure_connected
def edit_config(self, config=None, format='xml', target='candidate', default_operation=None, test_option=None, error_option=None):
def edit_config(self, config=None, format='xml', target='candidate', default_operation=None, test_option=None, error_option=None, remove_ns=False):
if config is None:
raise ValueError('config value must be provided')
try:
response = self.m.edit_config(config, format=format, target=target, default_operation=default_operation, test_option=test_option,
resp = self.m.edit_config(config, format=format, target=target, default_operation=default_operation, test_option=test_option,
error_option=error_option)
return remove_namespaces(response)
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))
@ensure_connected
def commit(self, confirmed=False, timeout=None, persist=None):
def commit(self, confirmed=False, timeout=None, persist=None, remove_ns=False):
try:
response = self.m.commit(confirmed=confirmed, timeout=timeout, persist=persist)
return remove_namespaces(response)
resp = self.m.commit(confirmed=confirmed, timeout=timeout, persist=persist)
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))
@ensure_connected
def validate(self, source="candidate"):
def validate(self, source="candidate", remove_ns=False):
try:
response = self.m.validate(source=source)
return remove_namespaces(response)
resp = self.m.validate(source=source)
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))
@ensure_connected
def discard_changes(self):
def discard_changes(self, remove_ns=False):
try:
response = self.m.discard_changes()
return remove_namespaces(response)
resp = self.m.discard_changes()
if remove_ns:
response = remove_namespaces(resp)
else:
response = resp.data_xml if hasattr(resp, 'data_xml') else resp.xml
return response
except RPCError as exc:
raise Exception(to_xml(exc.xml))