bionic (3) snmp_notification_mib.3erl.gz

NAME

       snmp_notification_mib - Instrumentation Functions for SNMP-NOTIFICATION-MIB

DESCRIPTION

       The  module snmp_notification_mib implements the instrumentation functions 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
              nonVolatile.

              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 configuration 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 configuration 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.