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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>snmpa_supervisor</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>snmpa_supervisor</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmpa_supervisor
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
A supervisor for the SNMP agent Processes
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P>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 subagent).
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="start_sub_sup/1"><STRONG><CODE>start_sub_sup(Opts) -> {ok, pid()} | {error,
{already_started, pid()}} | {error, Reason}</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Opts = [opt()]</CODE></STRONG><BR>
<STRONG><CODE>opt() = {db_dir, string()} | ...</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Starts a supervisor for the SNMP agent system without a
master agent. The supervisor starts all involved SNMP
processes, but no agent processes. Subagents should be
started by calling <CODE>start_sub_agent/3</CODE>.
<P><CODE>db_dir</CODE> is mandatory.
<P>See <A HREF="snmp_config.html#configuration_params">configuration parameters</A> for
a description of the options.
</DIV>
<P><A NAME="start_master_sup/1"><STRONG><CODE>start_master_sup(Opts) -> {ok, pid()} |
{error, {already_started, pid()}} | {error, Reason}</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Opts = [opt()]</CODE></STRONG><BR>
<STRONG><CODE>opt() = {db_dir, string()} | {config, ConfOpts()} | ...</CODE></STRONG><BR>
<STRONG><CODE>ConfOpts = [conf_opts()]</CODE></STRONG><BR>
<STRONG><CODE>conf_opts() = {dir, string()} | ...</CODE></STRONG><BR>
<STRONG><CODE>Reasin = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Starts a supervisor for the SNMP agent system. The
supervisor starts all involved SNMP processes, including the
master agent. Subagents should be started by calling
<CODE>start_subagent/3</CODE>.
<P><CODE>db_dir</CODE> is mandatory.
<P><CODE>dir</CODE> in config is mandatory.
<P>See <A HREF="snmp_config.html">snmp config</A> for
a description of the options.
</DIV>
<P><A NAME="start_sub_agent/3"><STRONG><CODE>start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} |
{error, Reason}</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ParentAgent = pid()</CODE></STRONG><BR>
<STRONG><CODE>SubTree = oid()</CODE></STRONG><BR>
<STRONG><CODE>Mibs = [MibName]</CODE></STRONG><BR>
<STRONG><CODE>MibName = [string()]</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Starts a subagent on the node where the function is
called. The <CODE>snmpa_supervisor</CODE> must be running.
<P>If the supervisor is not running, the function fails with the
reason <CODE>badarg</CODE>.
</DIV>
<P><A NAME="stop_sub_agent/1"><STRONG><CODE>stop_sub_agent(SubAgent) -> ok | no_such_child</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SubAgent = pid()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Stops the subagent on the node where the function is
called. The <CODE>snmpa_supervisor</CODE> must be running.
<P>If the supervisor is not running, the function fails with the
reason <CODE>badarg</CODE>.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Micael Karlberg - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright © 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
