File: snmp_standard_mib.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (187 lines) | stat: -rw-r--r-- 4,602 bytes parent folder | download
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmp_standard_mib</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>snmp_standard_mib</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmp_standard_mib
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Instrumentation Functions for STANDARD-MIB and
SNMPv2-MIB
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>The module <CODE>snmp_standard_mib</CODE> implements the instrumentation functions for the
STANDARD-MIB and SNMPv2-MIB, and functions for configuring the database.


<P>The configuration files are described in the SNMP User's Manual.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="configure/1"><STRONG><CODE>configure(ConfDir) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ConfDir = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

        
<P>Inserts all data in the configuration files into the
        database and destroys all old rows with StorageType
        <CODE>volatile</CODE>. The rows created from the configuration file
        will have StorageType <CODE>nonVolatile</CODE>.

        
<P>All <CODE>snmp</CODE> counters are set to zero.

        
<P>If an error is found in the configuration file, it is
         reported using the function <CODE>config_err/2</CODE> of the error 
         report module, and the function fails with the reason 
         <CODE>configuration_error</CODE>.

        
<P><CODE>ConfDir</CODE> is a string which points to the directory
        where the configuration files are found.


<P>The configuration file read is: <CODE>standard.conf</CODE>.


</DIV>

<P><A NAME="inc/1"><STRONG><CODE>inc(Name) -&#62; void()</CODE></STRONG></A><BR>
<A NAME="inc/2"><STRONG><CODE>inc(Name, N) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>N = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Increments a variable in the MIB with <CODE>N</CODE>, or one if
        <CODE>N</CODE> is not specified.

</DIV>

<P><A NAME="reconfigure/1"><STRONG><CODE>reconfigure(ConfDir) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ConfDir = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Inserts all data in the configuration files into the
        database and destroys all old data, including the rows with
        StorageType <CODE>nonVolatile</CODE>. The rows created from the
        configuration file will have StorageType <CODE>nonVolatile</CODE>.


<P>Thus, the data in the SNMP-STANDARD-MIB and SNMPv2-MIB,
        after this function has been called, is from the
        configuration files.

        
<P>All <CODE>snmp</CODE> counters are set to zero.

        
<P>If an error is found in the configuration file, it is
         reported using the function <CODE>config_err/2</CODE> of the error
         report module, and the function fails with the reason 
         <CODE>configuration_error</CODE>.

        
<P><CODE>ConfDir</CODE> is a string which points to the directory
        where the configuration files are found.


<P>The configuration file read is: <CODE>standard.conf</CODE>.


</DIV>

<P><A NAME="reset/0"><STRONG><CODE>reset() -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>Resets all <CODE>snmp</CODE> counters to 0.

</DIV>

<P><A NAME="sys_up_time/0"><STRONG><CODE>sys_up_time() -&#62; Time</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Time = int()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Gets the system up time in hundredth of a second.

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Martin Bjrklund - support@erlang.ericsson.se<BR>
Klas Eriksson - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>