MIB

概述

参考：
Wiki, Management_information_base MIB
Wiki, Structure_of_Management_Information SMI
https://www.techbuddies.io/2023/08/31/snmp-oids-explained-explore-what-they-are-and-how-to-correctly-use-them/

Management information base(管理信息库，简称 MIB) 是一种数据库，用于管理通信网络中的 entities(实体，也称为 Objects(对象))。MIB 使用 SMI 语法定义 Objects，其中包括 objects 的名称、OID、数据类型、描述(干什么用的)。MIB 也可以看作是 SNMP 的服务端与代理端的沟通桥梁，只有具有统一的格式，才能确定数据。

Structure of Managerment Intormation(管理信息结构,简称 SMI) 是 ASN.1 的子集，是一种技术语言，主要用在 SNMP(传统监控标准) 中，用于定义管理 MIB 中的 Objects。最新的版本是 1999 年的 SMIv2(RFC 2578)(文件内声明的名称为 SNMPv2-SMI)。

Object(对象) 可以是一个具体需要采集到的数据，比如内存、CPU、磁盘、网络接口等等，也可以是一种抽象的集合，比如地区、硬件、系统、硬件、网络等等。上面说的所有事物，每一个都是一个 Object。所以，Object 可以包含另一个 Object，这也是人称常常将 MIB 称为树状的原因

Object Identifier(对象标识符，简称 OID) # 每一个 Object 都有一个 OID
数据存取格式：即每个 object 除了 OID 用作标示以外，还有数据内容需要遵循一定个格式规范

所谓的 MIB，其实主要是通过文件记录的内容。与其说是用文件记录，不如说 MIB 就是使用 ASN.1(标准的接口描述语言) 编写的代码。ASN.1 语言同样有类似 import、 function 这类的东西。只不过，记录 MIB 文件的语言，又与 ASN.1 有一些细微的区别，我们暂且称为 MIB 语言 吧~

可以这么说，MIB 就是一门描述 OID 的编程语言。

OID 的格式

参考：
OID 参考数据库

在解释 MIB 语法前，首先要明确以下 OID 的格式，因为 MIB 就是用来记录 OID 的，只有明确了 OID 的格式，才能更好的理解 MIB 的语法。

OID 有两种格式：

symbolic(textual文本) # MIB::OBJECT.INDEX
numerical(数字) # .x.x.x.x.x.
- 每一个 Object 都对应一个数字，而 Object 总是属于某一个 MIB，所以，可以将文本转换为数字（反之亦然）。

这两种方式可以使用 net-snmp-utils 中的 snmptranslate 命令进行转换，转换成字符串后，人类可以通过英文了解到大概意思，比如下图，表示的是该设备内存的大小。这是 snmpwalk 命令获取内存这个 OID 的当前的值(下图中=后面的内容是该 Object 的数据类型以及值，数据类型与值以冒号分隔)

SNMPv2-MIB::sysDescr.0 这个 Object 用来输出系统描述信息。显示一些基本的系统信息

~]# snmpwalk -v 2c -c public 172.19.42.243 | more
SNMPv2-MIB::sysDescr.0 = STRING: Linux HDM210235A3KHH209000234 3.14.17-ami #1 Thu Sep 10 10:55:48 CST 2020 armv6l
~]# snmptranslate -On iso
.1
~]# snmptranslate -On SNMPv2-SMI::dod
.1.3.6
~]# snmptranslate -On SNMPv2-MIB::sysDescr.0
.1.3.6.1.2.1.1.1.0

Object 中的 INDEX 说明：

Tips: 这一部分的说明可能要等看完下文 MIB 中对象的类型和定义相关内容才能看明白

INDEX 是该 Obejct 中实体的索引，默认值为 0。一个 Object 里面可能包含多个实体，比如一个块磁盘里面可能包含多个分区，效果如下图，当一个 object 里面有多个实体时，INDEX 则不再是 0，而是一个随机数。这些实体其实是在执行 snmpwalk 时，动态发现的

