查看源代码 snmp_community_mib (snmp v5.18)

SNMP-COMMUNITY-MIB 的检测函数

模块 snmp_community_mib 实现了 SNMP-COMMUNITY-MIB 的检测函数，以及用于配置数据库的函数。

配置文件在 SNMP 用户手册中描述。

摘要

类型

context_name()

一个人类可读的字符串。

index()

SnmpAdminString (SIZE(1..32))

name()

OCTET STRING (SIZE(1..64))

security_name()

SnmpAdminString

transport_tag()

SnmpTagValue

函数

add_community(Idx, CommName, SecName, CtxName, TransportTag)

等同于 add_community/6。

add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag)

向代理配置添加一个 community。等同于 community.conf 文件中的一行。

configure(ConfDir)

此函数在系统启动时由 supervisor 调用。

delete_community(Key)

从代理配置中删除一个 community。

reconfigure(ConfDir)

将配置文件中的所有数据插入到数据库中，并销毁所有旧数据，包括 StorageType 为 nonVolatile 的行。从配置文件创建的行的 StorageType 将为 nonVolatile。

类型

context_name()

-type context_name() :: snmp_framework_mib:admin_string().

一个人类可读的字符串。

SnmpAdminString

index()

-type index() :: snmp_framework_mib:admin_string().

SnmpAdminString (SIZE(1..32))

name()

-type name() :: string().

OCTET STRING (SIZE(1..64))

security_name()

-type security_name() :: snmp_framework_mib:admin_string().

SnmpAdminString

transport_tag()

-type transport_tag() :: snmp_target_mib:tag_value().

SnmpTagValue

函数

add_community(Idx, CommName, SecName, CtxName, TransportTag)

-spec add_community(Idx, CommName, SecName, CtxName, TransportTag) -> {ok, Key} | {error, Reason}
                       when
                           Idx :: index(),
                           CommName :: name(),
                           SecName :: security_name(),
                           CtxName :: context_name(),
                           TransportTag :: transport_tag(),
                           Key :: term(),
                           Reason :: term().

等同于 add_community/6。

add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag)

(自 OTP R14B03 起)

-spec add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) ->
                       {ok, Key} | {error, Reason}
                       when
                           Idx :: index(),
                           CommName :: name(),
                           SecName :: security_name(),
                           EngineId :: snmp_framework_mib:engine_id(),
                           CtxName :: context_name(),
                           TransportTag :: transport_tag(),
                           Key :: term(),
                           Reason :: term().

向代理配置添加一个 community。等同于 community.conf 文件中的一行。

使用 EngineId 参数可以覆盖已配置的引擎 ID (SNMP-FRAMEWORK-MIB)。

configure(ConfDir)

-spec configure(ConfDir) -> snmp:void() when ConfDir :: string().

此函数在系统启动时由 supervisor 调用。

将配置文件中的所有数据插入到数据库中，并销毁所有 StorageType 为 volatile 的旧行。从配置文件创建的行的 StorageType 将为 nonVolatile。

所有 snmp 计数器都设置为零。

如果在配置文件中发现错误，则使用错误报告模块的 config_err/2 函数报告该错误，并且该函数会因 configuration_error 的原因而失败。

ConfDir 是一个指向配置文件所在目录的字符串。

读取的配置文件是：community.conf。

delete_community(Key)

-spec delete_community(Key) -> ok | {error, Reason} when Key :: term(), Reason :: term().

从代理配置中删除一个 community。

reconfigure(ConfDir)

-spec reconfigure(ConfDir) -> snmp:void() when ConfDir :: string().

将配置文件中的所有数据插入到数据库中，并销毁所有旧数据，包括 StorageType 为 nonVolatile 的行。从配置文件创建的行的 StorageType 将为 nonVolatile。

因此，调用此函数后，SNMP-COMMUNITY-MIB 中的数据来自配置文件。

所有 snmp 计数器都设置为零。

如果在配置文件中发现错误，则使用错误报告模块的 config_err/2 函数报告该错误，并且该函数会因 configuration_error 的原因而失败。

ConfDir 是一个指向配置文件所在目录的字符串。

读取的配置文件是：community.conf。