mirror of https://github.com/ansible/ansible.git
Add nso_show module for Cisco NSO (#34142)
* update version parsing and move requirements to nso_* modules prepare for introduction of nso_show module that has other version requirements than the existing nso_* modules. * Add nso_show module for retreiving config from Cisco NSO New module that supports getting configuration and operational data from Cisco NSO.pull/34186/head
parent
0f32f01644
commit
d6fd9703f1
@ -0,0 +1,129 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2017 Cisco and/or its affiliates.
|
||||
#
|
||||
# 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
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: nso_show
|
||||
extends_documentation_fragment: nso
|
||||
short_description: Displays data from Cisco NSO.
|
||||
description:
|
||||
- This module provides support for displaying data from Cisco NSO.
|
||||
requirements:
|
||||
- Cisco NSO version 3.4.12 or higher, 4.1.9 or higher, 4.2.6 or higher,
|
||||
4.3.7 or higher, 4.4.5 or higher, 4.5 or higher.
|
||||
author: "Claes Nästén (@cnasten)"
|
||||
options:
|
||||
path:
|
||||
description: Path to NSO data.
|
||||
required: true
|
||||
operational:
|
||||
description: >
|
||||
Controls wheter or not operational data is included in the result.
|
||||
version_added: "2.5"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Show devices including operational data
|
||||
nso_show:
|
||||
url: http://localhost:8080/jsonrpc
|
||||
username: username
|
||||
password: password
|
||||
path: /ncs:devices/device
|
||||
operational: true
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
output:
|
||||
description: Configuration
|
||||
returned: success
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible.module_utils.network.nso.nso import connect, verify_version, nso_argument_spec
|
||||
from ansible.module_utils.network.nso.nso import ModuleFailException, NsoException
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
class NsoShow(object):
|
||||
REQUIRED_VERSIONS = [
|
||||
(4, 5),
|
||||
(4, 4, 5),
|
||||
(4, 3, 7),
|
||||
(4, 2, 6),
|
||||
(4, 1, 9),
|
||||
(3, 4, 12)
|
||||
]
|
||||
|
||||
def __init__(self, check_mode, client, path, operational):
|
||||
self._check_mode = check_mode
|
||||
self._client = client
|
||||
self._path = path
|
||||
self._operational = operational
|
||||
|
||||
def main(self):
|
||||
if self._check_mode:
|
||||
return {}
|
||||
else:
|
||||
return self._client.show_config(self._path, self._operational)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = dict(
|
||||
path=dict(required=True, type='str'),
|
||||
operational=dict(required=False, type='bool', default=False)
|
||||
)
|
||||
argument_spec.update(nso_argument_spec)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
p = module.params
|
||||
|
||||
client = connect(p)
|
||||
nso_show = NsoShow(
|
||||
module.check_mode, client,
|
||||
p['path'], p['operational'])
|
||||
try:
|
||||
verify_version(client, NsoShow.REQUIRED_VERSIONS)
|
||||
|
||||
output = nso_show.main()
|
||||
client.logout()
|
||||
module.exit_json(changed=False, output=output)
|
||||
except NsoException as ex:
|
||||
client.logout()
|
||||
module.fail_json(msg=ex.message)
|
||||
except ModuleFailException as ex:
|
||||
client.logout()
|
||||
module.fail_json(msg=ex.message)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
@ -0,0 +1,96 @@
|
||||
#
|
||||
# Copyright (c) 2017 Cisco and/or its affiliates.
|
||||
#
|
||||
# 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)
|
||||
|
||||
import json
|
||||
|
||||
from ansible.compat.tests.mock import patch
|
||||
from ansible.modules.network.nso import nso_show
|
||||
from . import nso_module
|
||||
from .nso_module import MockResponse
|
||||
|
||||
|
||||
class TestNsoShow(nso_module.TestNsoModule):
|
||||
module = nso_show
|
||||
|
||||
@patch('ansible.module_utils.network.nso.nso.open_url')
|
||||
def test_nso_show_missing(self, open_url_mock):
|
||||
path = '/ncs:devices/device{ce0}/missing'
|
||||
calls = [
|
||||
MockResponse('login', {}, 200, '{}', {'set-cookie': 'id'}),
|
||||
MockResponse('get_system_setting', {'operation': 'version'}, 200, '{"result": "4.5"}'),
|
||||
MockResponse('new_trans', {'mode': 'read'}, 200, '{"result": {"th": 1}}'),
|
||||
MockResponse('show_config',
|
||||
{'path': path, 'result_as': 'json'}, 200,
|
||||
'{"error": {"data": {"param": "path"}, "type": "rpc.method.invalid_params"}}'),
|
||||
MockResponse('logout', {}, 200, '{"result": {}}'),
|
||||
]
|
||||
open_url_mock.side_effect = lambda *args, **kwargs: nso_module.mock_call(calls, *args, **kwargs)
|
||||
|
||||
nso_module.set_module_args({
|
||||
'username': 'user', 'password': 'password',
|
||||
'url': 'http://localhost:8080/jsonrpc',
|
||||
'path': path
|
||||
})
|
||||
self.execute_module(failed=True, msg='NSO show_config invalid params. path = /ncs:devices/device{ce0}/missing')
|
||||
|
||||
self.assertEqual(0, len(calls))
|
||||
|
||||
@patch('ansible.module_utils.network.nso.nso.open_url')
|
||||
def test_nso_show_config(self, open_url_mock):
|
||||
path = '/ncs:devices/device{ce0}'
|
||||
calls = [
|
||||
MockResponse('login', {}, 200, '{}', {'set-cookie': 'id'}),
|
||||
MockResponse('get_system_setting', {'operation': 'version'}, 200, '{"result": "4.5"}'),
|
||||
MockResponse('new_trans', {'mode': 'read'}, 200, '{"result": {"th": 1}}'),
|
||||
MockResponse('show_config', {'path': path, 'result_as': 'json'}, 200, '{"result": {"data": {}}}'),
|
||||
MockResponse('logout', {}, 200, '{"result": {}}'),
|
||||
]
|
||||
open_url_mock.side_effect = lambda *args, **kwargs: nso_module.mock_call(calls, *args, **kwargs)
|
||||
|
||||
nso_module.set_module_args({
|
||||
'username': 'user', 'password': 'password',
|
||||
'url': 'http://localhost:8080/jsonrpc',
|
||||
'path': path,
|
||||
'operational': False
|
||||
})
|
||||
self.execute_module(changed=False, output={"data": {}})
|
||||
self.assertEqual(0, len(calls))
|
||||
|
||||
@patch('ansible.module_utils.network.nso.nso.open_url')
|
||||
def test_nso_show_config_and_oper(self, open_url_mock):
|
||||
path = '/ncs:devices/device{ce0}/sync-from'
|
||||
calls = [
|
||||
MockResponse('login', {}, 200, '{}', {'set-cookie': 'id'}),
|
||||
MockResponse('get_system_setting', {'operation': 'version'}, 200, '{"result": "4.5"}'),
|
||||
MockResponse('new_trans', {'mode': 'read'}, 200, '{"result": {"th": 1}}'),
|
||||
MockResponse('show_config', {'path': path, 'result_as': 'json'}, 200, '{"result": {"data": {}}}'),
|
||||
MockResponse('logout', {}, 200, '{"result": {}}'),
|
||||
]
|
||||
open_url_mock.side_effect = lambda *args, **kwargs: nso_module.mock_call(calls, *args, **kwargs)
|
||||
|
||||
nso_module.set_module_args({
|
||||
'username': 'user', 'password': 'password',
|
||||
'url': 'http://localhost:8080/jsonrpc',
|
||||
'path': path,
|
||||
'operational': True
|
||||
})
|
||||
self.execute_module(changed=False, output={"data": {}})
|
||||
|
||||
self.assertEqual(0, len(calls))
|
Loading…
Reference in New Issue