Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

snmp_notification_mib (3erl)

Name

snmp_notification_mib - TION-MIB

Synopsis

Please see following description for synopsis

Description

snmp_notification_mib(3)   Erlang Module Definition   snmp_notification_mib(3)



NAME
       snmp_notification_mib  -  Instrumentation  Functions for SNMP-NOTIFICA-
       TION-MIB

DESCRIPTION
       The module snmp_notification_mib implements the  instrumentation  func-
       tions  for the SNMP-NOTIFICATION-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  non-
              Volatile.

              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 reason configuration_error.

              ConfDir is a string which points to the directory where the con-
              figuration files are found.

              The configuration file read is: notify.conf.

       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-NOTIFICATION-MIB, after this function
              has been called, is from the configuration files.

              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 reason configuration_error.

              ConfDir is a string which points to the directory where the con-
              figuration files are found.

              The configuration file read is: notify.conf.

       add_notify(Name, Tag, Type) -> Ret

              Types:

                 Name = string()
                 Tag = string()
                 Type = trap | inform
                 Ret = {ok, Key} | {error, Reason}
                 Key = term()
                 Reason = term()

              Adds  a notify definition to the agent config. Equivalent to one
              line in the notify.conf file.

       delete_notify(Key) -> Ret

              Types:

                 Key = term()
                 Ret = ok | {error, Reason}
                 Reason = term()

              Delete a notify definition from the agent config.



Ericsson AB                        snmp 5.11          snmp_notification_mib(3)