Merge branch 'bmk/snmp/agent/get_bulk_with_large_max_reps/OTP-9700' into bmk/snmp/snmp4173_integration/r13

1 files changed, 105 insertions, 4 deletions

diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml
index 694e619da1..f6abe783b3 100644
--- a/lib/snmp/doc/src/snmp_app.xml
+++ b/lib/snmp/doc/src/snmp_app.xml
@@ -1,10 +1,10 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE appref SYSTEM "appref.dtd">
 
 <appref>
   <header>
     <copyright>
-      <year>1997</year><year>2010</year>
+      <year>1997</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -78,7 +78,15 @@
       ].
     </pre>
 
-    <!-- The info below is also found in the snmp_config.xml file -->
+
+    <!-- 
+	 ********************************************************
+
+	 The info below is also found in the snmp_config.xml file 
+
+	 ********************************************************
+    -->
+
 
     <p>Each snmp component has its own set of configuration parameters,
       even though some of the types are common to both components. </p>
@@ -92,6 +100,7 @@
                        {agent_verbosity,  verbosity()}        |  
                        {discovery,        agent_discovery()}  |  
                        {versions,         versions()}         |  
+                       {gb_max_vbs,       gb_max_vbs()}       |  
                        {priority,         priority()}         |  
                        {multi_threaded,   multi_threaded()}   |  
                        {db_dir,           db_dir()}           |  
@@ -122,8 +131,10 @@
                          {def_user_data,            def_user_data()}
     </pre>
 
+    <marker id="agent_opts_and_types"></marker>
     <p>Agent specific config options and types:</p>
     <taglist>
+      <marker id="agent_type"></marker>
       <tag><c><![CDATA[agent_type() = master | sub <optional>]]></c></tag>
       <item>
         <p>If <c>master</c>, one master agent is
@@ -131,6 +142,7 @@
         <p>Default is <c>master</c>.</p>
       </item>
 
+      <marker id="agent_disco"></marker>
       <tag><c><![CDATA[agent_discovery() = [agent_discovery_opt()] <optional>]]></c></tag>
       <item>
         <p><c>agent_discovery_opt() = 
@@ -143,6 +155,7 @@
         <p>For defaults see the options in <c>agent_discovery_opt()</c>.</p>
       </item>
 
+      <marker id="agent_term_disco_opts"></marker>
       <tag><c><![CDATA[agent_terminating_discovery_opts() = [agent_terminating_discovery_opt()] <optional>]]></c></tag>
       <item>
         <p><c>agent_terminating_discovery_opt() = 
@@ -160,6 +173,7 @@
         </list>
       </item>
 
+      <marker id="agent_orig_disco_opts"></marker>
       <tag><c><![CDATA[agent_originating_discovery_opts() = [agent_originating_discovery_opt()] <optional>]]></c></tag>
       <item>
         <p><c>agent_originating_discovery_opt() = 
@@ -173,6 +187,7 @@
         </list>
       </item>
 
+      <marker id="agent_mt"></marker>
       <tag><c><![CDATA[multi_threaded() = bool() <optional>]]></c></tag>
       <item>
         <p>If <c>true</c>, the agent is multi-threaded, with one
@@ -180,11 +195,21 @@
         <p>Default is <c>false</c>.</p>
       </item>
 
+      <marker id="agent_data_dir"></marker>
       <tag><c><![CDATA[db_dir() = string() <mandatory>]]></c></tag>
       <item>
         <p>Defines where the SNMP agent internal db files are stored.</p>
       </item>
 
+      <marker id="agent_gb_max_vbs"></marker>
+      <tag><c><![CDATA[gb_max_vbs() = pos_integer() | infinity <optional>]]></c></tag>
+      <item>
+        <p>Defines the maximum number of varbinds allowed 
+	in a Get-BULK response.</p>
+        <p>Default is <c>1000</c>.</p>
+      </item>
+
+      <marker id="agent_local_db"></marker>
       <tag><c><![CDATA[local_db() = [local_db_opt()] <optional>]]></c></tag>
       <item>
         <p><c>local_db_opt() = {repair, agent_repair()} | {auto_save, agent_auto_save()} |   {verbosity, verbosity()}</c></p>