snmpwalk -v 2c -c public 192.168.1.168 HOST-RESOURCES-MIB::hrStorageDescr
HOST-RESOURCES-MIB::hrStorageDescr.1 = STRING: Physical memory
HOST-RESOURCES-MIB::hrStorageDescr.3 = STRING: Virtual memory
HOST-RESOURCES-MIB::hrStorageDescr.6 = STRING: Memory buffers
HOST-RESOURCES-MIB::hrStorageDescr.7 = STRING: Cached memory
HOST-RESOURCES-MIB::hrStorageDescr.8 = STRING: Shared memory
HOST-RESOURCES-MIB::hrStorageDescr.10 = STRING: Swap space
HOST-RESOURCES-MIB::hrStorageDescr.11 = STRING: Available memory
HOST-RESOURCES-MIB::hrStorageDescr.35 = STRING: /dev/shm
HOST-RESOURCES-MIB::hrStorageDescr.37 = STRING: /run
HOST-RESOURCES-MIB::hrStorageDescr.38 = STRING: /sys/fs/cgroup
HOST-RESOURCES-MIB::hrStorageDescr.53 = STRING: /
HOST-RESOURCES-MIB::hrStorageDescr.59 = STRING: /tmp
HOST-RESOURCES-MIB::hrStorageDescr.63 = STRING: /boot

MIB 结构

MIB 呈现的是一种树状的结构。MIB 实际上就是很多 Objects 的集合。Objects 的结构就像树状一样。

MIB 常用两种类型的 Object

Scalar(标量) # 定义一个 Object。包含单个对象实例的对象。
Tabular(表式) # 定义了一组具有相关性的 Objects。可以包含多个对象的多个实例。

用最常见的 IF-MIB 举例。图里有一个标量对象 ifNumber，一个表式对象 ifTable：

700

这里相当于创建了一个名为 ifTable 的表式对象，ifEntry 表示该表中有多少个列（i.e. Objects），ifIndex 作为该表的自增序列（就像数据库的表中的 ID 列）。其他的都是用来记录具体数据的。

[!Note] 一个 Tabular Object 名称通常 以 Table 结尾；该 Objcet 中还应该包含一个 以 Entry 结尾 的 Object，用于列出表中的列名，所有列中有一个用于索引用途的标量对象，通常 以 Index 结尾。

ifIndex	ifDescr	ifType	……	ifOperStatus	……
1	1/0/1	6	……	1	……
2	1/0/2	6	……	2	……
……	……	……	……	……	……

Tabular object 其实跟数据库的表是相似的逻辑。Tabular object 表的列用来表示 n 个相关的 Objects 的各种信息，e.g. 接口描述、接口状态、etc. ；行则用来动态得发现监控目标有多少个 Objects Instance(实例)。

e.g. ifTable 表用来表示接口相关信息的，如果在一台设备上，发现了 10 个接口，那么就可以说一共有 10 个 Objects instance。也就意味着 ifIndex 的值一共有 10 个（i.e. 1 至 10）

IF-MIB 文件中的代码像下面这样：

interfaces   OBJECT IDENTIFIER ::= { mib-2 2 }

ifNumber  OBJECT-TYPE
    SYNTAX      Integer32
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION ...... 略
    ::= { interfaces 1 }

ifTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF IfEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
            "A list of interface entries.  The number of entries is
            given by the value of ifNumber."
    ::= { interfaces 2 }

ifEntry OBJECT-TYPE
    SYNTAX      IfEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
            "An entry containing management information applicable to a
            particular interface."
    INDEX   { ifIndex }
    ::= { ifTable 1 }

IfEntry ::=
    SEQUENCE {
        ifIndex                 InterfaceIndex,
        ifDescr                 DisplayString,
        ifType                  IANAifType,
        ifMtu                   Integer32,
        ifSpeed                 Gauge32,
        ifPhysAddress           PhysAddress,
        ifAdminStatus           INTEGER,
        ifOperStatus            INTEGER,
        ifLastChange            TimeTicks,
        ifInOctets              Counter32,
        ifInUcastPkts           Counter32,
        ifInNUcastPkts          Counter32,  -- deprecated
        ifInDiscards            Counter32,
        ifInErrors              Counter32,
        ifInUnknownProtos       Counter32,
        ifOutOctets             Counter32,
        ifOutUcastPkts          Counter32,
        ifOutNUcastPkts         Counter32,  -- deprecated
        ifOutDiscards           Counter32,
        ifOutErrors             Counter32,
        ifOutQLen               Gauge32,    -- deprecated
        ifSpecific              OBJECT IDENTIFIER -- deprecated
    }

