← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmpa.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/snmpa.xml
1
 
<?xml version="1.0" encoding="latin1" ?>
 
1
<?xml version="1.0" encoding="iso-8859-1" ?>
2
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
3
3
 
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>2004</year><year>2009</year>
 
7
      <year>2004</year><year>2011</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
13
13
      compliance with the License. You should have received a copy of the
14
14
      Erlang Public License along with this software. If not, it can be
15
15
      retrieved online at http://www.erlang.org/.
16
 
    
 
16
 
17
17
      Software distributed under the License is distributed on an "AS IS"
18
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
19
19
      the License for the specific language governing rights and limitations
20
20
      under the License.
21
 
    
 
21
 
22
22
    </legalnotice>
23
23
 
24
24
    <title>snmpa</title>
648
648
      <desc>
649
649
        <p>Disable the mib server cache. </p>
650
650
 
 
651
        <marker id="which_mibs_cache_size"></marker>
 
652
      </desc>
 
653
    </func>
 
654
 
 
655
    <func>
 
656
      <name>which_mibs_cache_size() -> void()</name>
 
657
      <name>which_mibs_cache_size(Agent) -> void()</name>
 
658
      <fsummary>The size of the mib server cache</fsummary>
 
659
      <type>
 
660
        <v>Agent = pid() | atom()</v>
 
661
      </type>
 
662
      <desc>
 
663
        <p>Retreive the size of the mib server cache. </p>
 
664
 
651
665
        <marker id="gc_mibs_cache"></marker>
652
666
      </desc>
653
667
    </func>
867
881
      <name>send_notification(Agent, Notification, Receiver, Varbinds)</name>
868
882
      <name>send_notification(Agent, Notification, Receiver, NotifyName, Varbinds)</name>
869
883
      <name>send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() </name>
 
884
      <name>send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() </name>
870
885
      <fsummary>Send a notification</fsummary>
871
886
      <type>
872
887
        <v>Agent = pid() | atom()</v>
888
903
        <v>OID = oid()</v>
889
904
        <v>Value = term()</v>
890
905
        <v>RowIndex = [int()]</v>
 
906
        <v>LocalEngineID = string()</v>
891
907
      </type>
892
908
      <desc>
893
909
        <p>Sends the notification <c>Notification</c> to the
1027
1043
          <item><c>{?sysLocation_instance, "upstairs"}</c> (provided
1028
1044
           that the generated <c>.hrl</c> file is included)</item>
1029
1045
        </list>
 
1046
 
1030
1047
        <p>If a variable in the notification is a table element, the
1031
1048
          <c>RowIndex</c> for the element must be given in the
1032
1049
          <c>Varbinds</c> list. In this case, the OBJECT IDENTIFIER sent
1034
1051
          element.  This OBJECT IDENTIFIER could be used in a get
1035
1052
          operation later.
1036
1053
          </p>
 
1054
 
1037
1055
        <p>This function is asynchronous, and does not return any
1038
1056
          information.  If an error occurs, <c>user_err/2</c> of the error
1039
1057
          report module is called and the notification is discarded.
1040
1058
          </p>
1041
1059
 
 
1060
        <note>
 
1061
          <p>Note that the use of the LocalEngineID argument is only intended 
 
1062
            for special cases, if the agent is to "emulate" multiple EngineIDs!
 
1063
            By default, the agent uses the value of <c>SnmpEngineID</c> 
 
1064
            (see SNMP-FRAMEWORK-MIB). </p>
 
1065
        </note>
 
1066
 
 
1067
<!--
1042
1068
          <marker id="send_trap"></marker>
 
1069
-->
 
1070
          <marker id="discovery"></marker>
1043
1071
      </desc>
1044
1072
    </func>
1045
1073
 
 
1074
<!--
1046
1075
    <func>
1047
1076
      <name>send_trap(Agent,Trap,Community)</name>
1048
1077
      <name>send_trap(Agent,Trap,Community,Varbinds) -> void()</name>
1114
1143
        <marker id="discovery"></marker>
1115
1144
      </desc>
1116
1145
    </func>
 
1146
-->
1117
1147
 
1118
1148
    <func>
1119
1149
      <name>discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason}</name>
1203
1233
      </type>
1204
1234
      <desc>
1205
1235
        <p>Restart the worker process of a multi-threaded agent.</p>
1206
 
        <p>This is a utility function, that can be usefull when 
 
1236
        <p>This is a utility function, that can be useful when
1207
1237
          e.g. debugging instrumentation functions.</p>
1208
1238
 
1209
1239
        <marker id="restart_set_worker"></marker>
1219
1249
      </type>
1220
1250
      <desc>
1221
1251
        <p>Restart the set worker process of a multi-threaded agent.</p>
1222
 
        <p>This is a utility function, that can be usefull when 
 
1252
        <p>This is a utility function, that can be useful when
1223
1253
          e.g. debugging instrumentation functions.</p>
1224
1254
 
 
1255
        <marker id="print_mib_info"></marker>
 
1256
      </desc>
 
1257
    </func>
 
1258
 
 
1259
    <func>
 
1260
      <name>print_mib_info() -> void()</name>
 
1261
      <fsummary>Print mib info</fsummary>
 
1262
      <desc>
 
1263
        <p>Prints the content of all the (snmp) tables and variables 
 
1264
        for all mibs handled by the snmp agent. </p>
 
1265
 
 
1266
        <marker id="print_mib_tables"></marker>
 
1267
      </desc>
 
1268
    </func>
 
1269
 
 
1270
    <func>
 
1271
      <name>print_mib_tables() -> void()</name>
 
1272
      <fsummary>Print mib tables</fsummary>
 
1273
      <desc>
 
1274
        <p>Prints the content of all the (snmp) tables 
 
1275
        for all mibs handled by the snmp agent. </p>
 
1276
 
 
1277
        <marker id="print_mib_variables"></marker>
 
1278
      </desc>
 
1279
    </func>
 
1280
 
 
1281
    <func>
 
1282
      <name>print_mib_variables() -> void()</name>
 
1283
      <fsummary>Print mib variables</fsummary>
 
1284
      <desc>
 
1285
        <p>Prints the content of all the (snmp) variables 
 
1286
        for all mibs handled by the snmp agent. </p>
 
1287
 
1225
1288
        <marker id="verbosity"></marker>
1226
1289
      </desc>
1227
1290
    </func>