Erlang 20

snmpc

snmpc

模块

snmpc

模块摘要

与SNMP工具包MIB编译器的接口函数

描述

模块snmpc包含到SNMP工具包MIB编译器的接口函数。

输出

compile(File)compile(File, Options) -> {ok, BinFileName} | {error, Reason}

类型

编译指定的MIB文件<File> .mib。 编译的文件BinFileName称为<File> .bin。

  • 选项db指定哪个数据库应该用于默认检测。默认是易失性的。

  • 该选项deprecated指定是否应保留不推荐的定义。如果该选项为false,则MIB编译器将忽略所有弃用的定义。

默认是true

  • 该选项relaxed_row_name_assign_check(如果存在)指定行名称分配检查不应严格按照SMI(只允许值1)进行。使用此选项,允许所有大于零的值(> = 1)。这意味着错误将被转换为警告。默认情况下,它不包括在内,但是如果这个选项存在的话。

  • 选择description指定是否包含描述字段的文本。

默认情况下,它不包括在内,但如果存在此选项,则将包含此选项。

  • 该选项reference指定是否将包含REFERENCE字段的文本(在表定义中找到该文本时)。默认情况下,它不包括在内,但是如果这个选项存在的话。参考文本将被放置在表的mib条目记录(#me {})的allocList字段中。

  • 选择group_check指定MIB编译器是否应检查对象组宏和通知组宏是否正确。

默认是true

  • 该选项i指定搜索导入(编译)的MIB文件的路径。目录应该是具有尾随目录分隔符的字符串。默认是["./"]

  • 选项il(include_lib)还指定要搜索导入的MIB的目录列表。它假定目录名称中的第一个元素对应于一个OTP应用程序。编译器会找到当前安装的版本。例如,值“snmp / mibs /”将被替换为“snmp-3.1.1 / mibs /”。当前目录和<snmp-home>/priv/mibs/总是在包含路径中最后列出。

  • 该选项imports(如果存在)指定MIB的IMPORT语句应包含在已编译的mib中。

  • 该选项module(如果存在)指定实现MIB的所有仪器功能的模块的名称。

所有插装函数的名称必须与其实现的相应托管对象相同。

  • 该选项module_identity(如果存在)指定MIB的MODULE-IDENTITY语句的info部分应包含在已编译的mib中。

  • 该选项module_compliance(如果存在)指定MIB中的MODULE-COMPLIANCE语句应该包含在编译后的mib中(带有mib-entry记录)。模块合规性的mib条目记录将包含referencemodule部分该assocList字段中的此信息)。

  • 该选项agent_capabilities(如果存在)指定MIB中的AGENT-CAPABILITIES语句应该包含在编译后的mib中(带有mib条目记录)。agent-capabilitie的mib-entry记录将包含referencemodules部分在该assocList领域中的这个信息)。

  • 选择no_defs如果存在,则指定如果托管对象没有插装函数,则不应使用默认的插装函数,而是将其报告为错误,并且编译将中止。

  • 该选项verbosity指定SNMP mib编译器的详细程度。也就是说,如果警告,信息,日志,调试和跟踪消息应显示。默认是silence。请注意,如果选项warningstrue,并且选项verbositysilence,则仍会显示警告消息。

  • 选择warnings指定是否应显示警告消息。

默认值是true...

  • 选择warnings_as_errors如果存在,则指定是否应将警告视为错误。

MIB编译器同时理解SMIv 1和SMIv 2 MIB。它使用MODULE-IDENTITY语句来确定MIB是版本1还是版本2。

可以使用该命令从OS命令行调用MIB编译器erlcerlc识别扩展名.mib,并为具有该扩展名的文件调用SNMP MIB编译器。选项dbgroup_checkdeprecateddescriptionverbosityimportsmodule_identity必须被指定erlc使用的语法+term。详情请参阅erlc(1)

is_consistent(Mibs) -> ok | {error, Reason}

类型

检查MIB之间对象标识符和陷阱的多次使用。

mib_to_hrl(MibName) -> ok | {error, Reason}

类型

使用MIB中对象的Erlang常量定义生成一个.hrl文件。 .hrl文件被称为<MibName> .hrl。 MIB必须被编译并存在于当前目录中。

所述mib_to_hrl发生器可以从OS的命令行通过使用命令调用erlcerlc识别扩展名.bin,并为具有该扩展名的文件调用此函数。

另见

erlc(1)