bionic (3) snmp_standard_mib.3erl.gz

NAME

       snmp_standard_mib - Instrumentation Functions for STANDARD-MIB and SNMPv2-MIB

DESCRIPTION

       The   module  snmp_standard_mib  implements  the  instrumentation  functions  for  the  STANDARD-MIB  and
       SNMPv2-MIB, and functions for configuring the database.

       The configuration files are described in the SNMP User's Manual.

EXPORTS

       configure(ConfDir) -> void()

              Types:

                 ConfDir = string()

              This function is called from the supervisor at system start-up.

              Inserts all data in the configuration files into the database  and  destroys  all  old  rows  with
              StorageType  volatile.  The  rows  created  from  the  configuration  file  will  have StorageType
              nonVolatile.

              All snmp counters are set to zero.

              If an error is found in the configuration file, it is reported using the function config_err/2  of
              the error report module, and the function fails with the reason configuration_error.

              ConfDir is a string which points to the directory where the configuration files are found.

              The configuration file read is: standard.conf.

       inc(Name) -> void()
       inc(Name, N) -> void()

              Types:

                 Name = atom()
                 N = integer()

              Increments a variable in the MIB with N, or one if N is not specified.

       reconfigure(ConfDir) -> void()

              Types:

                 ConfDir = string()

              Inserts all data in the configuration files into the database and destroys all old data, including
              the rows with StorageType nonVolatile. The rows created from  the  configuration  file  will  have
              StorageType nonVolatile.

              Thus,  the  data  in the SNMP-STANDARD-MIB and SNMPv2-MIB, after this function has been called, is
              from the configuration files.

              All snmp counters are set to zero.

              If an error is found in the configuration file, it is reported using the function config_err/2  of
              the error report module, and the function fails with the reason configuration_error.

              ConfDir is a string which points to the directory where the configuration files are found.

              The configuration file read is: standard.conf.

       reset() -> void()

              Resets all snmp counters to 0.

       sys_up_time() -> Time

              Types:

                 Time = int()

              Gets the system up time in hundredth of a second.