1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
.TH snmpa_supervisor 3 "snmp 4.11" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
snmpa_supervisor \- A supervisor for the SNMP agent Processes
.SH DESCRIPTION
.LP
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 (master agent or sub-agent)\&.
.SH EXPORTS
.LP
.B
start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason}
.br
.RS
.TP
Types
Opts = [opt()]
.br
opt() = {db_dir, string()} | \&.\&.\&.
.br
.RE
.RS
.LP
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 \fIstart_sub_agent/3\fR\&.
.LP
\fIdb_dir\fR is mandatory\&.
.LP
See configuration parameters for a description of the options\&.
.RE
.LP
.B
start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason}
.br
.RS
.TP
Types
Opts = [opt()]
.br
opt() = {db_dir, string()} | {config, ConfOpts()} | \&.\&.\&.
.br
ConfOpts = [conf_opts()]
.br
conf_opts() = {dir, string()} | \&.\&.\&.
.br
Reason = term()
.br
.RE
.RS
.LP
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 \fIstart_subagent/3\fR\&.
.LP
\fIdb_dir\fR is mandatory\&.
.LP
\fIdir\fR in config is mandatory\&.
.LP
See snmp config for a description of the options\&.
.RE
.LP
.B
start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason}
.br
.RS
.TP
Types
ParentAgent = pid()
.br
SubTree = oid()
.br
Mibs = [MibName]
.br
MibName = [string()]
.br
.RE
.RS
.LP
Starts a sub-agent on the node where the function is called\&. The \fIsnmpa_supervisor\fR must be running\&.
.LP
If the supervisor is not running, the function fails with the reason \fIbadarg\fR\&.
.RE
.LP
.B
stop_sub_agent(SubAgent) -> ok | no_such_child
.br
.RS
.TP
Types
SubAgent = pid()
.br
.RE
.RS
.LP
Stops the sub-agent on the node where the function is called\&. The \fIsnmpa_supervisor\fR must be running\&.
.LP
If the supervisor is not running, the function fails with the reason \fIbadarg\fR\&.
.RE
|
