差異處
這裏顯示兩個版本的差異處。
|
snmp:snmp:mibhelloworld [2016/06/30 22:33] 127.0.0.1 外部編輯 |
snmp:snmp:mibhelloworld [2023/06/25 09:48] |
||
|---|---|---|---|
| 行 1: | 行 1: | ||
| - | {{tag>snmp}} | ||
| - | ====== 第一次寫MIB就上手 ====== | ||
| - | SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol，我對它的認識也是從工作接觸開始。雖說是管理網路設備，但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式，當然所有的操作也都可以透過SNMP來完成，不過可能會很痛苦。前陣子遇到一個學弟，它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。\\ | ||
| - | 在這篇文章中，不是要告訴你SNMP是什麼，會看這篇文章的大哥們，應該已經對SNMP有些認識了。\\ | ||
| - | |||
| - | 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid，有MIB可以幫助你去了解它所提供的資訊是什麼，且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作，也讓我順便了解一下它的語法，接下來我要交給大家MIB的基礎認識。 | ||
| - | ===== smidump ===== | ||
| - | 我並非使用什麼高強的Editor去編寫MIB，我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具，唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! | ||
| - | ==== 安裝 ==== | ||
| - | 在Ubuntu上可先輸入smidump確認是否安裝，如果沒安裝可透過**apt-get install libsmi2ldbl安裝**。(CentOS可以透過yum install libsmi) | ||
| - | <code> | ||
| - | root@tonylin:~/multi-boot-server# smidump | ||
| - | The program 'smidump' is currently not installed. You can install it by typing: | ||
| - | apt-get install libsmi2ldbl | ||
| - | </code> | ||
| - | ==== 使用 ==== | ||
| - | 透過下面兩行指令，就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 | ||
| - | <code bash> | ||
| - | smidump -f tree example1.mib > xtree.txt | ||
| - | smidump -f identifiers example1.mib > xiden.txt | ||
| - | </code> | ||
| - | 如果有參考其它檔案要加上p的參數: | ||
| - | <code bash> | ||
| - | smidump -f tree -p example1.mib example2.mib > xtree.txt | ||
| - | smidump -f identifiers -p example1.mib example2.mib > xiden.txt | ||
| - | </code> | ||
| - | ===== MIB HelloWorld! ===== | ||
| - | 一個MIB要怎麼寫，就看你要提供的資料結構是怎樣。舉例來說，如果要提供一個神盾局(S.H.I.E.L.D)的MIB，以下是我的一個簡易範例(xtree): | ||
| - | <code> | ||
| - | --shieldMIB(1.3.6.1.4.1.135) | ||
| - | | | ||
| - | +-- rwn DisplayString directorName(1) | ||
| - | | | ||
| - | +--staffObjects(2) | ||
| - | | | | ||
| - | | +--heroTable(1) | ||
| - | | | | ||
| - | | +--heroEntry(1) [heroIndex] | ||
| - | | | | ||
| - | | +-- --- Integer32 heroIndex(1) | ||
| - | | +-- r-n DisplayString heroName(2) | ||
| - | | +-- rwn DisplayString heroSex(3) | ||
| - | | +-- rwn Integer32 heroPower(4) | ||
| - | | +-- rwn DisplayString wellknown(5) | ||
| - | | | ||
| - | +--enemyObjects(3) | ||
| - | </code> | ||
| - | (各oid中的名稱必須是小寫開頭)\\ | ||
| - | 對應的意義即: | ||
| - | * 1.3.6.1.4.1.135.1: 局長姓名，Nick Fury。 | ||
| - | * 1.3.6.1.4.1.135.2: 雇員物件。我有列出來其下的heroTable。 | ||
| - | * 1.3.6.1.4.1.135.2.1: heroTable，放置各個英雄資訊。 | ||
| - | * 1.3.6.1.4.1.135.2.1: 英雄資訊。 | ||
| - | * 1.3.6.1.4.1.135.2.1.1: 識別號。 | ||
| - | * 1.3.6.1.4.1.135.2.1.2: 姓名，浩克。 | ||
| - | * 1.3.6.1.4.1.135.2.1.3: 性別，男。 | ||
| - | * 1.3.6.1.4.1.135.2.1.4: 攻擊力，65535。 | ||
| - | * 1.3.6.1.4.1.135.2.1.4: 名言，「好弱的神」。 | ||
| - | * 1.3.6.1.4.1.135.3: 敵人物件。與雇員物件雷同，不贅述。 | ||
| - | 像上面的範例我們該怎麼寫MIB呢? 可以先下載我寫好的{{:snmp:snmp:shield-mib.zip|完成品}}。 | ||
| - | ==== 結構 ==== | ||
| - | 以我觀察smidump的結果，共有node、table、row、column、scala、type、notification、compliance、group這幾個種類。在這個範例中會使用到的有node、table、row、column與scala。\\ | ||
| - | 彼此的關係如下: | ||
| - | * node > table > row > column，一個node可能會有多個table，table下會有多個row，row下會有多個column。用於重複的屬性，如heroTable。 | ||
| - | * node > scala。用於不重複的屬性，如generalName。 | ||
| - | * node > node，把node當分支就對了，如staffObjects和enemyObjects。 | ||
| - | ==== Init MIB ==== | ||
| - | 一個初始的MIB file就長的像下面這個樣子，ModuleName就是這個MIB名稱；ImportsList就像是import library或package，包含所有會使用到的形態與物件的宣告，基本上也是使用到什麼就匯入什麼；AssignmentsList就是那堆oid結構宣告。 | ||
| - | <code> | ||
| - | ModuleName DEFINITIONS ::= BEGIN | ||
| - | ?ImportsList? | ||
| - | ?AssignmentsList? | ||
| - | END | ||
| - | </code> | ||
| - | 以這個範例來說，基本的雛形會長這個樣子: | ||
| - | <code> | ||
| - | SHIELDMIB DEFINITIONS ::= BEGIN | ||
| - | IMPORTS | ||
| - | MODULE-IDENTITY, | ||
| - | OBJECT-IDENTITY, | ||
| - | OBJECT-TYPE, | ||
| - | Integer32, | ||
| - | enterprises | ||
| - | FROM SNMPv2-SMI | ||
| - | DisplayString | ||
| - | FROM SNMPv2-TC; | ||
| - | |||
| - | ?AssignmentsList? | ||
| - | END | ||
| - | </code> | ||
| - | MODULE-IDENTITY、OBJECT-IDENTITY、OBJECT-TYPE是用來描述結構與節點的；Integer32與DisplayString是會使用到的形態;enterprise代表1.3.6.1.4.1，SHIELDMIB是1.3.6.1.4.1.135，其中135必須與[[http://www.iana.org/|IANA]]註冊，也代表著你的ID，這是用來代表私人企業的意思。這些宣告後都有FROM XXXX，是要告訴smidump這些宣告的來源，你也可以將你寫過的MIB弄進來重複使用。(假如是一個很大的組織，可能都會有類似Common Library的MIB file) | ||
| - | ==== MODULE-IDENTITY ==== | ||
| - | 一個MIB Module就是需要一個MODULE-IDENTITY的宣告，裡面的內容就是記錄這個MIB Module的資訊。 | ||
| - | <code> | ||
| - | shieldMIB MODULE-IDENTITY | ||
| - | LAST-UPDATED "201208200000Z" | ||
| - | ORGANIZATION "S.H.I.E.L.D" | ||
| - | CONTACT-INFO "shield@shield.gov.us" | ||
| - | DESCRIPTION "復仇者聯盟" | ||
| - | REVISION "201005200000Z" | ||
| - | DESCRIPTION "神盾局創立" | ||
| - | REVISION "201102140000Z" | ||
| - | DESCRIPTION "浩克加入" | ||
| - | ::= { enterprises 135 } | ||
| - | </code> | ||
| - | 依樣畫葫蘆，revision+description是用來描述這個module有做過什麼修改，如果不喜歡也可以在整個MIB file最上方用兩個減號(註解)做說明；::=之後是接OID。 | ||
| - | ==== OBJECT-IDENTITY ==== | ||
| - | OBJECT-IDENTITY又叫branch node，用來做分類。以我們例子而言包含了staffObjects和enemyObjects，它們的oid宣告就是接在shieldMIB之後。 | ||
| - | <code> | ||
| - | staffObjects OBJECT-IDENTIFIER ::= { shieldMIB 2 } | ||
| - | enemyObjects OBJECT-IDENTIFIER ::= { shieldMIB 3 } | ||
| - | </code> | ||
| - | ==== OBJECT-TYPE ==== | ||
| - | OBJECT-TYPE可表示scala、table、row與column。 | ||
| - | === scala === | ||
| - | oid是接在node下，而且已經是leaf就是scala。以我們範例而言，就是神盾局局長，總不會同時會有兩個局長吧?其中SYNTAX代表著OBJECT-TYPE的型態；MAX-ACCESS代表著存取權限，可以參考[[http://www.muonics.com/Docs/MIBSmithy/UserGuide/variations.php#access|這裡]]；STATUS代表這個oid目前的狀態，可以參考[[http://www.muonics.com/Docs/MIBSmithy/UserGuide/objects.php#status|這裡]]。 | ||
| - | <code> | ||
| - | directorName OBJECT-TYPE | ||
| - | SYNTAX DisplayString | ||
| - | MAX-ACCESS read-write | ||
| - | STATUS current | ||
| - | DESCRIPTION "The director's name for the S.H.I.E.L.D." | ||
| - | ::= { shieldMIB 1 } | ||
| - | </code> | ||
| - | === table&row === | ||
| - | 與scala最大的不同就在於SYNTAX的描述。以我們的範例而言，heroTable是一個table包含多個heroEntry row代表著不同英雄，而heroEntry中又會有個別的column去描述英雄屬性。你可以把HeroEntry(大寫的)當做一種資料結構，裡面就是描述英雄屬性，而heroEntry(小寫的)的型態就是這個結構。而heroTable的SYNTAX就是代表著很多個HeroEntry。另外要注意的是oid，heroEntry一定是在heroTable之下，而heroTable則是在staffObjects之下。 | ||
| - | <code> | ||
| - | heroTable OBJECT-TYPE | ||
| - | SYNTAX SEQUENCE OF HeroEntry | ||
| - | MAX-ACCESS not-accessible | ||
| - | STATUS current | ||
| - | DESCRIPTION | ||
| - | "A table of hero entries." | ||
| - | ::= { staffObjects 1 } | ||
| - | |||
| - | heroEntry OBJECT-TYPE | ||
| - | SYNTAX HeroEntry | ||
| - | MAX-ACCESS not-accessible | ||
| - | STATUS current | ||
| - | DESCRIPTION | ||
| - | "An entry in the hero table." | ||
| - | INDEX { heroIndex } | ||
| - | ::= { heroTable 1 } | ||
| - | |||
| - | HeroEntry ::= | ||
| - | SEQUENCE { | ||
| - | heroIndex Integer32, | ||
| - | heroName DisplayString, | ||
| - | heroSex DisplayString, | ||
| - | heroPower Integer32, | ||
| - | wellknown DisplayString | ||
| - | } | ||
| - | </code> | ||
| - | === column === | ||
| - | 在row下的就是column，這部分寫法與scala大同小異，唯一差別就在於父節點是誰而已。 | ||
| - | <code> | ||
| - | heroIndex OBJECT-TYPE | ||
| - | SYNTAX Integer32 (1..65535) | ||
| - | MAX-ACCESS not-accessible | ||
| - | STATUS current | ||
| - | DESCRIPTION | ||
| - | "The unique value which identifies the hero." | ||
| - | ::= { heroEntry 1 } | ||
| - | |||
| - | heroName OBJECT-TYPE | ||
| - | SYNTAX DisplayString | ||
| - | MAX-ACCESS read-write | ||
| - | STATUS current | ||
| - | DESCRIPTION | ||
| - | "A textual full name assigned to a hero." | ||
| - | ::= { heroEntry 2 } | ||
| - | </code> | ||
| - | ===== 部屬MIB ===== | ||
| - | 將寫好的MIB放到/usr/share/snmp/mibs/，接著執行export MIBS=ALL。只要透過snmpwalk -v 1 127.0.0.1 .1.3.6.1.4.1.135 -c public可以看到透過MIB翻譯後的結果。\\ | ||
| - | 但是不要天真的以為照做就能夠看到了! 你必須要有SNMP的Provider，否則執行snmpwalk系統哪知道這是誰家的裝置! | ||
| - | ===== Summary ===== | ||
| - | MIB的語法算是一種程式語言了。除了沒提及的type、notification、compliance、group外，其實還包含了許多細節。但我想如果之後有接觸再分享給大家。\\ | ||
| - | \\ | ||
| - | |||
| - | 友藏內心獨白: 我只是分享心得，高手勿鞭。 | ||
| - | ===== Reference ===== | ||
| - | * [[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol|SNMP wiki]] | ||
| - | * [[http://www.ibr.cs.tu-bs.de/projects/libsmi/smidump.html|smidump]] | ||
| - | * [[http://www.muonics.com/Docs/MIBSmithy/UserGuide/|MIB Smithy User's Guide]] | ||
| - | |||
| - | ===== ===== | ||
| - | ---- | ||
| - | \\ | ||
| - | ~~DISQUS~~ | ||
