aboutsummaryrefslogtreecommitdiffstats
path: root/lib/snmp/doc/src/snmp_target_mib.xml
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2011-03-03 14:27:32 +0100
committerMicael Karlberg <[email protected]>2011-03-03 14:27:32 +0100
commit4526ec71fc913993ec6c5f0a9c0e11192240a60a (patch)
treea77f5209a2fc5459805836121d76cd883915aa09 /lib/snmp/doc/src/snmp_target_mib.xml
parentd711ad48d29ea87398880e2655db72455334bf07 (diff)
downloadotp-4526ec71fc913993ec6c5f0a9c0e11192240a60a.tar.gz
otp-4526ec71fc913993ec6c5f0a9c0e11192240a60a.tar.bz2
otp-4526ec71fc913993ec6c5f0a9c0e11192240a60a.zip
Handling target address configuration files (with new Domain).
Also added some proper documentation.
Diffstat (limited to 'lib/snmp/doc/src/snmp_target_mib.xml')
-rw-r--r--lib/snmp/doc/src/snmp_target_mib.xml24
1 files changed, 19 insertions, 5 deletions
diff --git a/lib/snmp/doc/src/snmp_target_mib.xml b/lib/snmp/doc/src/snmp_target_mib.xml
index 4a36be19a3..d5151d41de 100644
--- a/lib/snmp/doc/src/snmp_target_mib.xml
+++ b/lib/snmp/doc/src/snmp_target_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>1998</year><year>2009</year>
+ <year>1998</year><year>2011</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -39,9 +39,21 @@
and functions for configuring the database. </p>
<p>The configuration files are described in the SNMP User's Manual.</p>
- <marker id="configure"></marker>
+ <marker id="types"></marker>
</description>
+ <section>
+ <title>DATA TYPES</title>
+ <code type="none"><![CDATA[
+transportDomain() = transportDomainUdpIpv4 | transportDomainUdpIpv6
+transportAddressIPv4() = [integer()], length 4
+transportAddressIPv6() = [integer()], length 8
+transportAddressMask() = [integer()], length 0 (default), 6 (IPv4) or 10 (IPv6)
+ ]]></code>
+
+ <marker id="configure"></marker>
+ </section>
+
<funcs>
<func>
<name>configure(ConfDir) -> void()</name>
@@ -118,17 +130,19 @@
<func>
<name>add_addr(Name, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</name>
+ <name>add_addr(Name, Domain, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</name>
<fsummary>Add one target address definition</fsummary>
<type>
<v>Name = string()</v>
- <v>Ip = [integer()], length 4</v>
+ <v>Domain = transportDomain()</v>
+ <v>Ip = transportAddressIPv4() | transportAddressIPv6() (depends on the value of Domain)</v>
<v>Port = integer()</v>
<v>Timeout = integer()</v>
<v>Retry = integer()</v>
<v>TagList = string()</v>
<v>ParamsName = string()</v>
<v>EngineId = string()</v>
- <v>TMask = string(), length 0 or 6</v>
+ <v>TMask = transportAddressMask() (depends on Domain)</v>
<v>MMS = integer()</v>
<v>Ret = {ok, Key} | {error, Reason}</v>
<v>Key = term()</v>