mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
436 lines
13 KiB
Python
436 lines
13 KiB
Python
#!/usr/bin/python
|
|
|
|
# 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': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: routeros_facts
|
|
author: "Egor Zaitsev (@heuels)"
|
|
short_description: Collect facts from remote devices running MikroTik RouterOS
|
|
description:
|
|
- Collects a base set of device facts from a remote device that
|
|
is running RotuerOS. This module prepends all of the
|
|
base network fact keys with C(ansible_net_<fact>). The facts
|
|
module will always collect a base set of facts from the device
|
|
and can enable or disable collection of additional facts.
|
|
options:
|
|
gather_subset:
|
|
description:
|
|
- When supplied, this argument will restrict the facts collected
|
|
to a given subset. Possible values for this argument include
|
|
C(all), C(hardware), C(config), and C(interfaces). Can specify a list of
|
|
values to include a larger subset. Values can also be used
|
|
with an initial C(!) to specify that a specific subset should
|
|
not be collected.
|
|
required: false
|
|
default: '!config'
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
# Collect all facts from the device
|
|
- routeros_facts:
|
|
gather_subset: all
|
|
|
|
# Collect only the config and default facts
|
|
- routeros_facts:
|
|
gather_subset:
|
|
- config
|
|
|
|
# Do not collect hardware facts
|
|
- routeros_facts:
|
|
gather_subset:
|
|
- "!hardware"
|
|
"""
|
|
|
|
RETURN = """
|
|
ansible_net_gather_subset:
|
|
description: The list of fact subsets collected from the device
|
|
returned: always
|
|
type: list
|
|
|
|
# default
|
|
ansible_net_model:
|
|
description: The model name returned from the device
|
|
returned: always
|
|
type: str
|
|
ansible_net_serialnum:
|
|
description: The serial number of the remote device
|
|
returned: always
|
|
type: str
|
|
ansible_net_version:
|
|
description: The operating system version running on the remote device
|
|
returned: always
|
|
type: str
|
|
ansible_net_hostname:
|
|
description: The configured hostname of the device
|
|
returned: always
|
|
type: str
|
|
|
|
# hardware
|
|
ansible_net_spacefree_mb:
|
|
description: The available disk space on the remote device in MiB
|
|
returned: when hardware is configured
|
|
type: dict
|
|
ansible_net_spacetotal_mb:
|
|
description: The total disk space on the remote device in MiB
|
|
returned: when hardware is configured
|
|
type: dict
|
|
ansible_net_memfree_mb:
|
|
description: The available free memory on the remote device in MiB
|
|
returned: when hardware is configured
|
|
type: int
|
|
ansible_net_memtotal_mb:
|
|
description: The total memory on the remote device in MiB
|
|
returned: when hardware is configured
|
|
type: int
|
|
|
|
# config
|
|
ansible_net_config:
|
|
description: The current active config from the device
|
|
returned: when config is configured
|
|
type: str
|
|
|
|
# interfaces
|
|
ansible_net_all_ipv4_addresses:
|
|
description: All IPv4 addresses configured on the device
|
|
returned: when interfaces is configured
|
|
type: list
|
|
ansible_net_all_ipv6_addresses:
|
|
description: All IPv6 addresses configured on the device
|
|
returned: when interfaces is configured
|
|
type: list
|
|
ansible_net_interfaces:
|
|
description: A hash of all interfaces running on the system
|
|
returned: when interfaces is configured
|
|
type: dict
|
|
ansible_net_neighbors:
|
|
description: The list of neighbors from the remote device
|
|
returned: when interfaces is configured
|
|
type: dict
|
|
"""
|
|
import re
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.network.routeros.routeros import run_commands
|
|
from ansible_collections.community.general.plugins.module_utils.network.routeros.routeros import routeros_argument_spec
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.six import iteritems
|
|
|
|
|
|
class FactsBase(object):
|
|
|
|
COMMANDS = list()
|
|
|
|
def __init__(self, module):
|
|
self.module = module
|
|
self.facts = dict()
|
|
self.responses = None
|
|
|
|
def populate(self):
|
|
self.responses = run_commands(self.module, commands=self.COMMANDS, check_rc=False)
|
|
|
|
def run(self, cmd):
|
|
return run_commands(self.module, commands=cmd, check_rc=False)
|
|
|
|
|
|
class Default(FactsBase):
|
|
|
|
COMMANDS = [
|
|
'/system identity print without-paging',
|
|
'/system resource print without-paging',
|
|
'/system routerboard print without-paging'
|
|
]
|
|
|
|
def populate(self):
|
|
super(Default, self).populate()
|
|
data = self.responses[0]
|
|
if data:
|
|
self.facts['hostname'] = self.parse_hostname(data)
|
|
|
|
data = self.responses[1]
|
|
if data:
|
|
self.facts['version'] = self.parse_version(data)
|
|
|
|
data = self.responses[2]
|
|
if data:
|
|
self.facts['model'] = self.parse_model(data)
|
|
self.facts['serialnum'] = self.parse_serialnum(data)
|
|
|
|
def parse_hostname(self, data):
|
|
match = re.search(r'name:\s(.*)\s*$', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
def parse_version(self, data):
|
|
match = re.search(r'version:\s(.*)\s*$', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
def parse_model(self, data):
|
|
match = re.search(r'model:\s(.*)\s*$', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
def parse_serialnum(self, data):
|
|
match = re.search(r'serial-number:\s(.*)\s*$', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
|
|
class Hardware(FactsBase):
|
|
|
|
COMMANDS = [
|
|
'/system resource print without-paging'
|
|
]
|
|
|
|
def populate(self):
|
|
super(Hardware, self).populate()
|
|
data = self.responses[0]
|
|
if data:
|
|
self.parse_filesystem_info(data)
|
|
self.parse_memory_info(data)
|
|
|
|
def parse_filesystem_info(self, data):
|
|
match = re.search(r'free-hdd-space:\s(.*)([KMG]iB)', data, re.M)
|
|
if match:
|
|
self.facts['spacefree_mb'] = self.to_megabytes(match)
|
|
match = re.search(r'total-hdd-space:\s(.*)([KMG]iB)', data, re.M)
|
|
if match:
|
|
self.facts['spacetotal_mb'] = self.to_megabytes(match)
|
|
|
|
def parse_memory_info(self, data):
|
|
match = re.search(r'free-memory:\s(\d+\.?\d*)([KMG]iB)', data, re.M)
|
|
if match:
|
|
self.facts['memfree_mb'] = self.to_megabytes(match)
|
|
match = re.search(r'total-memory:\s(\d+\.?\d*)([KMG]iB)', data, re.M)
|
|
if match:
|
|
self.facts['memtotal_mb'] = self.to_megabytes(match)
|
|
|
|
def to_megabytes(self, data):
|
|
if data.group(2) == 'KiB':
|
|
return float(data.group(1)) / 1024
|
|
elif data.group(2) == 'MiB':
|
|
return float(data.group(1))
|
|
elif data.group(2) == 'GiB':
|
|
return float(data.group(1)) * 1024
|
|
else:
|
|
return None
|
|
|
|
|
|
class Config(FactsBase):
|
|
|
|
COMMANDS = ['/export']
|
|
|
|
def populate(self):
|
|
super(Config, self).populate()
|
|
data = self.responses[0]
|
|
if data:
|
|
self.facts['config'] = data
|
|
|
|
|
|
class Interfaces(FactsBase):
|
|
|
|
COMMANDS = [
|
|
'/interface print detail without-paging',
|
|
'/ip address print detail without-paging',
|
|
'/ipv6 address print detail without-paging',
|
|
'/ip neighbor print detail without-paging'
|
|
]
|
|
|
|
DETAIL_RE = re.compile(r'([\w\d\-]+)=\"?(\w{3}/\d{2}/\d{4}\s\d{2}:\d{2}:\d{2}|[\w\d\-\.:/]+)')
|
|
WRAPPED_LINE_RE = re.compile(r'^\s+(?!\d)')
|
|
|
|
def populate(self):
|
|
super(Interfaces, self).populate()
|
|
|
|
self.facts['interfaces'] = dict()
|
|
self.facts['all_ipv4_addresses'] = list()
|
|
self.facts['all_ipv6_addresses'] = list()
|
|
self.facts['neighbors'] = dict()
|
|
|
|
data = self.responses[0]
|
|
if data:
|
|
interfaces = self.parse_interfaces(data)
|
|
self.populate_interfaces(interfaces)
|
|
|
|
data = self.responses[1]
|
|
if data:
|
|
data = self.parse_addresses(data)
|
|
self.populate_ipv4_interfaces(data)
|
|
|
|
data = self.responses[2]
|
|
if data:
|
|
data = self.parse_addresses(data)
|
|
self.populate_ipv6_interfaces(data)
|
|
|
|
data = self.responses[3]
|
|
if data:
|
|
self.facts['neighbors'] = self.parse_neighbors(data)
|
|
|
|
def populate_interfaces(self, data):
|
|
for key, value in iteritems(data):
|
|
self.facts['interfaces'][key] = value
|
|
|
|
def populate_ipv4_interfaces(self, data):
|
|
for key, value in iteritems(data):
|
|
if 'ipv4' not in self.facts['interfaces'][key]:
|
|
self.facts['interfaces'][key]['ipv4'] = list()
|
|
addr, subnet = value['address'].split("/")
|
|
ipv4 = dict(address=addr.strip(), subnet=subnet.strip())
|
|
self.add_ip_address(addr.strip(), 'ipv4')
|
|
self.facts['interfaces'][key]['ipv4'].append(ipv4)
|
|
|
|
def populate_ipv6_interfaces(self, data):
|
|
for key, value in iteritems(data):
|
|
if key is None:
|
|
break
|
|
if 'ipv6' not in self.facts['interfaces'][key]:
|
|
self.facts['interfaces'][key]['ipv6'] = list()
|
|
addr, subnet = value['address'].split("/")
|
|
ipv6 = dict(address=addr.strip(), subnet=subnet.strip())
|
|
self.add_ip_address(addr.strip(), 'ipv6')
|
|
self.facts['interfaces'][key]['ipv6'].append(ipv6)
|
|
|
|
def add_ip_address(self, address, family):
|
|
if family == 'ipv4':
|
|
self.facts['all_ipv4_addresses'].append(address)
|
|
else:
|
|
self.facts['all_ipv6_addresses'].append(address)
|
|
|
|
def preprocess(self, data):
|
|
preprocessed = list()
|
|
for line in data.split('\n'):
|
|
if len(line) == 0 or line[:5] == 'Flags':
|
|
continue
|
|
elif not re.match(self.WRAPPED_LINE_RE, line):
|
|
preprocessed.append(line)
|
|
else:
|
|
preprocessed[-1] += line
|
|
return preprocessed
|
|
|
|
def parse_interfaces(self, data):
|
|
facts = dict()
|
|
data = self.preprocess(data)
|
|
for line in data:
|
|
name = self.parse_name(line)
|
|
facts[name] = dict()
|
|
for (key, value) in re.findall(self.DETAIL_RE, line):
|
|
facts[name][key] = value
|
|
return facts
|
|
|
|
def parse_addresses(self, data):
|
|
facts = dict()
|
|
data = self.preprocess(data)
|
|
for line in data:
|
|
name = self.parse_interface(line)
|
|
facts[name] = dict()
|
|
for (key, value) in re.findall(self.DETAIL_RE, line):
|
|
facts[name][key] = value
|
|
return facts
|
|
|
|
def parse_neighbors(self, data):
|
|
facts = dict()
|
|
data = self.preprocess(data)
|
|
for line in data:
|
|
name = self.parse_interface(line)
|
|
facts[name] = dict()
|
|
for (key, value) in re.findall(self.DETAIL_RE, line):
|
|
facts[name][key] = value
|
|
return facts
|
|
|
|
def parse_name(self, data):
|
|
match = re.search(r'name=\"([\w\d\-]+)\"', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
def parse_interface(self, data):
|
|
match = re.search(r'interface=([\w\d\-]+)', data, re.M)
|
|
if match:
|
|
return match.group(1)
|
|
|
|
|
|
FACT_SUBSETS = dict(
|
|
default=Default,
|
|
hardware=Hardware,
|
|
interfaces=Interfaces,
|
|
config=Config,
|
|
)
|
|
|
|
VALID_SUBSETS = frozenset(FACT_SUBSETS.keys())
|
|
|
|
warnings = list()
|
|
|
|
|
|
def main():
|
|
"""main entry point for module execution
|
|
"""
|
|
argument_spec = dict(
|
|
gather_subset=dict(default=['!config'], type='list')
|
|
)
|
|
|
|
argument_spec.update(routeros_argument_spec)
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
gather_subset = module.params['gather_subset']
|
|
|
|
runable_subsets = set()
|
|
exclude_subsets = set()
|
|
|
|
for subset in gather_subset:
|
|
if subset == 'all':
|
|
runable_subsets.update(VALID_SUBSETS)
|
|
continue
|
|
|
|
if subset.startswith('!'):
|
|
subset = subset[1:]
|
|
if subset == 'all':
|
|
exclude_subsets.update(VALID_SUBSETS)
|
|
continue
|
|
exclude = True
|
|
else:
|
|
exclude = False
|
|
|
|
if subset not in VALID_SUBSETS:
|
|
module.fail_json(msg='Bad subset: %s' % subset)
|
|
|
|
if exclude:
|
|
exclude_subsets.add(subset)
|
|
else:
|
|
runable_subsets.add(subset)
|
|
|
|
if not runable_subsets:
|
|
runable_subsets.update(VALID_SUBSETS)
|
|
|
|
runable_subsets.difference_update(exclude_subsets)
|
|
runable_subsets.add('default')
|
|
|
|
facts = dict()
|
|
facts['gather_subset'] = list(runable_subsets)
|
|
|
|
instances = list()
|
|
for key in runable_subsets:
|
|
instances.append(FACT_SUBSETS[key](module))
|
|
|
|
for inst in instances:
|
|
inst.populate()
|
|
facts.update(inst.facts)
|
|
|
|
ansible_facts = dict()
|
|
for key, value in iteritems(facts):
|
|
key = 'ansible_net_%s' % key
|
|
ansible_facts[key] = value
|
|
|
|
module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|