@@ -192,6 +217,7 @@
         <p>For defaults see the options in <c>local_db_opt()</c>.</p>
       </item>
 
+      <marker id="agent_ldb_repair"></marker>
       <tag><c><![CDATA[agent_repair() = false | true | force <optional>]]></c></tag>
       <item>
         <p>When starting snmpa_local_db it always tries to open an
@@ -202,6 +228,7 @@
         <p>Default is <c>true</c>.</p>
       </item>
 
+      <marker id="agent_ldb_auto_save"></marker>
       <tag><c><![CDATA[agent_auto_save() = integer() | infinity <optional>]]></c></tag>
       <item>
         <p>The auto save interval. The table is flushed to disk
@@ -209,6 +236,7 @@
         <p>Default is <c>5000</c>.</p>
       </item>
 
+      <marker id="agent_net_if"></marker>
       <tag><c><![CDATA[agent_net_if() = [agent_net_if_opt()] <optional>]]></c></tag>
       <item>
         <p><c>agent_net_if_opt() = {module, agent_net_if_module()} |  {verbosity, verbosity()} |  {options, agent_net_if_options()}</c></p>
@@ -217,6 +245,7 @@
         <p>For defaults see the options in <c>agent_net_if_opt()</c>.</p>
       </item>
 
+      <marker id="agent_ni_module"></marker>
       <tag><c><![CDATA[agent_net_if_module() = atom() <optional>]]></c></tag>
       <item>
         <p>Module which handles the network interface part for the
@@ -225,6 +254,7 @@
         <p>Default is <c>snmpa_net_if</c>.</p>
       </item>
 
+      <marker id="agent_ni_opts"></marker>
       <tag><c><![CDATA[agent_net_if_options() = [agent_net_if_option()] <optional>]]></c></tag>
       <item>
         <p><c>agent_net_if_option() = {bind_to, bind_to()} |  
@@ -239,12 +269,14 @@
         <p>For defaults see the options in <c>agent_net_if_option()</c>.</p>
       </item>
 
+      <marker id="agent_ni_req_limit"></marker>
       <tag><c><![CDATA[req_limit() = integer() | infinity <optional>]]></c></tag>
       <item>
         <p>Max number of simultaneous requests handled by the agent.</p>
         <p>Default is <c>infinity</c>.</p>
       </item>
 
+      <marker id="agent_ni_filter_opts"></marker>
       <tag><c><![CDATA[agent_net_if_filter_options() = [agent_net_if_filter_option()] <optional>]]></c></tag>
       <item>
 	<p><c>agent_net_if_filter_option() = {module, agent_net_if_filter_module()}</c></p>
@@ -255,6 +287,7 @@
           <c>agent_net_if_filter_option()</c>.</p>
       </item>
 
+      <marker id="agent_ni_filter_module"></marker>
       <tag><c><![CDATA[agent_net_if_filter_module() = atom() <optional>]]></c></tag>
       <item>
 	<p>Module which handles the network interface filter part for the
@@ -263,6 +296,7 @@
 	<p>Default is <c>snmpa_net_if_filter</c>.</p>
       </item>
 
+      <marker id="agent_mibs"></marker>
       <tag><c><![CDATA[agent_mibs() = [string()] <optional>]]></c></tag>
       <item>
         <p>Specifies a list of MIBs (including path) that defines which MIBs
@@ -277,6 +311,7 @@
         <p>Default is <c>[]</c>.</p>
       </item>
 
+      <marker id="agent_mib_storage"></marker>
       <tag><c><![CDATA[mib_storage() = ets | {ets, Dir} | {ets, Dir, Action} | dets | {dets, Dir} | {dets, Dir, Action} | mnesia | {mnesia, Nodes} | {mnesia, Nodes, Action} <optional>]]></c></tag>
       <item>
         <p>Specifies how info retrieved from the mibs will be stored.</p>
@@ -302,6 +337,7 @@
           mnesia/dets table already exist.</p>
       </item>
 
+      <marker id="agent_mib_server"></marker>
       <tag><c><![CDATA[mib_server() = [mib_server_opt()] <optional>]]></c></tag>
       <item>
         <p><c>mib_server_opt() = {mibentry_override, mibentry_override()} |  {trapentry_override, trapentry_override()} |  {verbosity, verbosity()} | {cache, mibs_cache()}</c></p>
