Nornir之表格资产管理插件

设备管理模块在任何一个自动化框架中都是必备的,原生的Nornir采用YAML文件存储设备信息,YAML文件是序列化的数据结构,编写非常繁琐,因为是树形结构,如果有几十台甚至上百台设备,yaml文件就会变得十分臃肿,难以阅读。为了简化和降低设备信息维护的难度,本文对Nornir的设备管理插件进行了重新设计,从表格中把资产载入inventory,每条记录就是一台设备,不仅容易维护,还可以迁移进数据库,有了很大的灵活性和可移植性。

  首先来讲一下思路,其实思路很简单,这实际上就是一个简单的逆向工程加上官方手册的简单指导。我们先熟悉一下SimpleInventory类的代码,然后找到重点,切入要点,边写,边测,边改。


原生类

我们观察源码发现,这个类有两个方法:
1、第一个是初始化init方法,是指定了三种yaml文件的路径,然后加载成为一个path对象;
2、第二个是load方法,返回一个Inventory对象,这个对象由三个重要的参数构建,分别是hosts,groups和defaults。groups和defaults个人感觉用处不是很大,网上的很多案例把一些路由域、位置、厂商等信息放入groups中,按group批量定制一些参数、创建一些配置,在这里我把这些参数都整合进了hosts中。
  通过以上分析,我们主要从init和load方法入手:
1、利用init方法将设备字段进行整形,初始化一个参数devices,这个参数是一个字典列表,最终构建了一个self.devices,用于load方法,其中connection_options包含了一个global_delay_factor延迟因子和secret密码,时间因子主要用于调整超时时间的场景,在实际场景中,有些网络设备距离比较远,有的网络设备性能比较差,就会引起通信耗时较长,执行命令耗时较长的情况,导致netmiko超时,这个时候我们就可以调整延迟因子,延长超时时间,secret密码主要是用于cisco设备的特权密码,直接上源码:

 def __init__(
            self,
            devices: List[dict],
    ) -> None:
        """
        根据devices的字典列表加载所有的网络设备
        :param devices:
        网络设备信息字典列表数据结构如下:
        [{'hostsname':'192.168.1.1','username':'admin','password':'admin','port':22,'platform':'cisco_ios',
        'device_type':'router'}]
        """
        host_info = ['hostname', 'username', 'password', 'port', 'platform', 'ip']
        reshape_devices = []
        for device in devices:
            reshape_device = {
                'data': {},
            }
            for k, v in device.items():
                if k in host_info:
                    reshape_device[k] = v
                else:
                    reshape_device['data'][k] = v
            reshape_device['connection_options'] = {
                'netmiko': {'extras': {'global_delay_factor': device.get('global_delay_factor'),
                                       'secret': device.get('secret')}}}
            reshape_devices.append(reshape_device)
        self.devices = reshape_devices

经过初始化后的设备信息长这个样子:

host_info = {
    'hostname': '192.168.1.1',
    'username': 'admin',
    'password': 'admin',
    # 其他字段省略
    'connection_options': {
        'netmiko': {
            'extras': {
                'global_delay_factor': 1,
                'secret': 'admin'
            }
        }
    }
}

2、从上面的分析看,在load方法中,groups和defaults参数用处不大,因此可以删除相关代码,化繁为简,重点关注hosts参数,原生的代码将yaml文件转换成字典,定制代码直接使用初始化后的字典;


Snipaste_2022-06-01_16-59-03.png

3、注册我们定制的插件
完成inventory的插件定制后,还需要把插件注册到nornir才可以使用


Snipaste_2022-06-01_17-13-12.png
小结

这篇文章主要介绍了nornir表格资产插件的定制过程,该插件辅助《IP地址资源管理系统》(另一篇文章有介绍)使用,与数据库对接。为了方便使用和学习,我另外写了一个demo,使用excel表格管理设备,定制了一个抓取设备ARP表的任务,格式化写入excel表格,源码地址:https://gitee.com/mobiledj/net-dev-ops.git,运行源码需要安装以下库:

pip install nornir
pip install netmiko
pip install nornir_netmiko
pip install nonir_utils
pip install pandas

你可能感兴趣的:(Nornir之表格资产管理插件)