ifIndex OBJECT-TYPE
    SYNTAX      InterfaceIndex
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
            "A unique value, greater than zero, for each interface.  It
            is recommended that values are assigned contiguously
            starting from 1.  The value for each interface sub-layer
            must remain constant at least from one re-initialization of
            the entity's network management system to the next re-
            initialization."
    ::= { ifEntry 1 }

ifDescr OBJECT-TYPE
    SYNTAX      DisplayString (SIZE (0..255))
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION ...... 略
    ::= { ifEntry 2 }

...... 略

定义 Object

常用在文件开头定义

${对象名称}  OBJECT IDENTIFIER ::= { ${父对象名称} ${数字OID} }

常用在文件中间，定义可以采集到具体实例的对象

${对象名称} OBJECT-TYPE
    SYNTAX      ${XXXXXXX}
    MAX-ACCESS  ${XXXXXXX}
    STATUS      ${XXXXXXX}
    DESCRIPTION ${XXXXXXX}
    ::= { ${父对象名称} ${数字OID} }

OBJECT-TYPE 宏

在 SNMPv2-SMI 中定义了一个名为 OBJECT-TYPE 的宏，该宏被大量用于定义 Object

在 OBJECT-TYPE 中使用如下关键字定义对象：

SYNTAX # 对象的类型
MAX-ACCESS # 对象的访问级别
STATUS # 对象的状态，是可用还是弃用
DESCRIPTION # 对象的描述

MIB HelloWorld

MIB 文件总是以 XXXX DEFINITIONS ::= BEGIN 开始，最后一行以 END 结束，在 BEGIN 和 END 之间，就是用来定义 Object 的代码块。其中 XXXX 为库的名称。比如：

-- 这是一个名为 SNMPv2-SMI 的库。这给地方相当于 func main() { ，而最后的 END 就是 }
SNMPv2-SMI DEFINITIONS ::= BEGIN
-- 从这里开始，就是具体的代码逻辑
-- 定义了一个名为 org 的对象，OID 号为 3，属于 iso 这个对象。而 iso 这个对象又属于 iso
org            OBJECT IDENTIFIER ::= { iso 3 }  --  "iso" = 1
-- 定义了一个名为 dod 的对象，OID 号为 6，属于 org 这个对象。
dod            OBJECT IDENTIFIER ::= { org 6 }
-- 定义了一个名为 internet 的对象，OID 号为 1，属于 dod 这个对象
internet       OBJECT IDENTIFIER ::= { dod 1 }

directory      OBJECT IDENTIFIER ::= { internet 1 }

mgmt           OBJECT IDENTIFIER ::= { internet 2 }
mib-2          OBJECT IDENTIFIER ::= { mgmt 1 }
-- ......略
-- 结束
END

在代码块中，通常定义两种东西：

OBJECT # 对象。就是上文描述的一个可以采集到的监控数据对象
MACRO # 宏。一种类似 function 的代码块，可以实现一个完成的功能，并让其他 MIB 调用。

在 MIB 中除了可以定义 Object，还可以定义一些类似于编程语言的 function 的东西，在 MIB 语言里称为 MACRO(宏指令)

这里提个题外话，本人玩魔兽，经常就会编写一些宏，魔兽中的宏，其实跟变成语言中的 function 是类似的概念，都是通过一组代码，实现一个行为。

MIB 语言关键字

IMPORTS # 从其他 MIB 中导入 Object(对象) 或 MARCRO(宏指令)
DEFINITIONS # 一般只出现在文件开头，用来定义一个该 MIB 的名称。与文件最后一行的 END 关键字组合，构成了一个完成 MIB 代码
OBJECT IDENTIFIER - 对象标识符，就是用来定义一个对象
MACRO # 宏，用来定义一个宏指令

IMPORTS

IMPORTS
    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
    TimeTicks, Counter32, snmpModules, mib-2
        FROM SNMPv2-SMI
    DisplayString, TestAndIncr, TimeStamp
        FROM SNMPv2-TC
    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
        FROM SNMPv2-CONF;

SNMPv2-MIB 这个库导入了多个对象和宏，来自于三个库。宏一般都是全大写的字符串：

