1snmpa_supervisor(3)        Erlang Module Definition        snmpa_supervisor(3)
2
3
4

NAME

6       snmpa_supervisor - A supervisor for the SNMP agent Processes
7

DESCRIPTION

9       This  is the top supervisor for the agent part of the SNMP application.
10       There is always one supervisor at each node with an SNMP agent  (master
11       agent or sub-agent).
12

EXPORTS

14       start_sub_sup(Opts)  -> {ok, pid()} | {error, {already_started, pid()}}
15       | {error, Reason}
16
17              Types:
18
19                 Opts = [opt()]
20                 opt() = {db_dir, string()} | ...
21
22              Starts a supervisor for the SNMP agent system without  a  master
23              agent. The supervisor starts all involved SNMP processes, but no
24              agent  processes.  Sub-agents  should  be  started  by   calling
25              start_sub_agent/3.
26
27              db_dir is mandatory.
28
29              See configuration parameters for a description of the options.
30
31       start_master_sup(Opts)  ->  {ok,  pid()}  |  {error,  {already_started,
32       pid()}} | {error, Reason}
33
34              Types:
35
36                 Opts = [opt()]
37                 opt() = {db_dir, string()} | {config, ConfOpts()} | ...
38                 ConfOpts = [conf_opts()]
39                 conf_opts() = {dir, string()} | ...
40                 Reason = term()
41
42              Starts a supervisor for the SNMP agent  system.  The  supervisor
43              starts  all involved SNMP processes, including the master agent.
44              Sub-agents should be started by calling start_subagent/3.
45
46              db_dir is mandatory.
47
48              dir in config is mandatory.
49
50              See snmp config for a description of the options.
51
52       start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Rea‐
53       son}
54
55              Types:
56
57                 ParentAgent = pid()
58                 SubTree = oid()
59                 Mibs = [MibName]
60                 MibName = [string()]
61
62              Starts a sub-agent on the node where the function is called. The
63              snmpa_supervisor must be running.
64
65              If the supervisor is not running, the function  fails  with  the
66              reason badarg.
67
68       stop_sub_agent(SubAgent) -> ok | no_such_child
69
70              Types:
71
72                 SubAgent = pid()
73
74              Stops  the  sub-agent  on the node where the function is called.
75              The snmpa_supervisor must be running.
76
77              If the supervisor is not running, the function  fails  with  the
78              reason badarg.
79
80
81
82Ericsson AB                        snmp 5.8                snmpa_supervisor(3)
Impressum