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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,194评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,058评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,780评论 0 346
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,388评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,430评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,764评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,907评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,679评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,122评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,459评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,605评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,270评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,867评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,734评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,961评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,297评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,472评论 2 348

推荐阅读更多精彩内容