从 SNMPv2-SMI 库导入了 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, TimeTicks, Counter32, snmpModules, mib-2
从 FROM SNMPv2-TC 库导入了 DisplayString, TestAndIncr, TimeStamp
从 SNMPv2-CONF 库导入了 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP

OBJECT IDENTIFIER

org            OBJECT IDENTIFIER ::= { iso 3 } --  "iso" = 1

这是定义 Object 的标准格式

关键字的左边 # 是对象的名称
关键字的右边 # 使用 ::={ } 这种格式，其中 { } 中的内容是 {该对象所属对象的OID名该对象的OID号}

也就是说 org 这个对象如果用数字格式表示的话，就是 .1.3，如果用字符串表示的话需要一个前提，就是指定 MIB，因为 org 这个对象可以定义在不同的 MIB 中，只不过大家懒得重复造轮子，大部分情况都会直接导入 SNMPv2-SMI 这个 MIB，以便可以直接使用其中已经定义好的的各种 Object。但是 iso 是不用指定 MIB 的，因为 iso 是基础，是根下面的一级，就算属于，也只会属于根 MIB

e.g. 用 snmptranslate 转换一下

~]# snmptranslate -On iso
.1
~]# snmptranslate -On org
org: Unknown Object Identifier (Sub-id not found: (top) -> org)
~]# snmptranslate -On SNMPv2-SMI::org
.1.3

除了这种最基本的定义 Object 的格式，还可以通过自定义的 MACRO 来定义 Object，这种方式更为复杂，但是可以更详细得描述一个 Object 的数据格式，以及代表什么监控项。详见 OBJECT-TYPE 宏。这种定义 Object 的方式，常用来定义一个具体的待采集的具体的监控项，比如内存大小、内存使用率、磁盘大小等等

MACRO

OBJECT-TYPE MACRO ::=
BEGIN
    TYPE NOTATION ::=
                  "SYNTAX" Syntax
                  UnitsPart
                  "MAX-ACCESS" Access
                  "STATUS" Status
                  "DESCRIPTION" Text
                  ReferPart

                  IndexPart
                  DefValPart

    VALUE NOTATION ::=
                  value(VALUE ObjectName)

    Syntax ::=   -- Must be one of the following:
                       -- a base type (or its refinement),
                       -- a textual convention (or its refinement), or
                       -- a BITS pseudo-type
                   type
                | "BITS" "{" NamedBits "}"

    NamedBits ::= NamedBit
                | NamedBits "," NamedBit

    NamedBit ::=  identifier "(" number ")" -- number is nonnegative

    UnitsPart ::=
                  "UNITS" Text
                | empty

    Access ::=
                  "not-accessible"
                | "accessible-for-notify"
                | "read-only"
                | "read-write"
                | "read-create"

    Status ::=
                  "current"
                | "deprecated"
                | "obsolete"

    ReferPart ::=
                  "REFERENCE" Text
                | empty

    IndexPart ::=
                  "INDEX"    "{" IndexTypes "}"
                | "AUGMENTS" "{" Entry      "}"
                | empty
    IndexTypes ::=
                  IndexType
                | IndexTypes "," IndexType
    IndexType ::=
                  "IMPLIED" Index
                | Index

    Index ::=
                    -- use the SYNTAX value of the
                    -- correspondent OBJECT-TYPE invocation
                  value(ObjectName)
    Entry ::=
                    -- use the INDEX value of the
                    -- correspondent OBJECT-TYPE invocation
                  value(ObjectName)

    DefValPart ::= "DEFVAL" "{" Defvalue "}"
                | empty

    Defvalue ::=  -- must be valid for the type specified in
                  -- SYNTAX clause of same OBJECT-TYPE macro
                  value(ObjectSyntax)
                | "{" BitsValue "}"

    BitsValue ::= BitNames
                | empty

    BitNames ::=  BitName
                | BitNames "," BitName

    BitName ::= identifier

    -- a character string as defined in section 3.1.1
    Text ::= value(IA5String)
END

MACRO 也是以 BEGIN 开头，END 结尾，上面的例子定义个一个名为 OBJECT-TYPE 的宏指令，可以让其他 MIB 导入后直接使用。

常见用法解读

常见的 MIB

SNMPv2-SMI

非常基本的 MIB，从根开始定义每一个 Object，并定义了以下常见的 MACRO。很多 MIB 中，都会导入这个 MIB。

