snmpa_notification_delivery_info_receiver(3erl) [linux man page]

snmpa_notification_delivery_info_receiver(3erl) 	     Erlang Module Definition		   snmpa_notification_delivery_info_receiver(3erl)

NAME

       snmpa_notification_delivery_info_receiver -
	   Behaviour module for the SNMP agent notification delivery
	   information receiver.

DESCRIPTION

       This module defines the behaviour of the notification delivery information receiver.

       A snmpa_notification_delivery_info_receiver compliant module must export the following functions:

	 * delivery_targets/3

	 * delivery_info/4

       The semantics of them and their exact signatures are explained below.

DATA TYPES

       address() = A 4-tuple

EXPORTS

       delivery_targets(Tag, Targets, Extra) -> void()

	      Types  Tag = term()
		     Targets = [target()]
		     target() = {Address, Port}
		     Address = address()
		     Port = integer()
		     Extra = term()

	      Inform about target addresses.

	      This  is	the  first function called when a notification delivery is in progress. It informs the receiver which targets will get the
	      notification. The result of the delivery will be provided via successive calls to delivery_info/4 function, see below.

       delivery_info(Tag, Target, DeliveryResult, Extra) -> void()

	      Types  Tag = term()
		     Target = target()
		     target() = {Address, Port}
		     Address = address()
		     Port = integer()
		     DeliveryResult = delivery_result()
		     delivery_result() = no_response | got_response
		     Extra = term()

	      Inform about delivery result.

	      This function is called for each target in the Targets argument of the delivery_targets/3 function, see above.

	      The purpose is to inform the receiver of the result of the delivery (was the notification acknowledged or not) for each target.

Ericsson AB							     snmp 4.19			   snmpa_notification_delivery_info_receiver(3erl)

snmp_target_mib(3erl)					     Erlang Module Definition					     snmp_target_mib(3erl)

NAME

       snmp_target_mib - Instrumentation Functions for SNMP-TARGET-MIB

DESCRIPTION

       The module snmp_target_mib implements the instrumentation functions for the SNMP-TARGET-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 files read are: target_addr.conf and target_params.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 non-
	      Volatile . The rows created from the configuration file will have StorageType nonVolatile .

	      Thus, the data in the SNMP-TARGET-MIB, after this function has been called, is the data 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 , 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 files read are: target_addr.conf and target_params.conf .

       set_target_engine_id(TargetAddrName, EngineId) -> boolean()

	      Types  TargetAddrName = string()
		     EngineId = string()

	      Changes the engine id for a target in the snmpTargetAddrTable . If notifications are sent as Inform requests to a target, its engine
	      id must be set.

       add_addr(Name, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret

	      Types  Name = string()
		     Ip = [integer()], length 4
		     Port = integer()
		     Timeout = integer()
		     Retry = integer()
		     TagList = string()
		     ParamsName = string()
		     EngineId = string()
		     TMask = string(), length 0 or 6
		     MMS = integer()
		     Ret = {ok, Key} | {error, Reason}
		     Key = term()
		     Reason = term()

	      Adds a target address definition to the agent config. Equivalent to one line in the target_addr.conf file.

       delete_addr(Key) -> Ret

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

	      Delete a target address definition from the agent config.

       add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret

	      Types  Name = string()
		     MPModel = v1 | v2c | v3
		     SecModel = v1 | v2c | usm
		     SecName = string()
		     SecLevel = noAuthNoPriv | authNoPriv | authPriv
		     Ret = {ok, Key} | {error, Reason}
		     Key = term()
		     Reason = term()

	      Adds a target parameter definition to the agent config. Equivalent to one line in the target_params.conf file.

       delete_params(Key) -> Ret

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

	      Delete a target parameter definition from the agent config.

Ericsson AB							     snmp 4.19						     snmp_target_mib(3erl)