aboutsummaryrefslogtreecommitdiffstats
path: root/lib/snmp/doc/src/snmp_app.xml
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2013-05-23 12:35:38 +0200
committerMicael Karlberg <[email protected]>2013-05-23 12:35:38 +0200
commit39540e7c380f6cb218a2ec6324f6296fa8327dba (patch)
treef94ceb3cd8f8c7bab9c0168f378f68dbd3a63baa /lib/snmp/doc/src/snmp_app.xml
parent69981c172621ed6f2e9fa7495b583af42f64c027 (diff)
downloadotp-39540e7c380f6cb218a2ec6324f6296fa8327dba.tar.gz
otp-39540e7c380f6cb218a2ec6324f6296fa8327dba.tar.bz2
otp-39540e7c380f6cb218a2ec6324f6296fa8327dba.zip
[snmp/agent] Updated open options for the mnesia mib-storage module
Updated the snmpa_mib_storage_mnesia module to handle alias atoms for the nodes option. Also, (git) added mib-storage behaviour ref-man.
Diffstat (limited to 'lib/snmp/doc/src/snmp_app.xml')
-rw-r--r--lib/snmp/doc/src/snmp_app.xml29
1 files changed, 26 insertions, 3 deletions
diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml
index c62c8f1541..f5a6de1099 100644
--- a/lib/snmp/doc/src/snmp_app.xml
+++ b/lib/snmp/doc/src/snmp_app.xml
@@ -329,7 +329,7 @@
behaviour. </p>
<p>Several entities (<c>mib-server</c> via the its data module and
the <c>symbolic-store</c>) of the snmp agent uses this for storage
- of miscelaneous mib data. </p>
+ of miscelaneous mib related data retrieved while loading a mib. </p>
<p>There are several implementations provided with the agent:
<c>snmpa_mib_storage_ets</c>, <c>snmpa_mib_storage_dets</c> and
<c>snmpa_mib_storage_mnesia</c>. </p>
@@ -340,7 +340,8 @@
<tag><c><![CDATA[mib_storage_options() = list() <optional>]]></c></tag>
<item>
<p>This is implementattion depended. That is, it depends on the
- module. For each module a specific set of options are valid: </p>
+ module. For each module a specific set of options are valid.
+ For the module provided with the app, these options are supported: </p>
<list type="bulleted">
<item>
<p><c>snmpa_mib_storage_ets</c>: <c>{dir, filename()} | {action, keep | clear}, {checksum, boolean()}</c></p>
@@ -395,7 +396,29 @@
<p>Default is <c>keep</c>. </p>
</item>
<item>
- <p><c>nodes</c> - Defines where to open the table. </p>
+ <p><c>nodes</c> - A list of node names (or an atom
+ describing a list of nodes) defining where to open the table.
+ Its up to the user to ensure that mnesia is actually running
+ on the specified nodes. </p>
+ <p>The following distinct values are recognised: </p>
+ <list>
+ <item>
+ <p><c>[]</c> - Translated into a list of the own node: <c>[node()]</c></p>
+ </item>
+ <item>
+ <p><c>all</c> - <c>erlang:nodes()</c></p>
+ </item>
+ <item>
+ <p><c>visible</c> - <c>erlang:nodes(visible)</c></p>
+ </item>
+ <item>
+ <p><c>connected</c> - <c>erlang:nodes(connected)</c></p>
+ </item>
+ <item>
+ <p><c>db_nodes</c> - <c>mnesia:system_info(db_nodes)</c></p>
+ </item>
+ </list>
+
<p>Default is the result of the call: <c>erlang:nodes()</c>. </p>
</item>
</list>