snmpm_network_interface(3erl) [linux man page]

snmpm_network_interface(3erl)				     Erlang Module Definition				     snmpm_network_interface(3erl)

NAME

       snmpm_network_interface - Behaviour module for the SNMP manager network interface.

DESCRIPTION

       This  module  defines  the behaviour of the manager network interface. A snmpm_network_interface compliant module must export the following
       functions:

	 * start_link/2

	 * stop/1

	 * send_pdu/7

	 * inform_response/4

	 * note_store/2

	 * info/1

	 * get_log_type/1

	 * set_log_type/2

	 * verbosity/2

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

EXPORTS

       start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason}

	      Types  Server = pid()
		     NoteStore = pid()

	      Start-link the network interface process.

	      Server is the pid of the managing process.

	      NoteStore is the pid of the note-store process.

       stop(Pid) -> void()

	      Types  Pid = pid()

	      Stop the network interface process.

       send_pdu(Pid, Pdu, Vsn, MsgData, Addr, Port, ExtraInfo) -> void()

	      Types  Pid = pid()
		     Pdu = pdu()
		     Vsn = 'version-1' | 'version-2' | 'version-3'
		     MsgData = term()
		     Addr = address()
		     Port = integer()
		     ExtraInfo = term()

	      Request the network interface process ( Pid ) to send this pdu ( Pdu ).

	      ExtraInfo is some opaque data that is passed to the net-if process. It originates from the ExtraInfo parameter in the calls  to  the
	      synchronous get-request , asynchronous get-request , synchronous get-next-request , asynchronous get-next-request , synchronous set-
	      request and asynchronous set-request functions. Whether the net-if process chooses to use this is implementation dependent. The net-
	      if process included in this application ignores it.

       inform_response(Pid, Ref, Addr, Port) -> void()

	      Types  Pid = pid()
		     Ref = term()
		     Addr = address()
		     Port = integer()

	      Instruct the network interface process to send the response (acknowledgment) to an inform-request.

	      Ref is something that can be used to identify the inform-request, e.g. request-id of the inform-request.

	      Addr and Port identifies the agent, from which the inform-request originated.

       note_store(Pid, NoteStore) -> void()

	      Types  Pid = pid()
		     NoteStore = pid()

	      Change the pid of the note-store process. This is used when the server re-starts the note_store (e.g. after a crach).

       info(Pid) -> [{Key, Value}]

	      Types  Pid = pid()

	      The  info returned is basically up to the implementer to decide. The implementation provided by this application provides info about
	      memory allocation and various socket information.

	      The info returned by this function is returned together with other info collected by the manager when the info  function	is  called
	      (tagged with the key net_if ).

       verbosity(Pid, Verbosity) -> void()

	      Types  Pid = pid()
		     Verbosity = verbosity()

	      Change the verbosity of the network interface process.

       get_log_type(Pid) -> {ok, LogType} | {error, Reason}

	      Types  Pid = pid()
		     LogType = atl_type()
		     Reason = term()

	      The Audit Trail Log is managed by the network interface process. So, it is this process that has to return the actual log-type.

       set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason}

	      Types  Pid = pid()
		     NewType = OldType = atl_type()
		     Reason = term()

	      The  Audit  Trail  Log is managed by the network interface process. So, it is this process that has to do the actual changing of the
	      type.

	      See set_log_type for more info.

Ericsson AB							     snmp 4.19					     snmpm_network_interface(3erl)

snmpa_mpd(3erl) 					     Erlang Module Definition						   snmpa_mpd(3erl)

NAME

       snmpa_mpd - Message Processing and Dispatch module for the SNMP agent

DESCRIPTION

       The module snmpa_mpd implements the version independent Message Processing and Dispatch functionality in SNMP for the agent. It is supposed
       to be used from a Network Interface process ( Definition of Agent Net if ).

EXPORTS

       init(Vsns) -> mpd_state()

	      Types  Vsns = [Vsn]
		     Vsn = v1 | v2 | v3

	      This function can be called from the net_if process at start-up. The options list defines which versions to use.

	      It also initializes some SNMP counters.

       process_packet(Packet, TDomain, TAddress, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, Dis-
       coPacket}
       process_packet(Packet,  TDomain,  TAddress, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} |
       {discovery, DiscoPacket}

	      Types  Packet = binary()
		     TDomain = snmpUDPDomain
		     TAddress = {Ip, Udp}
		     LocalEngineID = string()
		     Ip = {integer(), integer(), integer(), integer()}
		     Udp = integer()
		     State = mpd_state()
		     NoteStore = pid()
		     Log = snmp_log()
		     Vsn = 'version-1' | 'version-2' | 'version-3'
		     Pdu = #pdu
		     PduMs = integer()
		     ACMData = acm_data()
		     Reason = term()
		     DiscoPacket = binary()

	      Processes an incoming packet. Performs authentication and decryption as necessary. The return values should be passed the agent.

   Note:
       Note that the use of the LocalEngineID argument is only intended for special cases, if the agent is to  "emulate"  multiple  EngineIDs!	By
       default, the agent uses the value of SnmpEngineID (see SNMP-FRAMEWORK-MIB).

       generate_response_msg(Vsn, RePdu, Type, ACMData, Log) -> {ok, Packet} | {discarded, Reason}
       generate_response_msg(Vsn, RePdu, Type, ACMData, LocalEngineID, Log) -> {ok, Packet} | {discarded, Reason}

	      Types  Vsn = 'version-1' | 'version-2' | 'version-3'
		     RePdu = #pdu
		     Type = atom()
		     ACMData = acm_data()
		     LocalEngineID = string()
		     Packet = binary()

	      Generates a possibly encrypted response packet to be sent to the network. Type is the #pdu.type of the original request.

   Note:
       Note  that  the	use  of the LocalEngineID argument is only intended for special cases, if the agent is to "emulate" multiple EngineIDs! By
       default, the agent uses the value of SnmpEngineID (see SNMP-FRAMEWORK-MIB).

       generate_msg(Vsn, NoteStore, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}
       generate_msg(Vsn, NoteStore, Pdu, MsgData, LocalEngineID, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}

	      Types  Vsn = 'version-1' | 'version-2' | 'version-3'
		     NoteStore = pid()
		     Pdu = #pdu
		     MsgData = msg_data()
		     LocalEngineID = string()
		     To = [dest_addrs()]
		     PacketsAndAddresses = [{TDomain, TAddress, Packet}]
		     TDomain = snmpUDPDomain
		     TAddress = {Ip, Udp}
		     Ip = {integer(), integer(), integer(), integer()}
		     Udp = integer()
		     Packet = binary()

	      Generates a possibly encrypted request packet to be sent to the network.

	      MsgData is the message specific data used in the SNMP message. This value is received in a send_pdu or send_pdu_req message from the
	      agent.  In  SNMPv1 and SNMPv2c, this message data is the community string. In SNMPv3, it is the context information. To is a list of
	      the destination addresses and their corresponding security parameters. This value is  also  received  from  the  requests  mentioned
	      above.

   Note:
       Note  that  the	use  of the LocalEngineID argument is only intended for special cases, if the agent is to "emulate" multiple EngineIDs! By
       default, the agent uses the value of SnmpEngineID (see SNMP-FRAMEWORK-MIB).

       discarded_pdu(Variable) -> void()

	      Types  Variable = atom()

	      Increments the variable associated with a discarded pdu. This function can be used when the net_if process receives a  discarded_pdu
	      message from the agent.

Ericsson AB							     snmp 4.19							   snmpa_mpd(3erl)