← 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_config.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_config.xml
1
 
<?xml version="1.0" encoding="latin1" ?>
 
1
<?xml version="1.0" encoding="iso-8859-1" ?>
2
2
<!DOCTYPE chapter SYSTEM "chapter.dtd">
3
3
 
4
4
<chapter>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>1997</year><year>2009</year>
 
7
      <year>1997</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>Running the application</title>
73
73
      </item>
74
74
    </list>
75
75
 
 
76
    <!-- The info below is also found in the snmp_app.xml file -->
 
77
 
76
78
    <p>The agent and manager uses (application) configuration parameters to 
77
79
      find out where these directories are located. The parameters should be
78
80
      defined in an Erlang system configuration file. The following
79
81
      configuration parameters are defined for the SNMP application:</p>
80
82
 
81
 
    <!-- Also in snmp_app.xml -->
82
 
 
83
83
    <pre>
84
84
      agent_options() = [agent_option()]
85
85
      agent_option() = {restart_type,     restart_type()}     | 
343
343
        <p>Defines if the mib server shall perform cache gc automatically or 
344
344
          leave it to the user (see 
345
345
          <seealso marker="snmpa#gc_mibs_cache">gc_mibs_cache/0,1,2,3</seealso>). </p>
346
 
        <p>Default is <c>false</c>.</p>
 
346
        <p>Default is <c>true</c>.</p>
347
347
      </item>
348
348
 
349
349
      <tag><c><![CDATA[mibs_cache_age() = integer() > 0 <optional>]]></c></tag>
649
649
          process performs a GC to remove the expired note's. Time in
650
650
          milli-seconds.</p>
651
651
        <p>Default is <c>30000</c>.</p>
 
652
 
 
653
      <marker id="audit_trail_log"></marker>
652
654
      </item>
653
655
 
654
656
      <tag><c><![CDATA[audit_trail_log() [audit_trail_log_opt()] <optional>]]></c></tag>
655
657
      <item>
656
 
        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()}</c></p>
 
658
        <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()} | {seqno, atl_seqno()}</c></p>
657
659
        <p>If present, this option specifies the options for the 
658
660
          <em>audit trail logging</em>. The <c>disk_log</c> module is used 
659
661
          to maintain a wrap log. If present, the <c>dir</c> and 
702
704
        <p>Specifies if and how the audit trail log shall be repaired
703
705
          when opened. Unless this parameter has the value <c>snmp_repair</c>
704
706
          it is sent to <c>disk_log</c>. If, on the other hand, the value is
705
 
          <c>snmp_repair</c>, snmp attempts to handle certain faults on it's 
 
707
          <c>snmp_repair</c>, snmp attempts to handle certain faults on its
706
708
          own. And even if it cannot repair the file, it does not truncate it 
707
709
          directly, but instead <em>moves it aside</em> for later off-line 
708
710
          analysis.</p>
709
711
        <p>Default is <c>true</c>.</p>
710
712
      </item>
 
713
      <tag><c><![CDATA[atl_seqno() = true | false <optional>]]></c></tag>
 
714
      <item>
 
715
        <p>Specifies if the audit trail log entries will be (sequence)
 
716
          numbered or not. The range of the sequence numbers are according
 
717
          to RFC 5424, i.e. 1 through 2147483647. </p>
 
718
        <p>Default is <c>false</c>.</p>
 
719
      </item>
711
720
    </taglist>
712
721
  </section>
713
722
 
995
1004
    </taglist>
996
1005
 
997
1006
    <p>Another usefull way to debug the agent is to pretty-print the content of 
998
 
      some of the (MIB-) tables handled directly by the agent. This can be done 
999
 
      for the following tables: </p>
1000
 
    <taglist>
1001
 
      <tag><c><![CDATA[snmpCommunityTable]]></c></tag>
1002
 
      <item>
1003
 
        <p><c><![CDATA[snmp_community_mib:snmpCommunityTable(print).]]></c></p>
1004
 
      </item>
1005
 
 
1006
 
      <tag><c><![CDATA[snmpNotifyTable]]></c></tag>
1007
 
      <item>
1008
 
        <p><c><![CDATA[snmp_notification_mib:snmpNotifyTable(print).]]></c></p>
1009
 
      </item>
1010
 
 
1011
 
      <tag><c><![CDATA[snmpTargetAddrTable]]></c></tag>
1012
 
      <item>
1013
 
        <p><c><![CDATA[snmp_target_mib:snmpTargetAddrTable(print).]]></c></p>
1014
 
      </item>
1015
 
 
1016
 
      <tag><c><![CDATA[snmpTargetParamsTable]]></c></tag>
1017
 
      <item>
1018
 
        <p><c><![CDATA[snmp_target_mib:snmpTargetParamsTable(print).]]></c></p>
1019
 
      </item>
1020
 
 
1021
 
      <tag><c><![CDATA[usmUserTable]]></c></tag>
1022
 
      <item>
1023
 
        <p><c><![CDATA[snmp_user_based_sm_mib:usmUserTable(print).]]></c></p>
1024
 
      </item>
1025
 
 
1026
 
    </taglist>
1027
 
 
 
1007
    all the tables and/or variables handled directly by the agent. 
 
1008
    This can be done by simply calling: </p>
 
1009
    <p><c><![CDATA[snmpa:print_mib_info()]]></c></p>
 
1010
    <p>See 
 
1011
    <seealso marker="snmpa#print_mib_info">print_mib_info/0</seealso>, 
 
1012
    <seealso marker="snmpa#print_mib_tables">print_mib_tables/0</seealso>
 
1013
    or
 
1014
    <seealso marker="snmpa#print_mib_variables">print_mib_variables/0</seealso> 
 
1015
    for more info. </p>
 
1016
      
1028
1017
  </section>
1029
1018
</chapter>
1030
1019