@@ -309,6 +345,7 @@
         <p>For defaults see the options in <c>mib_server_opt()</c>.</p>
       </item>
 
+      <marker id="agent_ms_meo"></marker>
       <tag><c><![CDATA[mibentry_override() = bool() <optional>]]></c></tag>
       <item>
         <p>If this value is false, then when loading a mib each mib-
@@ -318,6 +355,7 @@
         <p>Default is <c>false</c>.</p>
       </item>
 
+      <marker id="agent_ms_teo"></marker>
       <tag><c><![CDATA[trapentry_override() = bool() <optional>]]></c></tag>
       <item>
         <p>If this value is false, then when loading a mib each trap
@@ -327,6 +365,7 @@
         <p>Default is <c>false</c>.</p>
       </item>
 
+      <marker id="agent_ms_cache"></marker>
       <tag><c><![CDATA[mibs_cache() = bool() | mibs_cache_opts() <optional>]]></c></tag>
       <item>
         <p>Shall the agent utilize the mib server lookup cache or not.</p>
@@ -334,6 +373,7 @@
           default values apply).</p>
       </item>
 
+      <marker id="agent_ms_cache_opts"></marker>
       <tag><c><![CDATA[mibs_cache_opts() = [mibs_cache_opt()] <optional>]]></c></tag>
       <item>
         <p><c>mibs_cache_opt() = {autogc, mibs_cache_autogc()} | {gclimit, mibs_cache_gclimit()} | {age, mibs_cache_age()}</c></p>
@@ -341,6 +381,7 @@
         <p>For defaults see the options in <c>mibs_cache_opt()</c>.</p>
       </item>
 
+      <marker id="agent_ms_cache_autogc"></marker>
       <tag><c><![CDATA[mibs_cache_autogc() = bool() <optional>]]></c></tag>
       <item>
         <p>Defines if the mib server shall perform cache gc automatically or 
@@ -349,6 +390,7 @@
         <p>Default is <c>true</c>.</p>
       </item>
 
+      <marker id="agent_ms_cache_age"></marker>
       <tag><c><![CDATA[mibs_cache_age() = integer() > 0 <optional>]]></c></tag>
       <item>
         <p>Defines how old the entries in the cache will be allowed before 
@@ -358,6 +400,7 @@
         <p>Default is <c>10 timutes</c>.</p>
       </item>
 
+      <marker id="agent_ms_cache_gclimit"></marker>
       <tag><c><![CDATA[mibs_cache_gclimit() = integer() > 0 | infinity <optional>]]></c></tag>
       <item>
         <p>When performing a GC, this is the max number of cache entries 
@@ -368,6 +411,7 @@
         <p>Default is <c>100</c>.</p>
       </item>
 
+      <marker id="agent_error_report_mod"></marker>
       <tag><c><![CDATA[error_report_mod() = atom() <optional>]]></c></tag>
       <item>
         <p>Defines an error report module, implementing the 
@@ -377,6 +421,7 @@
         <p>Default is <c>snmpa_error_logger</c>.</p>
       </item>
 
+      <marker id="agent_symbolic_store"></marker>
       <tag><c>symbolic_store() = [symbolic_store_opt()]</c></tag>
       <item>
         <p><c>symbolic_store_opt() = {verbosity, verbosity()}</c></p>
@@ -384,23 +429,29 @@
         <p>For defaults see the options in <c>symbolic_store_opt()</c>.</p>
       </item>
 
+      <marker id="agent_target_cache"></marker>
       <tag><c>target_cache() = [target_cache_opt()]</c></tag>
       <item>
         <p><c>target_cache_opt() = {verbosity, verbosity()}</c></p>
         <p>Defines options specific for the SNMP agent target cache. </p>
         <p>For defaults see the options in <c>target_cache_opt()</c>.</p>
       </item>
