From c396e2ae941c7702cf3e810a8ad0d1ac619804ed Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Fri, 25 May 2018 14:53:38 +0200 Subject: [snmp+otp_mibs] Moved mib and update system doc Moved the (final) OTP-TC mib from the otp_mibs app to the snmp app. Also basic update to the system (oam) documentation. OTP-14984 --- system/doc/oam/oam_intro.xml | 55 +++++++++++++------------------------------- 1 file changed, 16 insertions(+), 39 deletions(-) (limited to 'system/doc') diff --git a/system/doc/oam/oam_intro.xml b/system/doc/oam/oam_intro.xml index ead8c026b9..3d08a5f3b1 100644 --- a/system/doc/oam/oam_intro.xml +++ b/system/doc/oam/oam_intro.xml @@ -4,7 +4,7 @@
- 19972017 + 19972018 Ericsson AB. All Rights Reserved. @@ -178,7 +178,7 @@
MIB Structure

The top-level OTP MIB is called OTP-REG and it is - included in the SASL application. All other OTP MIBs + included in the SNMP application. All other OTP MIBs import some objects from this MIB.

Each MIB is contained in one application. The MIB text @@ -186,67 +186,44 @@ the application directory. The generated .hrl files with constant declarations are stored under .hrl]]>, and the compiled MIBs - are stored under .bin]]>. - For example, the OTP-MIB is included in the - SASL application:

+ are stored under .bin]]>.

- -sasl-1.3/mibs/OTP-MIB.mib -include/OTP-MIB.hrl -priv/mibs/OTP-MIB.bin - -

An application that needs to import this MIB into another +

An application that needs to import an MIB into another MIB is to use the il option to the SNMP MIB compiler:

-snmp:c("MY-MIB", [{il, ["sasl/priv/mibs"]}]). +snmp:c("MY-MIB", [{il, ["snmp/priv/mibs"]}]). -

If the application needs to include the generated +

If the application needs to include a generated .hrl file, it is to use the -include_lib directive to the Erlang compiler:

-module(my_mib). --include_lib("sasl/include/OTP-MIB.hrl"). +-include_lib("snmp/include/OTP-REG.hrl"). -

The following MIBs are defined in the OTP system:

+

Here is a list of some of the MIBs defined in the OTP system:

-

OTP-REG (in SASL) contains the top-level +

OTP-REG (in SNMP) contains the top-level OTP registration objects, used by all other MIBs.

 -

OTP-TC (in SASL) contains the general +

OTP-TC (in SNMP) contains the general Textual Conventions, which can be used by any other MIB.

 -

OTP-MIB (in SASL) contains objects for - instrumentation of the Erlang nodes, the Erlang machines, - and the applications in the system.

 -

OTP-OS-MON-MIB (in oc_mon) contains - objects for instrumentation of disk, memory, and CPU use - of the nodes in the system.

OTP-SNMPEA-MIB (in snmp) contains objects for instrumentation and control of the extensible SNMP agent itself. The agent also implements the standard SNMPv2-MIB (or v1 part of MIB-II, if SNMPv1 is used).

 -

OTP-EVA-MIB (in eva) contains objects - for instrumentation and control of the events and alarms in - the system.

 -

OTP-LOG-MIB (in eva) contains objects - for instrumentation and control of the logs and FTP transfer of - logs.

 -

OTP-EVA-LOG-MIB (in eva) contains objects - for instrumentation and control of the events and alarm logs - in the system.

 -

OTP-SNMPEA-LOG-MIB (in eva) contains - objects for instrumentation and control of the SNMP audit - trail log in the system.

The different applications use different strategies for loading the MIBs into the agent. Some MIB implementations are code-only, while others need a server. One way, used by the code-only MIB implementations, is for the user to call a - function such as otp_mib:load(Agent) to load the MIB, - and otp_mib:unload(Agent) to unload the MIB. See the - manual page for each application for a description of how - to load each MIB.

+ function such as + snmpa:unload_mibs(Agent, [Mib]) + to load the MIB, and + snmpa:unload_mibs(Agent, [Mib]) + to unload the MIB. See the manual page for each application for + a description of how to load each MIB.

-- cgit v1.2.3