snmpa_supervisor(3erl) [linux man page]

snmpa_supervisor(3erl)					     Erlang Module Definition					    snmpa_supervisor(3erl)

NAME

       snmpa_supervisor - A supervisor for the SNMP agent Processes

DESCRIPTION

       This is the top supervisor for the agent part of the SNMP application. There is always one supervisor at each node with an SNMP agent (mas-
       ter agent or sub-agent).

EXPORTS

       start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason}

	      Types  Opts = [opt()]
		     opt() = {db_dir, string()} | ...

	      Starts a supervisor for the SNMP agent system without a master agent. The supervisor starts all  involved  SNMP  processes,  but	no
	      agent processes. Sub-agents should be started by calling start_sub_agent/3 .

	      db_dir is mandatory.

	      See configuration parameters for a description of the options.

       start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason}

	      Types  Opts = [opt()]
		     opt() = {db_dir, string()} | {config, ConfOpts()} | ...
		     ConfOpts = [conf_opts()]
		     conf_opts() = {dir, string()} | ...
		     Reason = term()

	      Starts  a  supervisor for the SNMP agent system. The supervisor starts all involved SNMP processes, including the master agent. Sub-
	      agents should be started by calling start_subagent/3 .

	      db_dir is mandatory.

	      dir in config is mandatory.

	      See snmp config for a description of the options.

       start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason}

	      Types  ParentAgent = pid()
		     SubTree = oid()
		     Mibs = [MibName]
		     MibName = [string()]

	      Starts a sub-agent on the node where the function is called. The snmpa_supervisor must be running.

	      If the supervisor is not running, the function fails with the reason badarg .

       stop_sub_agent(SubAgent) -> ok | no_such_child

	      Types  SubAgent = pid()

	      Stops the sub-agent on the node where the function is called. The snmpa_supervisor must be running.

	      If the supervisor is not running, the function fails with the reason badarg .

Ericsson AB							     snmp 4.19						    snmpa_supervisor(3erl)

Check Out this Related Man Page

snmp_framework_mib(3erl)				     Erlang Module Definition					  snmp_framework_mib(3erl)

NAME

       snmp_framework_mib - Instrumentation Functions for SNMP-FRAMEWORK-MIB

DESCRIPTION

       The module snmp_framework_mib implements instrumentation functions for the SNMP-FRAMEWORK-MIB, and functions for initializing and configur-
       ing 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 data.

	      Thus, the data in the SNMP-FRAMEWORK-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 reason configuration_error .

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

	      The configuration file read is: context.conf .

       init() -> void()

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

	      Creates the necessary objects in the database if they do not exist. It does not destroy any old values.

       add_context(Ctx) -> Ret

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

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

       delete_context(Key) -> Ret

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

	      Delete a context from the agent config.

Ericsson AB							     snmp 4.19						  snmp_framework_mib(3erl)

Linux and UNIX Man Pages

snmpa_supervisor(3erl) [linux man page]

Check Out this Related Man Page