Răsfoiți Sursa

snmpstats Add IDs to sections in documentation

Olle E. Johansson 12 ani în urmă
părinte
comite
63a72893c8
2 a modificat fișierele cu 18 adăugiri și 18 ștergeri
  1. 8 8
      modules/snmpstats/README
  2. 10 10
      modules/snmpstats/doc/snmpstats_admin.xml

+ 8 - 8
modules/snmpstats/README

@@ -254,10 +254,10 @@ Chapter 1. Admin Guide
      * usrloc - all scalars and tables relating to users and contacts are
      * usrloc - all scalars and tables relating to users and contacts are
        dependent on the usrloc module. If the module is not loaded, the
        dependent on the usrloc module. If the module is not loaded, the
        respective tables will be empty.
        respective tables will be empty.
-     * dialog - all scalars relating to the number of dialogs are
-       dependent on the presence of the dialog module. Furthermore, if the
-       module is not loaded, then the kamailioDialogLimitMinorEvent, and
-       kamailioDialogLimitMajorEvent alarm will be disabled.
+     * dialog or dialog-ng - all scalars relating to the number of dialogs
+       are dependent on the presence of a dialog module. Furthermore, if
+       the module is not loaded, then the kamailioDialogLimitMinorEvent,
+       and kamailioDialogLimitMajorEvent alarm will be disabled.
 
 
    The contents of the kamailioSIPMethodSupportedTable change depending on
    The contents of the kamailioSIPMethodSupportedTable change depending on
    which modules are loaded.
    which modules are loaded.
@@ -429,7 +429,7 @@ modparam("snmpstats", "export_registrar", 1)
    There are several things that need to be done to get the SNMPStats
    There are several things that need to be done to get the SNMPStats
    module compiled and up and running.
    module compiled and up and running.
 
 
-6.1.  Compiling the SNMPStats Module
+6.1. Compiling the SNMPStats Module
 
 
    In order for the SNMPStats module to compile, you will need at least
    In order for the SNMPStats module to compile, you will need at least
    version 5.3 of the NetSNMP source code. The source can be found at:
    version 5.3 of the NetSNMP source code. The source can be found at:
@@ -451,7 +451,7 @@ modparam("snmpstats", "export_registrar", 1)
    recommended you install NetSNMP from source to avoid bringing in
    recommended you install NetSNMP from source to avoid bringing in
    excessive dependencies to the SNMPStats module.
    excessive dependencies to the SNMPStats module.
 
 
-6.2.  Configuring NetSNMP to allow connections from the SNMPStats module.
+6.2. Configuring NetSNMP to allow connections from the SNMPStats module.
 
 
    The SNMPStats module will communicate with the NetSNMP Master Agent.
    The SNMPStats module will communicate with the NetSNMP Master Agent.
    This communication happens over a protocol known as AgentX. This means
    This communication happens over a protocol known as AgentX. This means
@@ -483,7 +483,7 @@ modparam("snmpstats", "export_registrar", 1)
    This tells NetSNMP to act as a master agent, listening on the localhost
    This tells NetSNMP to act as a master agent, listening on the localhost
    UDP interface at port 705.
    UDP interface at port 705.
 
 
-6.3.  Configuring the SNMPStats module for communication with a Master Agent
+6.3. Configuring the SNMPStats module for communication with a Master Agent
 
 
    The previous section explained how to set up a NetSNMP master agent to
    The previous section explained how to set up a NetSNMP master agent to
    accept AgentX connections. We now need to tell the SNMPStats module how
    accept AgentX connections. We now need to tell the SNMPStats module how
@@ -503,7 +503,7 @@ modparam("snmpstats", "export_registrar", 1)
    be present on the same machine as Kamailio. localhost could be replaced
    be present on the same machine as Kamailio. localhost could be replaced
    with any other machine.
    with any other machine.
 
 
-6.4.  Testing for a proper Configuration
+6.4. Testing for a proper Configuration
 
 
    As a quick test to make sure that the SNMPStats module sub-agent can
    As a quick test to make sure that the SNMPStats module sub-agent can
    succesfully connect to the NetSNMP Master agent, start snmpd with the
    succesfully connect to the NetSNMP Master agent, start snmpd with the

+ 10 - 10
modules/snmpstats/doc/snmpstats_admin.xml

