From d7c6e2781c64e5e75add8a89d1b553bd5e9283f1 Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Fri, 18 Feb 2011 19:18:12 +0100 Subject: Lost of fixes... *) Update release notes (with regard to module_compliance) *) New compiler options: agent_capabilities and module_compliance *) Update mib compiler option description (new options for agent_capabilities and module_compliance) *) New test case for module_compliance. *) Added test mib for module_complianc test case. *) Added some options for the MIB makefile. ... --- lib/snmp/doc/src/snmpc.xml | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) (limited to 'lib/snmp/doc/src/snmpc.xml') diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml index fbd0950c69..e33828326a 100644 --- a/lib/snmp/doc/src/snmpc.xml +++ b/lib/snmp/doc/src/snmpc.xml @@ -4,7 +4,7 @@
- 20042010 + 20042011 Ericsson AB. All Rights Reserved. @@ -37,6 +37,7 @@

The module snmpc contains interface functions to the SNMP toolkit MIB compiler.

+ @@ -47,7 +48,7 @@ File = string() Options = [opt()] - opt() = db() | relaxed_row_name_assign_check() | deprecated() | description() | reference() | group_check() | i() | il() | imports() | module() | module_identity() | outdir() | no_defs() | verbosity() | warnings() + opt() = db() | relaxed_row_name_assign_check() | deprecated() | description() | reference() | group_check() | i() | il() | imports() | module() | module_identity() | module_compliance() | agent_capabilities() | outdir() | no_defs() | verbosity() | warnings() db() = {db, volatile|persistent|mnesia} deprecated() = {deprecated, bool()} relaxed_row_name_assign_check() = relaxed_row_name_assign_check @@ -59,6 +60,8 @@ imports() = imports module() = {module, atom()} module_identity() = module_identity + module_compliance() = module_compliance + agent_capabilities() = agent_capabilities no_defs() = no_defs outdir() = {outdir, dir()} verbosity() = {verbosity, silence|warning|info|log|debug|trace} @@ -77,6 +80,7 @@ be used for the default instrumentation.

Default is volatile.

+

The option deprecated specifies if a deprecated definition should be kept or not. If the option is @@ -84,6 +88,7 @@ definitions.

Default is true.

+

The option relaxed_row_name_assign_check, if present, specifies that the row name assign check shall not be done @@ -94,12 +99,14 @@

By default it is not included, but if this option is present it will be.

+

The option description specifies if the text of the DESCRIPTION field will be included or not.

By default it is not included, but if this option is present it will be.

+

The option reference specifies if the text of the REFERENCE field, when found in a table definition, @@ -108,18 +115,21 @@ it will be. The reference text will be placed in the allocList field of the mib-entry record (#me{}) for the table.

+

The option group_check specifies whether the mib compiler should check the OBJECT-GROUP macro and the NOTIFICATION-GROUP macro for correctness or not.

Default is true.

+

The option i specifies the path to search for imported (compiled) MIB files. The directories should be strings with a trailing directory delimiter.

Default is ["./"].

+

The option il (include_lib) also specifies a list of directories to search for imported MIBs. It @@ -132,11 +142,13 @@ /priv/mibs/]]> are always listed last in the include path.

+

The option imports, if present, specifies that the IMPORT statement of the MIB shall be included in the compiled mib.

+

The option module, if present, specifies the name of a module which implements all instrumentation @@ -145,11 +157,29 @@ functions must be the same as the corresponding managed object it implements.

+

The option module_identity, if present, specifies that the info part of the MODULE-IDENTITY statement of the MIB shall be included in the compiled mib.

+ + +

The option module_compliance, if present, specifies + that the MODULE-COMPLIANCE statement of the MIB shall be included + (with a mib-entry record) in the compiled mib. The mib-entry record + of the module-compliance will contain reference and module + part(s) this info in the assocList field).

+ + + +

The option agent_capabilities, if present, specifies + that the AGENT-CAPABILITIES statement of the MIB shall be included + (with a mib-entry record) in the compiled mib. The mib-entry record + of the agent-capabilitie will contain reference and modules + part(s) this info in the assocList field).

+ +

The option no_defs, if present, specifies that if a managed object does not have an instrumentation @@ -157,6 +187,7 @@ be used, instead this is reported as an error, and the compilation aborts.

+

The option verbosity specifies the verbosity of the SNMP mib compiler. I.e. if warning, info, log, debug @@ -166,11 +197,13 @@ option verbosity is silence, warning messages will still be shown.

+

The option warnings specifies whether warning messages should be shown.

Default is true.

+

The MIB compiler understands both SMIv1 and SMIv2 MIBs. It uses the MODULE-IDENTITY statement to determine if the MIB is @@ -185,8 +218,11 @@ have to be specified to erlc using the syntax +term. See erlc(1) for details.

+ + + is_consistent(Mibs) -> ok | {error, Reason} Check for OID conflicts between MIBs @@ -198,8 +234,11 @@

Checks for multiple usage of object identifiers and traps between MIBs.

+ + + mib_to_hrl(MibName) -> ok | {error, Reason} Generate constants for the objects in the MIB -- cgit v1.2.3