就像这个库的名字一样，它代表了 v2 版本的 SNMP 应该具有的一般 OBJECT 和 MACRO。

SNMPv2-MIB

SNMPv2-TC

IF-MIB # 网络接口相关 MIB。e.g. 交换机的接口、路由器的接口、etc.

常见的 MACRO(宏指令)

经过了这么多年的发展，现在有很多常用的 MACRO 作为默认自带的。比如其中 MODULE-IDENTITY 这个宏，就是对 Object 的一个抽象，其实也可以当作 Object 的一种。

有一个名为 SNMPv2-SMI 的库，可以当作一个基本库，每次大家定义新库时，总会导入这个库，这些常见的 MACRO 很多都是在 SNMPv2-SMI 这个库中定义的

MODULE-IDENTITY

很多 Object 的集合

TEXTUAL-CONVENTION

定义了对标准数据类型的进行扩展的语法。很多 MIB 定义中都会先定义一些基于标准类型的扩展类型，如：

KBytes ::= TEXTUAL-CONVENTION（文本约定）
    STATUS current
    DESCRIPTION
        "Storage size, expressed in units of 1024 bytes."
    SYNTAX Integer32 (0..2147483647)

OBJECT-TYPE

用来定义一个 Object，

sysDescr OBJECT-TYPE
    SYNTAX      DisplayString (SIZE (0..255))
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
            "A textual description of the entity.  This value should
            include the full name and version identification of
            the system's hardware type, software operating-system,
            and networking software."
    ::= { system 1 }

需要注意，这里面定义 Object 已经不是使用 OBJECT IDENTIFIER 这个关键字了，而是通过 MACRO 来定义的，这个宏就是 OBJECT-TYPE，

OBJECT-GROUP

MODULE-COMPLIANCE

MIB 文件简单示例

-- SNMPv2-MIB 是该 MIB 库的名字，也是在调用该 MIB 时所用的名字。
SNMPv2-MIB DEFINITIONS ::= BEGIN

-- 类似于编程中导入某某包，这里就是导入一些 MIB 信息。比如Object 类型、
IMPORTS
    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
    TimeTicks, Counter32, snmpModules, mib-2
        FROM SNMPv2-SMI
......略

-- 该 MIB 库的一些基本信息，介绍、维护者的邮箱名字等等
-- snmpMIB 是最重要的标识之一，标识该模块的标识。一般情况，一个文件中只有一个 MODULE-IDENTITY
-- 且该文件中后面所有的 Object 都属于 snmpMIB 这个 MODULE-IDENTITY
-- 这些模块可以在 IMPORTS 中被 MIB 导入。
snmpMIB MODULE-IDENTITY
    DESCRIPTION
            "The MIB module for SNMP entities.

             Copyright (C) The Internet Society (2002). This
             version of this MIB module is part of RFC 3418;
             see the RFC itself for full legal notices.
            "
    REVISION      "200210160000Z"

-- snmpMIBObjects 是一个 Objcet 的标识符
-- 属于 snmpMIB 这个模块
snmpMIBObjects OBJECT IDENTIFIER ::= { snmpMIB 1 }


-- system 是一个 Object 的标识符。
-- 属于 mib-2 这个模块
system   OBJECT IDENTIFIER ::= { mib-2 1 }

-- sysDescr 这个 Object 的信息。
-- ::= { system 1 } 表示 sysDescr 属于 system 这个 Object
sysDescr OBJECT-TYPE
    SYNTAX      DisplayString (SIZE (0..255))
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
            "A textual description of the entity.  This value should
            include the full name and version identification of
            the system's hardware type, software operating-system,
            and networking software."
    ::= { system 1 }

-- sysObjectID 这个 Object 的信息。
-- ::= { system 2 } 表示 sysObjectID 属于 system 这个 Object
sysObjectID OBJECT-TYPE
    SYNTAX      OBJECT IDENTIFIER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION ......略
    ::= { system 2 }

END

如果仔细观察，可以看到一个树状的关系网：

在 IMPORTS 字段中导入了 mib-2
在 system OBJECT IDENTIFIER ::= { mib-2 1 } 中可以看导 system 这个 Object 属于 mib-2
在 sysDescr OBJECT-TYPE ...略... ::= { system 1 } 中可以看到 sysDescr 这个 Object 属于 system