zabbixAPI的包装pyzabbix-创新互联
pyzabbix是zabbixAPI的第三方python包装。从网上莫名其妙地搞到了一份源码,看了一下之后发现实现方法还蛮巧妙的,感觉挺好的就记下来了。那些个源码本身其实也是一个个单独操作的脚本,可以用命令行参数直接操作。pyzbx用了json来encode和decode请求数据和返回数据,并且用了urllib2中的一些方法来进行通讯
成都创新互联主营迎江网站建设的网络公司,主营网站建设方案,app软件开发,迎江h5微信小程序开发搭建,迎江网站营销推广欢迎迎江等地区企业咨询如果不是直接用它的脚本,而是自己定制相关程序的话基本上只用到ZabbixAPI这个类:
from pyzabbix import ZabbixAPI zapi = ZabbixAPI("server") #server是指zabbixweb界面的url,比如http://192.168.1.101/zabbixzapi.login("username","password") #指的是zabbix系统里的用户名和密码,不是服务器本身的用户名和密码
之后就可以用zapi这个对象来实现程序和zabbixAPI之间的通讯了。
官方文档地址:http://www.zabbix.com/documentation/2.4/manual/api
zapi主要可以用的方法:
zapi.host.get , zapi.host.create , zapi.hostgroup.get , zapi.host.update , ........等等。可以看到,这些方法和API的分类是一致的,这是写了这个pyzabbix模块的人包装得很巧妙的おかげ,用起来就方便很多了。 此外,这些方法大多都支持string/list的双重参数格式。意思就是说,当你想操作多次,但是又不想一条一条语句写的时候,可以直接传一个list进去,它会自动给你解析出来的。
■ 使用方法:
zapi.hostgroup.get(filter={‘groupid‘:‘xxx‘},output=[‘name‘,‘groupid‘],selectHosts=[‘name‘,‘hostid‘])
类似这样的语句。一个方法对应了官方API说明中的一种操作,这种对应关系很好懂,比如hostgroup.get就是获取主机组的信息,host.update就是更新主机的一些信息等等。至于每个方法的参数,就是和这个方法对应的那个API操作里规定的请求json串有关了。看几个请求串和方法参数的对应就会有感觉了= =。。字段是参数名,而字段值是参数值。
比如详细解释一下上面这条语句,它的意思就是
我要获取一些主机组的信息。
这个(些)主机组的groupid是xxx(filter的功能,如果不写filter,系统就默认把所有组的信息都返回给你了,当然通过指定groupid过滤出来的组肯定只有一个咯,但是返回来的json串仍然是个列表的形式,即使只有一项,这个后面还会说到)
我要得到的是这个(些)组的name和groupid字段(output的功能,output一定得是一个列表,可以是空,但是无论如何至少一定会返回groupid这个字段。如果写[‘extend‘]则是把所有字段的信息都返回)
此外我还要获取一些这个主机组里主机的信息,那么可以用selectHosts这个参数,列表中的值指定了我想知道的这些主机哪些字段的信息。
最后返回回来的json可能是这样的:
[ { "hosts": [ { "hostid": "10001", "name": "主机1" }, { "hostid": "10002", "name": "主机2" } ], "groupid": "10", "name": "主机组1" } ]
*不要问为什么hosts不是写在output里的一个参数= =。它的API就是这么设计的,即使是写json请求串也是要把selectHosts和output分开两个字段写的。。
このように,利用这类包装好的方法来获取json串,然后从json串里解析出我想要的信息就是一般的做法了。get基本上就是这样了,其他的什么create啦,update啦,主要还是要结合官方给出的请求串的格式以及可用字段,然后思考一下我的参数该怎么写,测试一下就好了。总体来时pyzabbix并不难用,只是zabbixAPI本身有些逻辑比较异于常理,需要适应适应。。
■ 以下是一些我在使用过程中碰到的一些需要注意的地方:
● 本身参数不存在,或者参数的值不合法的情况下(比如在上面那条语句中加个testpara="testvalue"之类的或者把output写成[‘name‘,‘groupid‘,‘testitem‘]),zabbixAPI不会报错,而是默认忽略这个参数,这一点比较坑,需要注意的。
● 主机有一个属性是status,这个属性可以在host.update中使用来实现通过api enable和disable某个主机的操作。但是需要注意的是这个status的值是u‘0‘或者u‘1‘,不是int也不是str,是unicode
● host.update的时候在确定要update哪台主机的时候用的不是filter参数(事实上可能出了get方法以外,其他的用的都不是filter),而是直接有个hostid参数来指定一个hostid,从而确定一台特定的主机。这么做的依据是因为hostid是主机与生俱来且唯一的,可以这么做。。
●host在create的时候可以加上macros参数来添加宏。比如macros=[{‘macro‘:‘{$INSTANCE}‘,‘value‘:‘frankid‘},{‘macro‘:‘{$ACCOUNT}‘,‘value‘:‘test_account‘}]
●未完待续。。。
另外有需要云服务器可以了解下创新互联scvps.cn,海内外云服务器15元起步,三天无理由+7*72小时售后在线,公司持有idc许可证,提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案,具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势,专为企业上云打造定制,能够满足用户丰富、多元化的应用场景需求。
网站标题:zabbixAPI的包装pyzabbix-创新互联
转载注明:http://ybzwz.com/article/hocpe.html