diff options
author | Micael Karlberg <bmk@erlang.org> | 2011-04-18 16:48:34 +0200 |
---|---|---|
committer | Micael Karlberg <bmk@erlang.org> | 2011-04-18 16:48:34 +0200 |
commit | 3e372b28827c3b5bc683ac08002af9cb8da5c692 (patch) | |
tree | c3e4ef0e5a5e17ab5f991ddcfbea9352d01fb7f4 | |
parent | 9022ef27b8628ca680654d542b4d520426480c2d (diff) | |
download | otp-3e372b28827c3b5bc683ac08002af9cb8da5c692.tar.gz otp-3e372b28827c3b5bc683ac08002af9cb8da5c692.tar.bz2 otp-3e372b28827c3b5bc683ac08002af9cb8da5c692.zip |
Also updated the dokumentation for the added function.
-rw-r--r-- | lib/snmp/doc/src/notes.xml | 4 | ||||
-rw-r--r-- | lib/snmp/doc/src/snmp_community_mib.xml | 26 |
2 files changed, 21 insertions, 9 deletions
diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml index b7e50c47e4..a098c909d4 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -46,8 +46,8 @@ <item> <p>[agent] To be able to handle multiple engine-id(s) when sending trap(s), the function - <seealso marker="snmp_community_mib:add_community">add_community/6</seealso> - has been added. </p> + <seealso marker="snmp_community_mib#add_community"> + add_community/6</seealso> has been added. </p> <p>Own Id: OTP-9119 Aux Id: Seq 11792</p> </item> diff --git a/lib/snmp/doc/src/snmp_community_mib.xml b/lib/snmp/doc/src/snmp_community_mib.xml index 7c7386af19..5e7bca3e27 100644 --- a/lib/snmp/doc/src/snmp_community_mib.xml +++ b/lib/snmp/doc/src/snmp_community_mib.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="iso-8859-1" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> - <year>1999</year><year>2009</year> + <year>1999</year><year>2011</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -35,11 +35,13 @@ <modulesummary>Instrumentation Functions for SNMP-COMMUNITY-MIB</modulesummary> <description> <p>The module <c>snmp_community_mib</c> implements the instrumentation - functions for the - SNMP-COMMUNITY-MIB, and functions for configuring the database. - </p> + functions for the SNMP-COMMUNITY-MIB, and functions for configuring the + database. </p> <p>The configuration files are described in the SNMP User's Manual.</p> + + <marker id="configure"></marker> </description> + <funcs> <func> <name>configure(ConfDir) -> void()</name> @@ -68,8 +70,11 @@ </p> <p>The configuration file read is: <c>community.conf</c>. </p> + + <marker id="reconfigure"></marker> </desc> </func> + <func> <name>reconfigure(ConfDir) -> void()</name> <fsummary>Configure the SNMP-COMMUNITY-MIB</fsummary> @@ -96,28 +101,35 @@ where the configuration files are found. </p> <p>The configuration file read is: <c>community.conf</c>.</p> + <marker id="add_community"></marker> </desc> </func> + <func> <name>add_community(Idx, CommName, SecName, CtxName, TransportTag) -> Ret</name> + <name>add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) -> Ret</name> <fsummary>Added one community</fsummary> <type> <v>Idx = string()</v> <v>CommName = string()</v> <v>SecName = string()</v> + <v>EngineId = string()</v> <v>CtxName = string()</v> <v>TransportTag = string()</v> <v>Ret = {ok, Key} | {error, Reason}</v> <v>Key = term()</v> - <v>Reason = term()</v> + <v>Reason = term()</v> </type> <desc> <p>Adds a community to the agent config. - Equivalent to one line in the <c>community.conf</c> file.</p> + Equivalent to one line in the <c>community.conf</c> file.</p> + <p>With the <c>EngineId</c> argument it is possible to + override the configured engine-id (SNMP-FRAMEWORK-MIB).</p> <marker id="delete_community"></marker> </desc> </func> + <func> <name>delete_community(Key) -> Ret</name> <fsummary>Delete one community</fsummary> |