+
+      <marker id="agent_config"></marker>
       <tag><c><![CDATA[agent_config() = [agent_config_opt()] <mandatory>]]></c></tag>
       <item>
         <p><c>agent_config_opt() = {dir, agent_config_dir()} |  {force_load, force_load()} | {verbosity, verbosity()}</c></p>
         <p>Defines specific config related options for the SNMP agent. </p>
         <p>For defaults see the options in <c>agent_config_opt()</c>.</p>
       </item>
+
+      <marker id="agent_config_dir"></marker>
       <tag><c><![CDATA[agent_config_dir = dir() <mandatory>]]></c></tag>
       <item>
         <p>Defines where the SNMP agent configuration files are stored.</p>
       </item>
 
+      <marker id="agent_force_load"></marker>
       <tag><c><![CDATA[force_load() = bool() <optional>]]></c></tag>
       <item>
         <p>If <c>true</c> the configuration files are re-read
@@ -412,14 +463,18 @@
       </item>
     </taglist>
 
+    <marker id="manager_opts_and_types"></marker>
     <p>Manager specific config options and types:</p>
     <taglist>
+      <marker id="manager_server"></marker>
       <tag><c><![CDATA[server() = [server_opt()] <optional>]]></c></tag>
       <item>
         <p><c>server_opt() = {timeout, server_timeout()} |  {verbosity, verbosity()}</c></p>
         <p>Specifies the options for the manager server process.</p>
         <p>Default is <c>silence</c>.</p>
       </item>
+
+      <marker id="manager_server_timeout"></marker>
       <tag><c><![CDATA[server_timeout() = integer() <optional>]]></c></tag>
       <item>
         <p>Asynchroneous request cleanup time. For every requests, 
@@ -440,6 +495,7 @@
         <p>Default is <c>30000</c>.</p>
       </item>
 
+      <marker id="manager_config"></marker>
       <tag><c><![CDATA[manager_config() = [manager_config_opt()] <mandatory>]]></c></tag>
       <item>
         <p><c>manager_config_opt() = {dir, manager_config_dir()} |  {db_dir, manager_db_dir()} |  {db_init_error, db_init_error()} |  {repair, manager_repair()} |  {auto_save, manager_auto_save()} |  {verbosity, verbosity()}</c></p>
@@ -447,16 +503,19 @@
         <p>For defaults see the options in <c>manager_config_opt()</c>.</p>
       </item>
 
+      <marker id="manager_config_dir"></marker>
       <tag><c><![CDATA[manager_config_dir = dir() <mandatory>]]></c></tag>
       <item>
         <p>Defines where the SNMP manager configuration files are stored.</p>
       </item>
 
+      <marker id="manager_config_db_dir"></marker>
       <tag><c><![CDATA[manager_db_dir = dir() <mandatory>]]></c></tag>
       <item>
         <p>Defines where the SNMP manager store persistent data.</p>
       </item>
 
