mirror of https://github.com/ansible/ansible.git
Add netconf_get module (#39869)
* Add netconf_get module Implements part-1 of proposal #104 https://github.com/ansible/proposals/issues/104 * Add netconf_get module * Refactor `get`, `get_config`, `lock`, `unlock` and `discard_changes` netconf plugin api's * Add netconf module_utils file which netconf module related common functions * Refactor junos and iosxr netconf plugins * Fix source option handling * Fix review comments * Update botmeta file * Update review comments and add support for lock * Lock update fix * Fix CI issue * Add integration test and minor fixes * Fix review comments * Fix CI failure * Fix CI issues * Fix CI issues * Fix review comments and update integration test * Fix review comments * Fix review comments * Fix review comments Fix reveiw commentspull/40202/merge
parent
4c0ceaea3d
commit
30f992f260
@ -0,0 +1,106 @@
|
|||||||
|
#
|
||||||
|
# (c) 2018 Red Hat, Inc.
|
||||||
|
#
|
||||||
|
# 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/>.
|
||||||
|
#
|
||||||
|
import json
|
||||||
|
|
||||||
|
from contextlib import contextmanager
|
||||||
|
|
||||||
|
from ansible.module_utils._text import to_text
|
||||||
|
from ansible.module_utils.connection import Connection, ConnectionError
|
||||||
|
from ansible.module_utils.network.common.netconf import NetconfConnection
|
||||||
|
|
||||||
|
|
||||||
|
def get_connection(module):
|
||||||
|
if hasattr(module, '_netconf_connection'):
|
||||||
|
return module._netconf_connection
|
||||||
|
|
||||||
|
capabilities = get_capabilities(module)
|
||||||
|
network_api = capabilities.get('network_api')
|
||||||
|
if network_api == 'netconf':
|
||||||
|
module._netconf_connection = NetconfConnection(module._socket_path)
|
||||||
|
else:
|
||||||
|
module.fail_json(msg='Invalid connection type %s' % network_api)
|
||||||
|
|
||||||
|
return module._netconf_connection
|
||||||
|
|
||||||
|
|
||||||
|
def get_capabilities(module):
|
||||||
|
if hasattr(module, '_netconf_capabilities'):
|
||||||
|
return module._netconf_capabilities
|
||||||
|
|
||||||
|
capabilities = Connection(module._socket_path).get_capabilities()
|
||||||
|
module._netconf_capabilities = json.loads(capabilities)
|
||||||
|
return module._netconf_capabilities
|
||||||
|
|
||||||
|
|
||||||
|
def lock_configuration(x, target=None):
|
||||||
|
conn = get_connection(x)
|
||||||
|
return conn.lock(target=target)
|
||||||
|
|
||||||
|
|
||||||
|
def unlock_configuration(x, target=None):
|
||||||
|
conn = get_connection(x)
|
||||||
|
return conn.unlock(target=target)
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def locked_config(module, target=None):
|
||||||
|
try:
|
||||||
|
lock_configuration(module, target=target)
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
unlock_configuration(module, target=target)
|
||||||
|
|
||||||
|
|
||||||
|
def get_config(module, source, filter, lock=False):
|
||||||
|
conn = get_connection(module)
|
||||||
|
try:
|
||||||
|
locked = False
|
||||||
|
if lock:
|
||||||
|
conn.lock(target='running')
|
||||||
|
locked = True
|
||||||
|
response = conn.get_config(source=source, filter=filter)
|
||||||
|
|
||||||
|
except ConnectionError as e:
|
||||||
|
module.fail_json(msg=to_text(e, errors='surrogate_then_replace').strip())
|
||||||
|
|
||||||
|
finally:
|
||||||
|
if locked:
|
||||||
|
conn.unlock(target='running')
|
||||||
|
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
def get(module, filter, lock=False):
|
||||||
|
conn = get_connection(module)
|
||||||
|
try:
|
||||||
|
locked = False
|
||||||
|
if lock:
|
||||||
|
conn.lock(target='running')
|
||||||
|
locked = True
|
||||||
|
|
||||||
|
response = conn.get(filter=filter)
|
||||||
|
|
||||||
|
except ConnectionError as e:
|
||||||
|
module.fail_json(msg=to_text(e, errors='surrogate_then_replace').strip())
|
||||||
|
|
||||||
|
finally:
|
||||||
|
if locked:
|
||||||
|
conn.unlock(target='running')
|
||||||
|
|
||||||
|
return response
|
@ -0,0 +1,262 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# (c) 2018, Ansible by 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
|
||||||
|
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'network'}
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = """
|
||||||
|
---
|
||||||
|
module: netconf_get
|
||||||
|
version_added: "2.6"
|
||||||
|
author:
|
||||||
|
- "Ganesh Nalawade (@ganeshrn)"
|
||||||
|
- "Sven Wisotzky (@wisotzky)"
|
||||||
|
short_description: Fetch configuration/state data from NETCONF enabled network devices.
|
||||||
|
description:
|
||||||
|
- NETCONF is a network management protocol developed and standardized by
|
||||||
|
the IETF. It is documented in RFC 6241.
|
||||||
|
- This module allows the user to fetch configuration and state data from NETCONF
|
||||||
|
enabled network devices.
|
||||||
|
options:
|
||||||
|
source:
|
||||||
|
description:
|
||||||
|
- This argument specifies the datastore from which configuration data should be fetched.
|
||||||
|
Valid values are I(running), I(candidate) and I(startup). If the C(source) value is not
|
||||||
|
set both configuration and state information are returned in response from running datastore.
|
||||||
|
choices: ['running', 'candidate', 'startup']
|
||||||
|
filter:
|
||||||
|
description:
|
||||||
|
- This argument specifies the XML string which acts as a filter to restrict the portions of
|
||||||
|
the data to be are retrieved from the remote device. If this option is not specified entire
|
||||||
|
configuration or state data is returned in result depending on the value of C(source)
|
||||||
|
option. The C(filter) value can be either XML string or XPath, if the filter is in
|
||||||
|
XPath format the NETCONF server running on remote host should support xpath capability
|
||||||
|
else it will result in an error.
|
||||||
|
display:
|
||||||
|
description:
|
||||||
|
- Encoding scheme to use when serializing output from the device. The option I(json) will
|
||||||
|
serialize the output as JSON data. If the option value is I(json) it requires jxmlease
|
||||||
|
to be installed on control node. The option I(pretty) is similar to received XML response
|
||||||
|
but is using human readable format (spaces, new lines). The option value I(xml) is similar
|
||||||
|
to received XML response but removes all XML namespaces.
|
||||||
|
choices: ['json', 'pretty', 'xml']
|
||||||
|
lock:
|
||||||
|
description:
|
||||||
|
- Instructs the module to explicitly lock the datastore specified as C(source) before fetching
|
||||||
|
configuration and/or state information from remote host. If the value is I(never) in that case
|
||||||
|
the C(source) datastore is never locked, if the value is I(if-supported) the C(source) datastore
|
||||||
|
is locked only if the Netconf server running on remote host supports locking of that datastore,
|
||||||
|
if the lock on C(source) datastore is not supported module will report appropriate error before
|
||||||
|
executing lock. If the value is I(always) the lock operation on C(source) datastore will always
|
||||||
|
be executed irrespective if the remote host supports it or not, if it doesn't the module with
|
||||||
|
fail will the execption message received from remote host and might vary based on the platform.
|
||||||
|
default: 'never'
|
||||||
|
choices: ['never', 'always', 'if-supported']
|
||||||
|
requirements:
|
||||||
|
- ncclient (>=v0.5.2)
|
||||||
|
- jxmlease
|
||||||
|
|
||||||
|
notes:
|
||||||
|
- This module requires the NETCONF system service be enabled on
|
||||||
|
the remote device being managed.
|
||||||
|
- This module supports the use of connection=netconf
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = """
|
||||||
|
- name: Get running configuration and state data
|
||||||
|
netconf_get:
|
||||||
|
|
||||||
|
- name: Get configuration and state data from startup datastore
|
||||||
|
netconf_get:
|
||||||
|
source: startup
|
||||||
|
|
||||||
|
- name: Get system configuration data from running datastore state (junos)
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
filter: <configuration><system></system></configuration>
|
||||||
|
|
||||||
|
- name: Get configuration and state data in JSON format
|
||||||
|
netconf_get:
|
||||||
|
display: json
|
||||||
|
|
||||||
|
- name: get schema list using subtree w/ namespaces
|
||||||
|
netconf_get:
|
||||||
|
format: json
|
||||||
|
filter: <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"><schemas><schema/></schemas></netconf-state>
|
||||||
|
lock: False
|
||||||
|
|
||||||
|
- name: get schema list using xpath
|
||||||
|
netconf_get:
|
||||||
|
format: json
|
||||||
|
filter: /netconf-state/schemas/schema
|
||||||
|
|
||||||
|
- name: get interface confiugration with filter (iosxr)
|
||||||
|
netconf_get:
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
|
||||||
|
- name: Get system configuration data from running datastore state (sros)
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:conf"/>
|
||||||
|
lock: True
|
||||||
|
|
||||||
|
- name: Get state data (sros)
|
||||||
|
netconf_get:
|
||||||
|
filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:state"/>
|
||||||
|
"""
|
||||||
|
|
||||||
|
RETURN = """
|
||||||
|
stdout:
|
||||||
|
description: The raw XML string containing configuration or state data
|
||||||
|
received from the underlying ncclient library.
|
||||||
|
returned: always apart from low-level errors (such as action plugin)
|
||||||
|
type: string
|
||||||
|
sample: '...'
|
||||||
|
stdout_lines:
|
||||||
|
description: The value of stdout split into a list
|
||||||
|
returned: always apart from low-level errors (such as action plugin)
|
||||||
|
type: list
|
||||||
|
sample: ['...', '...']
|
||||||
|
output:
|
||||||
|
description: Based on the value of display option will return either the set of
|
||||||
|
transformed XML to JSON format from the RPC response with type dict
|
||||||
|
or pretty XML string response (human-readable) or response with
|
||||||
|
namespace removed from XML string.
|
||||||
|
returned: when the display format is selected as JSON it is returned as dict type, if the
|
||||||
|
display format is xml or pretty pretty it is retured as a string apart from low-level
|
||||||
|
errors (such as action plugin).
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
formatted_output:
|
||||||
|
- Contains formatted response received from remote host as per the value in display format.
|
||||||
|
"""
|
||||||
|
import sys
|
||||||
|
|
||||||
|
try:
|
||||||
|
from lxml.etree import Element, SubElement, tostring, fromstring, XMLSyntaxError
|
||||||
|
except ImportError:
|
||||||
|
from xml.etree.ElementTree import Element, SubElement, tostring, fromstring
|
||||||
|
if sys.version_info < (2, 7):
|
||||||
|
from xml.parsers.expat import ExpatError as XMLSyntaxError
|
||||||
|
else:
|
||||||
|
from xml.etree.ElementTree import ParseError as XMLSyntaxError
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.network.netconf.netconf import get_capabilities, locked_config, get_config, get
|
||||||
|
from ansible.module_utils.network.common.netconf import remove_namespaces
|
||||||
|
|
||||||
|
try:
|
||||||
|
import jxmlease
|
||||||
|
HAS_JXMLEASE = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_JXMLEASE = False
|
||||||
|
|
||||||
|
|
||||||
|
def get_filter_type(filter):
|
||||||
|
if not filter:
|
||||||
|
return None
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
fromstring(filter)
|
||||||
|
return 'subtree'
|
||||||
|
except XMLSyntaxError:
|
||||||
|
return 'xpath'
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
"""entry point for module execution
|
||||||
|
"""
|
||||||
|
argument_spec = dict(
|
||||||
|
source=dict(choices=['running', 'candidate', 'startup']),
|
||||||
|
filter=dict(),
|
||||||
|
display=dict(choices=['json', 'pretty', 'xml']),
|
||||||
|
lock=dict(default='never', choices=['never', 'always', 'if-supported'])
|
||||||
|
)
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec=argument_spec,
|
||||||
|
supports_check_mode=True)
|
||||||
|
|
||||||
|
capabilities = get_capabilities(module)
|
||||||
|
operations = capabilities['device_operations']
|
||||||
|
|
||||||
|
source = module.params['source']
|
||||||
|
filter = module.params['filter']
|
||||||
|
filter_type = get_filter_type(filter)
|
||||||
|
lock = module.params['lock']
|
||||||
|
display = module.params['display']
|
||||||
|
|
||||||
|
if source == 'candidate' and not operations.get('supports_commit', False):
|
||||||
|
module.fail_json(msg='candidate source is not supported on this device')
|
||||||
|
|
||||||
|
if source == 'startup' and not operations.get('supports_startup', False):
|
||||||
|
module.fail_json(msg='startup source is not supported on this device')
|
||||||
|
|
||||||
|
if filter_type == 'xpath' and not operations.get('supports_xpath', False):
|
||||||
|
module.fail_json(msg="filter value '%s' of type xpath is not supported on this device" % filter)
|
||||||
|
|
||||||
|
execute_lock = True if lock in ('always', 'if-supported') else False
|
||||||
|
|
||||||
|
if lock == 'always' and not operations.get('supports_lock', False):
|
||||||
|
module.fail_json(msg='lock operation is not supported on this device')
|
||||||
|
|
||||||
|
if execute_lock:
|
||||||
|
if source is None:
|
||||||
|
# if source is None, in that case operation is 'get' and `get` supports
|
||||||
|
# fetching data only from running datastore
|
||||||
|
if 'running' not in operations.get('lock_datastore', []):
|
||||||
|
# lock is not supported, don't execute lock operation
|
||||||
|
if lock == 'if-supported':
|
||||||
|
execute_lock = False
|
||||||
|
else:
|
||||||
|
module.warn("lock operation on 'running' source is not supported on this device")
|
||||||
|
else:
|
||||||
|
if source not in operations.get('lock_datastore', []):
|
||||||
|
if lock == 'if-supported':
|
||||||
|
# lock is not supported, don't execute lock operation
|
||||||
|
execute_lock = False
|
||||||
|
else:
|
||||||
|
module.warn("lock operation on '%s' source is not supported on this device" % source)
|
||||||
|
|
||||||
|
if display == 'json' and not HAS_JXMLEASE:
|
||||||
|
module.fail_json(msg='jxmlease is required to display response in json format'
|
||||||
|
'but does not appear to be installed. '
|
||||||
|
'It can be installed using `pip install jxmlease`')
|
||||||
|
|
||||||
|
filter_spec = (filter_type, filter) if filter_type else None
|
||||||
|
|
||||||
|
if source is not None:
|
||||||
|
response = get_config(module, source, filter_spec, execute_lock)
|
||||||
|
else:
|
||||||
|
response = get(module, filter_spec, execute_lock)
|
||||||
|
|
||||||
|
xml_resp = tostring(response)
|
||||||
|
output = None
|
||||||
|
|
||||||
|
if display == 'xml':
|
||||||
|
output = remove_namespaces(xml_resp)
|
||||||
|
elif display == 'json':
|
||||||
|
try:
|
||||||
|
output = jxmlease.parse(xml_resp)
|
||||||
|
except:
|
||||||
|
raise ValueError(xml_resp)
|
||||||
|
elif display == 'pretty':
|
||||||
|
output = tostring(response, pretty_print=True)
|
||||||
|
|
||||||
|
result = {
|
||||||
|
'stdout': xml_resp,
|
||||||
|
'output': output
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
@ -0,0 +1,2 @@
|
|||||||
|
---
|
||||||
|
testcase: "*"
|
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
dependencies:
|
||||||
|
- { role: prepare_junos_tests, when: ansible_network_os == 'junos' }
|
||||||
|
- { role: prepare_iosxr_tests, when: ansible_network_os == 'iosxr' }
|
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
- name: collect all netconf test cases
|
||||||
|
find:
|
||||||
|
paths: "{{ role_path }}/tests/iosxr"
|
||||||
|
patterns: "{{ testcase }}.yaml"
|
||||||
|
register: test_cases
|
||||||
|
connection: local
|
||||||
|
|
||||||
|
- name: set test_items
|
||||||
|
set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
|
||||||
|
|
||||||
|
- name: run test case (connection=netconf)
|
||||||
|
include: "{{ test_case_to_run }}"
|
||||||
|
with_items: "{{ test_items }}"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_case_to_run
|
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
- name: collect all netconf test cases
|
||||||
|
find:
|
||||||
|
paths: "{{ role_path }}/tests/junos"
|
||||||
|
patterns: "{{ testcase }}.yaml"
|
||||||
|
register: test_cases
|
||||||
|
connection: local
|
||||||
|
|
||||||
|
- name: set test_items
|
||||||
|
set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
|
||||||
|
|
||||||
|
- name: run test case (connection=netconf)
|
||||||
|
include: "{{ test_case_to_run }} ansible_connection=netconf"
|
||||||
|
with_items: "{{ test_items }}"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_case_to_run
|
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
- { include: junos.yaml, when: ansible_network_os == 'junos', tags: ['netconf'] }
|
||||||
|
- { include: iosxr.yaml, when: ansible_network_os == 'iosxr', tags: ['netconf'] }
|
@ -0,0 +1,163 @@
|
|||||||
|
---
|
||||||
|
- debug: msg="START netconf_get iosxr/basic.yaml on connection={{ ansible_connection }}"
|
||||||
|
|
||||||
|
- name: setup interface
|
||||||
|
iosxr_config:
|
||||||
|
commands:
|
||||||
|
- description this is test interface Loopback999
|
||||||
|
- no shutdown
|
||||||
|
parents:
|
||||||
|
- interface Loopback999
|
||||||
|
match: none
|
||||||
|
connection: network_cli
|
||||||
|
|
||||||
|
- name: get running interface confiugration with filter
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<description>this is test interface Loopback999</description>' in result.stdout"
|
||||||
|
- "'<usernames>' not in result.stdout"
|
||||||
|
|
||||||
|
- name: test lock=never, get-config, running interface confiugration with filter without lock
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
lock: never
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<description>this is test interface Loopback999</description>' in result.stdout"
|
||||||
|
- "'<usernames>' not in result.stdout"
|
||||||
|
|
||||||
|
- name: test lock=if-supported, get-config, running interface confiugration with filter without lock
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
lock: if-supported
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<description>this is test interface Loopback999</description>' in result.stdout"
|
||||||
|
- "'<usernames>' not in result.stdout"
|
||||||
|
|
||||||
|
- name: Failure scenario, get-config information with lock
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
lock: always
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<bad-element>running</bad-element>' in result.msg"
|
||||||
|
|
||||||
|
- name: Failure scenario, fetch config from startup
|
||||||
|
netconf_get:
|
||||||
|
source: startup
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'startup source is not supported' in result.msg"
|
||||||
|
|
||||||
|
- name: test get, information from running datastore without lock
|
||||||
|
netconf_get:
|
||||||
|
lock: never
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<description>this is test interface Loopback999</description>' in result.stdout"
|
||||||
|
|
||||||
|
- name: test get, information from running datastore with lock if supported
|
||||||
|
netconf_get:
|
||||||
|
lock: if-supported
|
||||||
|
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<description>this is test interface Loopback999</description>' in result.stdout"
|
||||||
|
|
||||||
|
- name: Failure scenario, get information from running with lock
|
||||||
|
netconf_get:
|
||||||
|
lock: always
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<bad-element>running</bad-element>' in result.msg"
|
||||||
|
|
||||||
|
- name: get configuration and state data in json format
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: json
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output']['rpc-reply']['data']['aaa'] is defined}}"
|
||||||
|
|
||||||
|
- name: get configuration data in xml pretty format
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: pretty
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output'] is defined}}"
|
||||||
|
|
||||||
|
- name: get configuration data in xml with namespace stripped
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: xml
|
||||||
|
register: result
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output'] is defined}}"
|
||||||
|
- "{{ 'xmlns' not in result.output }}"
|
||||||
|
|
||||||
|
- name: Failure scenario, unsupported filter
|
||||||
|
netconf_get:
|
||||||
|
filter: configuration/state
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
connection: netconf
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'filter value \\'configuration/state\\' of type xpath is not supported' in result.msg"
|
||||||
|
|
||||||
|
- name: setup - teardown
|
||||||
|
iosxr_config:
|
||||||
|
commands:
|
||||||
|
- no description
|
||||||
|
- shutdown
|
||||||
|
parents:
|
||||||
|
- interface Loopback999
|
||||||
|
match: none
|
||||||
|
connection: network_cli
|
||||||
|
|
||||||
|
- debug: msg="END netconf_get iosxr/basic.yaml on connection={{ ansible_connection }}"
|
@ -0,0 +1,126 @@
|
|||||||
|
---
|
||||||
|
- debug: msg="START netconf_get junos/basic.yaml on connection={{ ansible_connection }}"
|
||||||
|
|
||||||
|
- name: Configure syslog file - setup
|
||||||
|
junos_config:
|
||||||
|
lines:
|
||||||
|
- set system syslog file test1 any any
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Get system configuration data from running datastore state
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
filter: <configuration><system><syslog></syslog></system></configuration>
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<name>test1</name>' in result.stdout"
|
||||||
|
- "'<name>any</name>' in result.stdout"
|
||||||
|
- "'<any/>' in result.stdout"
|
||||||
|
- "'<login>' not in result.stdout"
|
||||||
|
- "'<interface>' not in result.stdout"
|
||||||
|
|
||||||
|
- name: Failure scenario, fetch config from startup
|
||||||
|
netconf_get:
|
||||||
|
source: startup
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'startup source is not supported' in result.msg"
|
||||||
|
|
||||||
|
- name: Failure scenario, fetch config from running with lock
|
||||||
|
netconf_get:
|
||||||
|
lock: always
|
||||||
|
source: running
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'syntax error' in result.msg"
|
||||||
|
|
||||||
|
- name: Get system configuration data from running datastore state and lock if-supported
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
filter: <configuration><system><syslog></syslog></system></configuration>
|
||||||
|
lock: if-supported
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<name>test1</name>' in result.stdout"
|
||||||
|
- "'<name>any</name>' in result.stdout"
|
||||||
|
- "'<any/>' in result.stdout"
|
||||||
|
- "'<login>' not in result.stdout"
|
||||||
|
- "'<interface>' not in result.stdout"
|
||||||
|
|
||||||
|
- name: get configuration and state data in json format
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: json
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output']['rpc-reply']['data']['configuration'] is defined}}"
|
||||||
|
|
||||||
|
- name: get configuration and state data in xml pretty format
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: pretty
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output'] is defined}}"
|
||||||
|
|
||||||
|
- name: get configuration data in xml with namespace stripped
|
||||||
|
netconf_get:
|
||||||
|
source: running
|
||||||
|
display: xml
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "{{ result['output'] is defined}}"
|
||||||
|
- "{{ 'xmlns' not in result.output }}"
|
||||||
|
|
||||||
|
- name: get configuration and state data without datastore lock
|
||||||
|
netconf_get:
|
||||||
|
lock: never
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<database-status-information>' in result.stdout"
|
||||||
|
- "'</configuration>' in result.stdout"
|
||||||
|
|
||||||
|
- name: get configuration and state data and lock data-store if supported
|
||||||
|
netconf_get:
|
||||||
|
lock: if-supported
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'<database-status-information>' in result.stdout"
|
||||||
|
- "'</configuration>' in result.stdout"
|
||||||
|
|
||||||
|
- name: Failure scenario, unsupported filter
|
||||||
|
netconf_get:
|
||||||
|
filter: configuration/state
|
||||||
|
register: result
|
||||||
|
ignore_errors: True
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- "'filter value \\'configuration/state\\' of type xpath is not supported' in result.msg"
|
||||||
|
|
||||||
|
- name: Configure syslog file - teardown
|
||||||
|
junos_config:
|
||||||
|
lines:
|
||||||
|
- delete system syslog file test1 any any
|
||||||
|
|
||||||
|
- debug: msg="END netconf_get junos/basic.yaml on connection={{ ansible_connection }}"
|
Loading…
Reference in New Issue