zabbixAPI的包裝pyzabbix

       pyzabbix是zabbixAPI的第三方python包裝。從網上莫名其妙地搞到了一份源碼,看了一下之後發現實現方法還蠻巧妙的,感覺挺好的就記下來了。那些個源碼本身其實也是一個個單獨操作的腳本,可以用命令行參數直接操作。pyzbx用了json來encode和decode請求數據和返回數據,並且用了urllib2中的一些方法來進行通訊

  如果不是直接用它的腳本,而是自己定製相關程序的話基本上只用到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‘}]

  ●未完待續。。。


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章