New module: routeros_facts – collect facts from RouterOS devices (#46114)

* feat(routeros): implement routeros_facts module

* fix(routeros): review by felixfontein

* fix(routeros): review by ganeshrn

* fix(routeros): review by felixfontein
This commit is contained in:
Egor Zaitsev
2018-10-02 11:14:23 +03:00
committed by Ganesh Nalawade
parent 411397a975
commit 6df1f6b203
10 changed files with 630 additions and 0 deletions

View File

@@ -0,0 +1,26 @@
# sep/25/2018 10:10:52 by RouterOS 6.42.5
# software id = 9EER-511K
#
#
#
/interface wireless security-profiles
set [ find default=yes ] supplicant-identity=MikroTik
/tool user-manager customer
set admin access=own-routers,own-users,own-profiles,own-limits,config-payment-gw
/ip address
add address=192.168.88.1/24 comment=defconf interface=ether1 network=192.168.88.0
/ip dhcp-client
add dhcp-options=hostname,clientid disabled=no interface=ether1
/system lcd
set contrast=0 enabled=no port=parallel type=24x4
/system lcd page
set time disabled=yes display-time=5s
set resources disabled=yes display-time=5s
set uptime disabled=yes display-time=5s
set packets disabled=yes display-time=5s
set bits disabled=yes display-time=5s
set version disabled=yes display-time=5s
set identity disabled=yes display-time=5s
set ether1 disabled=yes display-time=5s
/tool user-manager database
set db-path=user-manager

View File

@@ -0,0 +1,7 @@
Flags: D - dynamic, X - disabled, R - running, S - slave
0 R name="ether1" default-name="ether1" type="ether" mtu=1500 actual-mtu=1500
mac-address=00:1C:42:36:52:90 last-link-up-time=sep/25/2018 06:30:04
link-downs=0
1 R name="ether2" default-name="ether2" type="ether" mtu=1500 actual-mtu=1500
mac-address=00:1C:42:36:52:90 last-link-up-time=sep/25/2018 06:30:04
link-downs=0

View File

@@ -0,0 +1,7 @@
Flags: X - disabled, I - invalid, D - dynamic
0 ;;; defconf
address=192.168.88.1/24 network=192.168.88.0 interface=ether1
actual-interface=ether1
1 D address=10.37.129.3/24 network=10.37.129.0 interface=ether1
actual-interface=ether1

View File

@@ -0,0 +1,15 @@
0 interface=ether2-master address=10.37.129.3 address4=10.37.129.3 mac-address=D4:CA:6D:C6:16:4C identity="router1" platform="MikroTik" version="6.42.2 (stable)" unpack=none age=59s
uptime=3w19h11m36s software-id="1234-1234" board="RBwAPG-5HacT2HnD" interface-name="bridge" system-description="MikroTik RouterOS 6.42.2 (stable) RBwAPG-5HacT2HnD"
system-caps="" system-caps-enabled=""
1 interface=ether3 address=10.37.129.4 address4=10.37.129.4 mac-address=D4:CA:6D:C6:18:2F identity="router2" platform="MikroTik" version="6.42.2 (stable)" unpack=none age=54s
uptime=3w19h11m30s software-id="1234-1234" board="RBwAPG-5HacT2HnD" ipv6=no interface-name="bridge" system-description="MikroTik RouterOS 6.42.2 (stable) RBwAPG-5HacT2HnD"
system-caps="" system-caps-enabled=""
2 interface=ether5 address=10.37.129.5 address4=10.37.129.5 mac-address=B8:69:F4:37:F0:C8 identity="router3" platform="MikroTik" version="6.40.8 (bugfix)" unpack=none age=43s
uptime=3d14h25m31s software-id="1234-1234" board="RB960PGS" interface-name="ether1" system-description="MikroTik RouterOS 6.40.8 (bugfix) RB960PGS" system-caps=""
system-caps-enabled=""
3 interface=ether10 address=10.37.129.6 address4=10.37.129.6 mac-address=6C:3B:6B:A1:0B:63 identity="router4" platform="MikroTik" version="6.42.2 (stable)" unpack=none age=54s
uptime=3w6d1h11m44s software-id="1234-1234" board="RBSXTLTE3-7" interface-name="bridge" system-description="MikroTik RouterOS 6.42.2 (stable) RBSXTLTE3-7" system-caps=""
system-caps-enabled=""

View File

@@ -0,0 +1,3 @@
Flags: X - disabled, I - invalid, D - dynamic, G - global, L - link-local
0 DL address=fe80::21c:42ff:fe36:5290/64 from-pool="" interface=ether1
actual-interface=ether1 eui-64=no advertise=no no-dad=no

View File

@@ -0,0 +1,16 @@
uptime: 3h28m52s
version: 6.42.5 (stable)
build-time: Jun/26/2018 12:12:08
free-memory: 988.3MiB
total-memory: 1010.8MiB
cpu: Intel(R)
cpu-count: 2
cpu-frequency: 2496MHz
cpu-load: 0%
free-hdd-space: 63.4GiB
total-hdd-space: 63.5GiB
write-sect-since-reboot: 4576
write-sect-total: 4576
architecture-name: x86
board-name: x86
platform: MikroTik

View File

@@ -0,0 +1,7 @@
routerboard: yes
model: RouterBOARD 3011UiAS
serial-number: 1234567890
firmware-type: ipq8060
factory-firmware: 3.41
current-firmware: 3.41
upgrade-firmware: 6.42.2

View File

@@ -0,0 +1,113 @@
# 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/>.
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible.compat.tests.mock import patch
from ansible.modules.network.routeros import routeros_facts
from units.modules.utils import set_module_args
from .routeros_module import TestRouterosModule, load_fixture
class TestRouterosFactsModule(TestRouterosModule):
module = routeros_facts
def setUp(self):
super(TestRouterosFactsModule, self).setUp()
self.mock_run_commands = patch('ansible.modules.network.routeros.routeros_facts.run_commands')
self.run_commands = self.mock_run_commands.start()
def tearDown(self):
super(TestRouterosFactsModule, self).tearDown()
self.mock_run_commands.stop()
def load_fixtures(self, commands=None):
def load_from_file(*args, **kwargs):
module = args
commands = kwargs['commands']
output = list()
for command in commands:
filename = str(command).split(' | ')[0].replace(' ', '_')
output.append(load_fixture('routeros_facts%s' % filename))
return output
self.run_commands.side_effect = load_from_file
def test_routeros_facts_default(self):
set_module_args(dict(gather_subset='default'))
result = self.execute_module()
self.assertEqual(
result['ansible_facts']['ansible_net_hostname'], 'MikroTik'
)
self.assertEqual(
result['ansible_facts']['ansible_net_version'], '6.42.5 (stable)'
)
self.assertEqual(
result['ansible_facts']['ansible_net_model'], 'RouterBOARD 3011UiAS'
)
self.assertEqual(
result['ansible_facts']['ansible_net_serialnum'], '1234567890'
)
def test_routeros_facts_hardware(self):
set_module_args(dict(gather_subset='hardware'))
result = self.execute_module()
self.assertEqual(
result['ansible_facts']['ansible_net_spacefree_mb'], 64921.6
)
self.assertEqual(
result['ansible_facts']['ansible_net_spacetotal_mb'], 65024.0
)
self.assertEqual(
result['ansible_facts']['ansible_net_memfree_mb'], 988.3
)
self.assertEqual(
result['ansible_facts']['ansible_net_memtotal_mb'], 1010.8
)
def test_routeros_facts_config(self):
set_module_args(dict(gather_subset='config'))
result = self.execute_module()
self.assertIsInstance(
result['ansible_facts']['ansible_net_config'], str
)
def test_routeros_facts_interfaces(self):
set_module_args(dict(gather_subset='interfaces'))
result = self.execute_module()
self.assertEqual(
result['ansible_facts']['ansible_net_all_ipv4_addresses'][0], '10.37.129.3'
)
self.assertEqual(
result['ansible_facts']['ansible_net_all_ipv4_addresses'][0],
result['ansible_facts']['ansible_net_interfaces']['ether1']['ipv4'][0]['address']
)
self.assertEqual(
result['ansible_facts']['ansible_net_all_ipv6_addresses'], ['fe80::21c:42ff:fe36:5290']
)
self.assertEqual(
result['ansible_facts']['ansible_net_all_ipv6_addresses'][0],
result['ansible_facts']['ansible_net_interfaces']['ether1']['ipv6'][0]['address']
)
self.assertEqual(
len(result['ansible_facts']['ansible_net_interfaces'].keys()), 2
)
self.assertEqual(
len(result['ansible_facts']['ansible_net_neighbors'].keys()), 4
)