← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmp_view_based_acm_mib.xml
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>1999</year><year>2009</year>
 
7
      <year>1999</year><year>2010</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
38
38
      SNMP-VIEW-BASED-ACM-MIB, and functions for configuring the database.
39
39
      </p>
40
40
    <p>The configuration files are described in the SNMP User's Manual.</p>
 
41
 
 
42
    <marker id="configure"></marker>
41
43
  </description>
 
44
 
42
45
  <funcs>
43
46
    <func>
44
47
      <name>configure(ConfDir) -> void()</name>
48
51
      </type>
49
52
      <desc>
50
53
        <p>This function is called from the supervisor at system
51
 
          start-up.
52
 
          </p>
 
54
        start-up. </p>
53
55
        <p>Inserts all data in the configuration files into the
54
 
          database and destroys all old rows with StorageType
55
 
          <c>volatile</c>.  The rows created from the configuration file
56
 
          will have StorageType <c>nonVolatile</c>.
57
 
          </p>
58
 
        <p>All <c>snmp</c> counters are set to zero.
59
 
          </p>
 
56
        database and destroys all old rows with StorageType
 
57
        <c>volatile</c>.  The rows created from the configuration file
 
58
        will have StorageType <c>nonVolatile</c>. </p>
 
59
        <p>All <c>snmp</c> counters are set to zero. </p>
60
60
        <p>If an error is found in the configuration file, it is
61
 
          reported using the function <c>config_err/2</c> of the error
62
 
          report module, and the function fails with the reason 
63
 
          <c>configuration_error</c>.
64
 
          </p>
 
61
        reported using the function <c>config_err/2</c> of the error
 
62
        report module, and the function fails with the reason 
 
63
        <c>configuration_error</c>. </p>
65
64
        <p><c>ConfDir</c> is a string which points to the directory
66
 
          where the configuration files are found.
67
 
          </p>
68
 
        <p>The configuration file read is: <c>vacm.conf</c>.
69
 
          </p>
 
65
        where the configuration files are found. </p>
 
66
        <p>The configuration file read is: <c>vacm.conf</c>. </p>
 
67
 
 
68
        <marker id="reconfigure"></marker>
70
69
      </desc>
71
70
    </func>
 
71
 
72
72
    <func>
73
73
      <name>reconfigure(ConfDir) -> void()</name>
74
74
      <fsummary>Configure the SNMP-VIEW-BASED-ACM-MIB</fsummary>
88
88
        <p>All <c>snmp</c> counters are set to zero.
89
89
          </p>
90
90
        <p>If an error is found in the configuration file, it is
91
 
          reported using the function <c>config_err/2</c> of the error
92
 
          report module, and the function fails with the reason 
 
91
          reported using the function 
 
92
          <seealso marker="snmpa_error#config_err">config_err/2</seealso> 
 
93
          of the error report module, and the function fails with the reason 
93
94
          <c>configuration_error</c>.
94
95
          </p>
95
96
        <p><c>ConfDir</c> is a string which points to the directory
96
97
          where the configuration files are found.
97
98
          </p>
98
 
        <p>The configuration file read is: <c>vacm.conf</c>.
99
 
                    <marker id="add_sec2group"></marker>
100
 
</p>
 
99
        <p>The configuration file read is: <c>vacm.conf</c>. </p>
 
100
 
 
101
        <marker id="add_sec2group"></marker>
101
102
      </desc>
102
103
    </func>
 
104
 
103
105
    <func>
104
106
      <name>add_sec2group(SecModel, SecName, GroupName) -> Ret</name>
105
107
      <fsummary>Add one security to group definition</fsummary>
113
115
      </type>
114
116
      <desc>
115
117
        <p>Adds a security to group definition to the agent config. 
116
 
          Equivalent to one vacmSecurityToGroup-line in the <c>vacm.conf</c> file.</p>
 
118
        Equivalent to one vacmSecurityToGroup-line in the 
 
119
        <c>vacm.conf</c> file.</p>
 
120
 
117
121
        <marker id="delete_sec2group"></marker>
118
122
      </desc>
119
123
    </func>
 
124
 
120
125
    <func>
121
126
      <name>delete_sec2group(Key) -> Ret</name>
122
127
      <fsummary>Delete one security to group definition</fsummary>
127
132
      </type>
128
133
      <desc>
129
134
        <p>Delete a security to group definition from the agent config.</p>
 
135
 
130
136
        <marker id="add_access"></marker>
131
137
      </desc>
132
138
    </func>
 
139
 
133
140
    <func>
134
141
      <name>add_access(GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV) -> Ret</name>
135
142
      <fsummary>Add one access definition</fsummary>
148
155
      </type>
149
156
      <desc>
150
157
        <p>Adds a access definition to the agent config. 
151
 
          Equivalent to one vacmAccess-line in the <c>vacm.conf</c> file.</p>
152
 
        <marker id="delete_access"></marker>
 
158
        Equivalent to one vacmAccess-line in the <c>vacm.conf</c> file.</p>
 
159
        
 
160
        <marker id="delete_access"></marker>
153
161
      </desc>
154
162
    </func>
 
163
 
155
164
    <func>
156
165
      <name>delete_access(Key) -> Ret</name>
157
166
      <fsummary>Delete one access definition</fsummary>
161
170
        <v>Reason = term()</v>
162
171
      </type>
163
172
      <desc>
164
 
        <p>Delete a access definition from the agent config.</p>
165
 
        <marker id="add_view_tree_fam"></marker>
 
173
        <p>Delete a access definition from the agent config.</p>
 
174
 
 
175
        <marker id="add_view_tree_fam"></marker>
166
176
      </desc>
167
177
    </func>
 
178
 
168
179
    <func>
169
180
      <name>add_view_tree_fam(ViewIndex, SubTree, Status, Mask) -> Ret</name>
170
181
      <fsummary>Add one view tree family definition</fsummary>
178
189
        <v>Reason = term()</v>
179
190
      </type>
180
191
      <desc>
181
 
        <p>Adds a view tree family definition to the agent config. 
182
 
          Equivalent to one vacmViewTreeFamily-line in the <c>vacm.conf</c> file.</p>
183
 
        <marker id="delete_view_tree_fam"></marker>
 
192
        <p>Adds a view tree family definition to the agent config. 
 
193
        Equivalent to one vacmViewTreeFamily-line in the 
 
194
        <c>vacm.conf</c> file.</p>
 
195
          
 
196
          <marker id="delete_view_tree_fam"></marker>
184
197
      </desc>
185
198
    </func>
 
199
 
186
200
    <func>
187
201
      <name>delete_view_tree_fam(Key) -> Ret</name>
188
202
      <fsummary>Delete one view tree family definition</fsummary>