← Back to branch summary

~statik/ubuntu/maverick/erlang/erlang-merge-testing

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmp_notification_mib.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-01 10:14:38 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090501101438-6qlr6rsdxgyzrg2z
Tags: 1:13.b-dfsg-2
* Cleaned up patches: removed unneeded patch which helped to support
  different SCTP library versions, made sure that changes for m68k
  architecture applied only when building on this architecture.
* Removed duplicated information from binary packages descriptions.
* Don't require libsctp-dev build-dependency on solaris-i386 architecture
  which allows to build Erlang on Nexenta (thanks to Tim Spriggs for
  the suggestion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmp_notification_mib.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1998</year><year>2009</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>snmp_notification_mib</title>
 
25
    <prepared></prepared>
 
26
    <responsible></responsible>
 
27
    <docno></docno>
 
28
    <approved></approved>
 
29
    <checked></checked>
 
30
    <date></date>
 
31
    <rev></rev>
 
32
    <file>snmp_notification_mib.xml</file>
 
33
  </header>
 
34
  <module>snmp_notification_mib</module>
 
35
  <modulesummary>Instrumentation Functions for SNMP-NOTIFICATION-MIB</modulesummary>
 
36
  <description>
 
37
    <p>The module <c>snmp_notification_mib</c> implements the
 
38
      instrumentation functions for the
 
39
      SNMP-NOTIFICATION-MIB, and functions for configuring the database.
 
40
      </p>
 
41
    <p>The configuration files are described in the SNMP User's Manual.</p>
 
42
  </description>
 
43
  <funcs>
 
44
    <func>
 
45
      <name>configure(ConfDir) -> void()</name>
 
46
      <fsummary>Configure the SNMP-NOTIFICATION-MIB</fsummary>
 
47
      <type>
 
48
        <v>ConfDir = string()</v>
 
49
      </type>
 
50
      <desc>
 
51
        <p>This function is called from the supervisor at system
 
52
          start-up.
 
53
          </p>
 
54
        <p>Inserts all data in the configuration files into the
 
55
          database and destroys all old rows with StorageType
 
56
          <c>volatile</c>.  The rows created from the configuration file
 
57
          will have StorageType <c>nonVolatile</c>.
 
58
          </p>
 
59
        <p>If an error is found in the configuration file, it is
 
60
          reported using the function <c>config_err/2</c> of the 
 
61
          error report module,
 
62
          and the function fails with reason <c>configuration_error</c>.
 
63
          </p>
 
64
        <p><c>ConfDir</c> is a string which points to the directory
 
65
          where the configuration files are found.
 
66
          </p>
 
67
        <p>The configuration file read is: <c>notify.conf</c>.
 
68
          </p>
 
69
      </desc>
 
70
    </func>
 
71
    <func>
 
72
      <name>reconfigure(ConfDir) -> void()</name>
 
73
      <fsummary>Configure the SNMP-NOTIFICATION-MIB</fsummary>
 
74
      <type>
 
75
        <v>ConfDir = string()</v>
 
76
      </type>
 
77
      <desc>
 
78
        <p>Inserts all data in the configuration files into the
 
79
          database and destroys all old data, including the rows with
 
80
          StorageType <c>nonVolatile</c>.  The rows created from the
 
81
          configuration file will have StorageType <c>nonVolatile</c>.
 
82
          </p>
 
83
        <p>Thus, the data in the SNMP-NOTIFICATION-MIB, after this
 
84
          function has been called, is from the configuration files.
 
85
          </p>
 
86
        <p>If an error is found in the configuration file, it is
 
87
          reported using the function <c>config_err/2</c> of the 
 
88
          error report module,
 
89
          and the function fails with reason <c>configuration_error</c>.
 
90
          </p>
 
91
        <p><c>ConfDir</c> is a string which points to the directory
 
92
          where the configuration files are found.
 
93
          </p>
 
94
        <p>The configuration file read is: <c>notify.conf</c>.
 
95
                    <marker id="add_notify"></marker>
 
96
</p>
 
97
      </desc>
 
98
    </func>
 
99
    <func>
 
100
      <name>add_notify(Name, Tag, Type) -> Ret</name>
 
101
      <fsummary>Added one notify definition</fsummary>
 
102
      <type>
 
103
        <v>Name = string()</v>
 
104
        <v>Tag = string()</v>
 
105
        <v>Type = trap | inform</v>
 
106
        <v>Ret = {ok, Key} | {error, Reason}</v>
 
107
        <v>Key = term()</v>
 
108
        <v>Reason = term()</v>
 
109
      </type>
 
110
      <desc>
 
111
        <p>Adds a notify definition to the agent config. 
 
112
          Equivalent to one line in the <c>notify.conf</c> file.</p>
 
113
        <marker id="delete_notify"></marker>
 
114
      </desc>
 
115
    </func>
 
116
    <func>
 
117
      <name>delete_notify(Key) -> Ret</name>
 
118
      <fsummary>Delete one notify definition</fsummary>
 
119
      <type>
 
120
        <v>Key = term()</v>
 
121
        <v>Ret = ok | {error, Reason}</v>
 
122
        <v>Reason = term()</v>
 
123
      </type>
 
124
      <desc>
 
125
        <p>Delete a notify definition from the agent config.</p>
 
126
      </desc>
 
127
    </func>
 
128
  </funcs>
 
129
  
 
130
</erlref>
 
131