+      <marker id="manager_config_repair"></marker>
       <tag><c><![CDATA[manager_repair() = false | true | force <optional>]]></c></tag>
       <item>
         <p>Defines the repair option for the persistent database (if 
@@ -464,6 +523,7 @@
         <p>Default is <c>true</c>.</p>
       </item>
 
+      <marker id="manager_config_auto_save"></marker>
       <tag><c><![CDATA[manager_auto_save() = integer() | infinity <optional>]]></c></tag>
       <item>
         <p>The auto save interval. The table is flushed to disk
@@ -471,6 +531,7 @@
         <p>Default is <c>5000</c>.</p>
       </item>
 
+      <marker id="manager_irb"></marker>
       <tag><c><![CDATA[manager_irb() = auto | user | {user, integer()} <optional>]]></c></tag>
       <item>
         <p>This option defines how the manager will handle the sending of 
@@ -500,6 +561,7 @@
         <p>Default is <c>auto</c>.</p>
       </item>
 
+      <marker id="manager_mibs"></marker>
       <tag><c><![CDATA[manager_mibs() = [string()] <optional>]]></c></tag>
       <item>
         <p>Specifies a list of MIBs (including path) and defines which MIBs
@@ -507,6 +569,7 @@
         <p>Default is <c>[]</c>.</p>
       </item>
 
+      <marker id="manager_net_if"></marker>
       <tag><c><![CDATA[manager_net_if() = [manager_net_if_opt()] <optional>]]></c></tag>
       <item>
         <p><c>manager_net_if_opt() = {module, manager_net_if_module()} | 
@@ -517,6 +580,7 @@
         <p>For defaults see the options in <c>manager_net_if_opt()</c>.</p>
       </item>
 
+      <marker id="manager_ni_opts"></marker>
       <tag><c><![CDATA[manager_net_if_options() = [manager_net_if_option()] <optional>]]></c></tag>
       <item>
         <p><c>manager_net_if_option() = {bind_to, bind_to()} | 
@@ -530,6 +594,7 @@
         <p>For defaults see the options in <c>manager_net_if_option()</c>.</p>
       </item>
 
+      <marker id="manager_ni_module"></marker>
       <tag><c><![CDATA[manager_net_if_module() = atom() <optional>]]></c></tag>
       <item>
         <p>Module which handles the network interface part for the
@@ -538,6 +603,7 @@
         <p>Default is <c>snmpm_net_if</c>.</p>
       </item>
 
+      <marker id="manager_ni_filter_opts"></marker>
       <tag><c><![CDATA[manager_net_if_filter_options() = [manager_net_if_filter_option()] <optional>]]></c></tag>
       <item>
 	<p><c>manager_net_if_filter_option() = {module, manager_net_if_filter_module()}</c></p>
@@ -548,6 +614,7 @@
           <c>manager_net_if_filter_option()</c>.</p>
       </item>
 
+      <marker id="manager_ni_filter_module"></marker>
       <tag><c><![CDATA[manager_net_if_filter_module() = atom() <optional>]]></c></tag>
       <item>
 	<p>Module which handles the network interface filter part for the
@@ -556,6 +623,7 @@
 	<p>Default is <c>snmpm_net_if_filter</c>.</p>
       </item>
 
+      <marker id="manager_def_user_module"></marker>
       <tag><c><![CDATA[def_user_module() = atom() <optional>]]></c></tag>
       <item>
         <p>The module implementing the default user. See the 
@@ -563,6 +631,7 @@
         <p>Default is <c>snmpm_user_default</c>.</p>
       </item>
 
+      <marker id="manager_def_user_data"></marker>
       <tag><c><![CDATA[def_user_data() = term() <optional>]]></c></tag>
       <item>
         <p>Data for the default user. Passed to the user module when 
@@ -571,8 +640,10 @@
       </item>
     </taglist>
 
+    <marker id="common_types"></marker>
     <p>Common config types:</p>
     <taglist>
+      <marker id="restart_type"></marker>
       <tag><c>restart_type() = permanent | transient | temporary</c></tag>
       <item>
         <p>See <seealso marker="stdlib:supervisor#child_spec">supervisor</seealso> 
@@ -580,6 +651,8 @@
         <p>Default is <c>permanent</c> for the agent and <c>transient</c>
           for the manager.</p>
       </item>
+
+      <marker id="db_init_error"></marker>
       <tag><c>db_init_error() = terminate | create</c></tag>
       <item>
         <p>Defines what to do if the agent or manager is unable to open an
@@ -588,23 +661,31 @@
           agent/manager will remove the faulty file(s) and create new ones.</p>
         <p>Default is <c>terminate</c>.</p>
       </item>
+
+      <marker id="prio"></marker>
       <tag><c><![CDATA[priority() = atom() <optional>]]></c></tag>
       <item>
         <p>Defines the Erlang priority for all SNMP processes.</p>
         <p>Default is <c>normal</c>.</p>
       </item>
+
+      <marker id="versions"></marker>
       <tag><c><![CDATA[versions() = [version()] <optional>]]></c></tag>
       <item>
         <p><c>version() = v1 | v2 | v3</c></p>
         <p>Which SNMP versions shall be accepted/used.</p>
         <p>Default is <c>[v1,v2,v3]</c>.</p>
       </item>
+
+      <marker id="verbosity"></marker>
       <tag><c><![CDATA[verbosity() = silence | info | log | debug | trace <optional>]]></c></tag>
       <item>
         <p>Verbosity for a SNMP process. This specifies now much debug info
           is printed.</p>
         <p>Default is <c>silence</c>.</p>
       </item>
+
+      <marker id="bind_to"></marker>
       <tag><c><![CDATA[bind_to() = bool() <optional>]]></c></tag>
       <item>
         <p>If <c>true</c>, net_if binds to the IP address.
@@ -612,6 +693,8 @@
           where it is running. </p>
         <p>Default is <c>false</c>.</p>
       </item>
+
+      <marker id="no_reuse"></marker>
       <tag><c><![CDATA[no_reuse() = bool() <optional>]]></c></tag>
       <item>
         <p>If <c>true</c>, net_if does not specify that the IP
@@ -619,22 +702,30 @@
           the address is set to reusable. </p>
         <p>Default is <c>false</c>.</p>
       </item>
+
+      <marker id="recbuf"></marker>
       <tag><c><![CDATA[recbuf() = integer() <optional>]]></c></tag>
       <item>
         <p>Receive buffer size. </p>
         <p>Default value is defined by <c>gen_udp</c>.</p>
       </item>
+
+      <marker id="sndbuf"></marker>
       <tag><c><![CDATA[sndbuf() = integer() <optional>]]></c></tag>
       <item>
         <p>Send buffer size. </p>
         <p>Default value is defined by <c>gen_udp</c>.</p>
       </item>
+
+      <marker id="note_store"></marker>
       <tag><c><![CDATA[note_store() = [note_store_opt()] <optional>]]></c></tag>
       <item>
         <p><c>note_store_opt() = {timeout, note_store_timeout()} |  {verbosity, verbosity()}</c></p>
         <p>Specifies the start-up verbosity for the SNMP note store.</p>
         <p>For defaults see the options in <c>note_store_opt()</c>.</p>
       </item>
+
+      <marker id="ns_timeout"></marker>
       <tag><c><![CDATA[note_store_timeout() = integer() <optional>]]></c></tag>
       <item>
         <p>Note cleanup time. When storing a note in the note store,
@@ -643,9 +734,9 @@
           milli-seconds.</p>
         <p>Default is <c>30000</c>.</p>
 
-      <marker id="audit_trail_log"></marker>
       </item>
 
+      <marker id="audit_trail_log"></marker>
       <tag><c><![CDATA[audit_trail_log() = [audit_trail_log_opt()] <optional>]]></c></tag>
       <item>
         <p><c>audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} |  {size, atl_size()} |  {repair, atl_repair()} | {seqno, atl_seqno()}</c></p>
