Ruby SNMP 库技术文档

1. 安装指南

1.1 使用 RubyGems 安装

要安装最新版本的 SNMP 库，可以使用 RubyGems 进行安装。打开终端并执行以下命令：

gem install snmp

1.2 验证安装

安装完成后，可以通过以下命令验证是否安装成功：

gem list snmp

如果安装成功，应该会显示已安装的 SNMP 库版本。

2. 项目使用说明

2.1 概述

SNMP（简单网络管理协议）是一个广泛使用的协议，用于监控网络设备的健康状况。Ruby SNMP 库是一个纯 Ruby 实现的 SNMP 库，无需依赖外部库（如 net-snmp）。该库支持以下功能：

• 支持 GetRequest、GetNextRequest、GetBulkRequest、SetRequest、Response、SNMPv1_Trap、SNMPv2_Trap 和 Inform PDUs。
• 支持所有 SNMPv1 和 SNMPv2c 定义的 ASN.1 数据类型。
• 支持发送 informs 和 v1、v2 陷阱。
• 支持 traps 的处理。
• 支持符号化 OID 值（如 "ifTable" 代替 "1.3.6.1.2.1.2.2"）。
• 包含所有当前 IETF MIB 的符号数据文件。
• 兼容 Ruby 1.9 及以上版本。

2.2 示例代码

2.2.1 Get Request

获取系统描述信息：

require 'snmp'

SNMP::Manager.open(:host => 'localhost') do |manager|
    response = manager.get(["sysDescr.0", "sysName.0"])
    response.each_varbind do |vb|
        puts "#{vb.name.to_s}  #{vb.value.to_s}  #{vb.value.asn1_type}"
    end
end

2.2.2 Set Request

设置系统名称：

require 'snmp'
include SNMP

manager = Manager.new(:host => 'localhost')
varbind = VarBind.new("1.3.6.1.2.1.1.5.0", OctetString.new("My System Name"))
manager.set(varbind)
manager.close

2.2.3 Table Walk

遍历 ifTable：

require 'snmp'

ifTable_columns = ["ifIndex", "ifDescr", "ifInOctets", "ifOutOctets"]
SNMP::Manager.open(:host => 'localhost') do |manager|
    manager.walk(ifTable_columns) do |row|
        row.each { |vb| print "\t#{vb.value}" }
        puts
    end
end

2.2.4 Get-Next Request

以更复杂的方式遍历 ifTable：

require 'snmp'
include SNMP

Manager.open(:host => 'localhost') do |manager|
    ifTable = ObjectId.new("1.3.6.1.2.1.2.2")
    next_oid = ifTable
    while next_oid.subtree_of?(ifTable)
        response = manager.get_next(next_oid)
        varbind = response.varbind_list.first
        next_oid = varbind.name
        puts varbind.to_s
    end
end

2.2.5 Get-Bulk Request

获取 ifTable 的前 10 行接口描述和状态：

require 'snmp'
include SNMP

ifDescr_OID = ObjectId.new("1.3.6.1.2.1.2.2.1.2")
ifAdminStatus_OID = ObjectId.new("1.3.6.1.2.1.2.2.1.7")
MAX_ROWS = 10
Manager.open(:host => 'localhost') do |manager|
    response = manager.get_bulk(0, MAX_ROWS, [ifDescr_OID, ifAdminStatus_OID])
    list = response.varbind_list
    until list.empty?
        ifDescr = list.shift
        ifAdminStatus = list.shift
        puts "#{ifDescr.value}    #{ifAdminStatus.value}"
    end
end

2.2.6 Trap Handling

将 traps 记录到标准输出：

require 'snmp'
require 'logger'

log = Logger.new(STDOUT)
m = SNMP::TrapListener.new do |manager|
    manager.on_trap_default do |trap|
        log.info trap.inspect
    end
end
m.join

3. 项目 API 使用文档

3.1 SNMP::Manager

SNMP::Manager 类是 SNMP 库的核心类，用于与 SNMP 设备进行交互。它提供了以下主要方法：

• get(oids): 发送 GetRequest，获取指定 OID 的值。
• set(varbinds): 发送 SetRequest，设置指定 OID 的值。
• walk(oids): 遍历指定 OID 的表。
• get_next(oids): 发送 GetNextRequest，获取下一个 OID 的值。
• get_bulk(non_repeaters, max_repetitions, oids): 发送 GetBulkRequest，批量获取 OID 的值。

3.2 SNMP::TrapListener

SNMP::TrapListener 类用于监听和处理 SNMP traps。它提供了以下主要方法：

• on_trap_default: 处理默认的 trap 事件。

3.3 SNMP::MIB

SNMP::MIB 类用于处理 MIB 文件，提供了符号化 OID 的功能。

4. 项目安装方式

4.1 通过 RubyGems 安装

如前所述，可以通过以下命令安装 SNMP 库：

gem install snmp

4.2 手动安装

如果需要手动安装，可以从 GitHub 项目页面下载源代码，然后执行以下命令：

gem build snmp.gemspec
gem install snmp-<version>.gem

4.3 依赖项

SNMP 库依赖于 Ruby 1.9 及以上版本。确保系统中已安装合适的 Ruby 版本。

---

通过以上文档，您应该能够顺利安装和使用 Ruby SNMP 库，并了解其主要功能和 API 的使用方法。