@@ -203,8 +203,8 @@
 		
 		
 		<listitem>
 		<listitem>
 		<para>
 		<para>
-		<emphasis>dialog</emphasis> - all scalars relating to the number of dialogs are 
-		dependent on the presence of the dialog module.  Furthermore, if the module is 
+		<emphasis>dialog or dialog-ng</emphasis> - all scalars relating to the number of dialogs are 
+		dependent on the presence of a dialog module.  Furthermore, if the module is 
 		not loaded, then the kamailioDialogLimitMinorEvent, and kamailioDialogLimitMajorEvent
 		not loaded, then the kamailioDialogLimitMinorEvent, and kamailioDialogLimitMajorEvent
 		alarm will be disabled. 
 		alarm will be disabled. 
 		</para>
 		</para>
@@ -243,7 +243,7 @@
 	</section>
 	</section>
 	<section>
 	<section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
+	<section id ="snmpstats.p.sipentitytape">
 		<title><varname>sipEntityType</varname> (String) </title>
 		<title><varname>sipEntityType</varname> (String) </title>
 
 
 		<para>
 		<para>
@@ -275,7 +275,7 @@ modparam("snmpstats", "sipEntityType", "proxyServer")
 		</para>
 		</para>
 	</section>
 	</section>
 
 
-	<section>
+	<section id ="snmpstats.p.MsqQueueMinorTreshold">
 		<title><varname>MsgQueueMinorThreshold</varname> (Integer)</title>
 		<title><varname>MsgQueueMinorThreshold</varname> (Integer)</title>
 
 
 		<para>
 		<para>
@@ -300,7 +300,7 @@ modparam("snmpstats", "MsgQueueMinorThreshold", 2000)
 		</para>
 		</para>
 	</section>
 	</section>
 	
 	
-	<section>
+	<section id ="snmpstats.p.MsqQueueMajorTreshold">
 		<title><varname>MsgQueueMajorThreshold</varname> (Integer)</title>
 		<title><varname>MsgQueueMajorThreshold</varname> (Integer)</title>
 
 
 		<para>
 		<para>
@@ -325,7 +325,7 @@ modparam("snmpstats", "MsgQueueMajorThreshold", 5000)
 		</para>
 		</para>
 	</section>
 	</section>
 
 
-	<section>
+	<section id ="snmpstats.p.dlg_minor_treshold">
 		<title><varname>dlg_minor_threshold</varname> (Integer)</title>
 		<title><varname>dlg_minor_threshold</varname> (Integer)</title>
 
 
 		<para>
 		<para>
@@ -349,7 +349,7 @@ modparam("snmpstats", "MsgQueueMajorThreshold", 5000)
 		</para>
 		</para>
 	</section>
 	</section>
 
 
-	<section>
+	<section id ="snmpstats.p.dlg_major_treshold">
 		<title><varname>dlg_major_threshold</varname> (Integer)</title>
 		<title><varname>dlg_major_threshold</varname> (Integer)</title>
 
 
 		<para>
 		<para>
@@ -373,7 +373,7 @@ modparam("snmpstats", "MsgQueueMajorThreshold", 5000)
 		</para>
 		</para>
 	</section>
 	</section>
 
 
-	<section>
+	<section id ="snmpstats.p.snmpgetPath">
 		<title><varname>snmpgetPath</varname> (String)</title>
 		<title><varname>snmpgetPath</varname> (String)</title>
 
 
 		<para>
 		<para>
@@ -399,7 +399,7 @@ modparam("snmpstats", "snmpgetPath",     "/my/custom/path/")
 		</example>
 		</example>
 	</section>
 	</section>
 	
 	
-	<section>
+	<section id ="snmpstats.p.snmpCommunity">
 		<title><varname>snmpCommunity</varname> (String)</title>
 		<title><varname>snmpCommunity</varname> (String)</title>
 
 
 		<para>
 		<para>
@@ -425,7 +425,7 @@ modparam("snmpstats", "snmpCommunity", "customCommunityString")
 		</example>
 		</example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id ="snmpstats.p.export_registrar">
 		<title><varname>export_registrar</varname> (int)</title>
 		<title><varname>export_registrar</varname> (int)</title>
 
 
 		<para>
 		<para>