@@ -655,6 +746,8 @@
           <c>size</c> options are mandatory.</p>
         <p>If not present, audit trail logging is not used.</p>
       </item>
+
+      <marker id="atl_type"></marker>
       <tag><c><![CDATA[atl_type() = read | write | read_write <optional>]]></c></tag>
       <item>
         <p>Specifies what type of an audit trail log should be used. 
@@ -675,12 +768,16 @@
         </list>
         <p>Default is <c>read_write</c>.</p>
       </item>
+
+      <marker id="atl_dir"></marker>
       <tag><c><![CDATA[atl_dir = dir() <mandatory>]]></c></tag>
       <item>
         <p>Specifies where the audit trail log should be stored.</p>
         <p>If <c>audit_trail_log</c> specifies that logging should take
           place, this parameter <em>must</em> be defined.</p>
       </item>
+
+      <marker id="atl_size"></marker>
       <tag><c><![CDATA[atl_size() = {integer(), integer()} <mandatory>]]></c></tag>
       <item>
         <p>Specifies the size of the audit
@@ -688,6 +785,8 @@
         <p>If <c>audit_trail_log</c> specifies that logging should 
           take place, this parameter <em>must</em> be defined.</p>
       </item>
+
+      <marker id="atl_repair"></marker>
       <tag><c><![CDATA[atl_repair() = true | false | truncate | snmp_repair <optional>]]></c></tag>
       <item>
         <p>Specifies if and how the audit trail log shall be repaired
@@ -699,6 +798,8 @@
           analysis.</p>
         <p>Default is <c>true</c>.</p>
       </item>
+
+      <marker id="atl_seqno"></marker>
       <tag><c><![CDATA[atl_seqno() = true | false <optional>]]></c></tag>
       <item>
         <p>Specifies if the audit trail log entries will be (sequence)