aboutsummaryrefslogtreecommitdiffstats
path: root/lib/snmp/doc/src/snmpm_conf.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/snmp/doc/src/snmpm_conf.xml')
-rw-r--r--lib/snmp/doc/src/snmpm_conf.xml364
1 files changed, 364 insertions, 0 deletions
diff --git a/lib/snmp/doc/src/snmpm_conf.xml b/lib/snmp/doc/src/snmpm_conf.xml
new file mode 100644
index 0000000000..177e29faa3
--- /dev/null
+++ b/lib/snmp/doc/src/snmpm_conf.xml
@@ -0,0 +1,364 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2006</year><year>2009</year>
+ <holder>Ericsson AB. All Rights Reserved.</holder>
+ </copyright>
+ <legalnotice>
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
+
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
+
+ </legalnotice>
+
+ <title>snmpm_conf</title>
+ <prepared></prepared>
+ <responsible></responsible>
+ <docno></docno>
+ <approved></approved>
+ <checked></checked>
+ <date></date>
+ <rev></rev>
+ <file>snmpm_conf.xml</file>
+ </header>
+ <module>snmpm_conf</module>
+ <modulesummary>Utility functions for handling the manager config files.</modulesummary>
+ <description>
+ <p>The module <c>snmpm_conf</c> contains various utility functions to
+ used for manipulating (write/append/read) the config files of the
+ SNMP manager. </p>
+ <marker id="manager_entry"></marker>
+ </description>
+ <funcs>
+ <func>
+ <name>manager_entry(Tag, Val) -> manager_entry()</name>
+ <fsummary>Create an manager entry</fsummary>
+ <type>
+ <v>Tag = address | port | engine_id | max_message_size</v>
+ <v>Val = term()</v>
+ <v>manager_entry() = term()</v>
+ </type>
+ <desc>
+ <p>Create an entry for the manager config file,
+ <c>manager.conf</c>. </p>
+ <p>The type of <c>Val</c> depends on the value of <c>Tag</c>,
+ see
+ <seealso marker="snmp_manager_config_files#manager_information">Manager Information</seealso>
+ for more info. </p>
+ <marker id="write_manager_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>write_manager_config(Dir, Conf) -> ok</name>
+ <name>write_manager_config(Dir, Hdr, Conf) -> ok</name>
+ <fsummary>Write the manager config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Hdr = string()</v>
+ <v>Conf = [manager_entry()]</v>
+ </type>
+ <desc>
+ <p>Write the manager config to the manager config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p><c>Hdr</c> is an optional file header (note that this text is
+ written to the file as is). </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#manager_information">Manager Information</seealso>
+ for more info. </p>
+ <marker id="append_manager_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>append_manager_config(Dir, Conf) -> ok</name>
+ <fsummary>Append the manager config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [manager_entry()]</v>
+ </type>
+ <desc>
+ <p>Append the config to the current manager config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#manager_information">Manager Information</seealso>
+ for more info. </p>
+ <marker id="read_manager_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>read_manager_config(Dir) -> Conf</name>
+ <fsummary>Read the manager config from the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [manager_entry()]</v>
+ </type>
+ <desc>
+ <p>Read the current manager config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#manager_information">Manager Information</seealso>
+ for more info. </p>
+ <marker id="users_entry"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>users_entry(UserId) -> users_entry()</name>
+ <name>users_entry(UserId, UserMod) -> users_entry()</name>
+ <name>users_entry(UserId, UserMod, UserData) -> users_entry()</name>
+ <fsummary>Create an users entry</fsummary>
+ <type>
+ <v>UserId = term()</v>
+ <v>UserMod = atom()</v>
+ <v>UserData = term()</v>
+ <v>standard_entry() = term()</v>
+ </type>
+ <desc>
+ <p>Create an entry for the manager users config file,
+ <c>users.conf</c>. </p>
+ <p><c>users_entry(UserId)</c> translates to the following call:
+ <c>users_entry(UserId, snmpm_user_default)</c>. </p>
+ <p><c>users_entry(UserId, UserMod)</c> translates to the following
+ call: <c>users_entry(UserId, UserMod, undefined)</c>. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#users">Users</seealso>
+ for more info. </p>
+ <marker id="write_users_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>write_users_config(Dir, Conf) -> ok</name>
+ <name>write_users_config(Dir, Hdr, Conf) -> ok</name>
+ <fsummary>Write the manager users config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Hdr = string()</v>
+ <v>Conf = [users_entry()]</v>
+ </type>
+ <desc>
+ <p>Write the manager users config to the manager users
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p><c>Hdr</c> is an optional file header (note that this text is
+ written to the file as is). </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#users">Users</seealso>
+ for more info. </p>
+ <marker id="append_users_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>append_users_config(Dir, Conf) -> ok</name>
+ <fsummary>Append the manager users config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [users_entry()]</v>
+ </type>
+ <desc>
+ <p>Append the users config to the current manager users
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#users">Users</seealso>
+ for more info. </p>
+ <marker id="read_users_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>read_users_config(Dir) -> Conf</name>
+ <fsummary>Read the manager users config from the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [users_entry()]</v>
+ </type>
+ <desc>
+ <p>Read the current manager users config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#users">Users</seealso>
+ for more info. </p>
+ <marker id="agents_entry"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>agents_entry(UserId, TargetName, Comm, Ip, Port, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry()</name>
+ <fsummary>Create an agents entry</fsummary>
+ <type>
+ <v>UserId = term()</v>
+ <v>TargetName = string()</v>
+ <v>Comm = string()</v>
+ <v>Ip = string()</v>
+ <v>Port = integer()</v>
+ <v>EngineID = string()</v>
+ <v>Timeout = integer()</v>
+ <v>MaxMessageSize = integer()</v>
+ <v>Version = v1 | v2 | v3</v>
+ <v>SecModel = v1 | v2c | usm</v>
+ <v>SecName = string()</v>
+ <v>SecLevel = noAuthNoPriv | authNoPriv | authPriv</v>
+ <v>agents_entry() = term()</v>
+ </type>
+ <desc>
+ <p>Create an entry for the manager agents config file,
+ <c>agents.conf</c>. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#agents">Agents</seealso>
+ for more info. </p>
+ <marker id="write_agents_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>write_agents_config(Dir, Conf) -> ok</name>
+ <name>write_agents_config(Dir, Hdr, Conf) -> ok</name>
+ <fsummary>Write the manager agents to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Hdr = string()</v>
+ <v>Conf = [_entry()]</v>
+ </type>
+ <desc>
+ <p>Write the manager agents config to the manager agents
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p><c>Hdr</c> is an optional file header (note that this text is
+ written to the file as is). </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#agents">Agents</seealso>
+ for more info. </p>
+ <marker id="append_agents_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>append_agents_config(Dir, Conf) -> ok</name>
+ <fsummary>Append the manager agents to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [agents_entry()]</v>
+ </type>
+ <desc>
+ <p>Append the agents config to the current manager agents
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#agents">Agents</seealso>
+ for more info. </p>
+ <marker id="read_agents_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>read_agents_config(Dir) -> Conf</name>
+ <fsummary>Read the manager agents config from the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [agents_entry()]</v>
+ </type>
+ <desc>
+ <p>Read the current manager agents config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#agents">Agents</seealso>
+ for more info. </p>
+ <marker id="usm_entry"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry()</name>
+ <name>usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry()</name>
+ <fsummary>Create an usm entry</fsummary>
+ <type>
+ <v>EngineID = string()</v>
+ <v>UserName = string()</v>
+ <v>SecName = string()</v>
+ <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol</v>
+ <v>AuthKey = [integer()]</v>
+ <v>PrivP = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol</v>
+ <v>PrivKey = [integer()]</v>
+ <v>usm_entry() = term()</v>
+ </type>
+ <desc>
+ <p>Create an entry for the agent community config file,
+ <c>community.conf</c>. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#usm">Security data for USM</seealso>
+ for more info. </p>
+ <marker id="write_usm_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>write_usm_config(Dir, Conf) -> ok</name>
+ <name>write_usm_config(Dir, Hdr, Conf) -> ok</name>
+ <fsummary>Write the manager usm config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Hdr = string()</v>
+ <v>Conf = [usm_entry()]</v>
+ </type>
+ <desc>
+ <p>Write the manager usm config to the manager usm
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p><c>Hdr</c> is an optional file header (note that this text is
+ written to the file as is). </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#usm">Security data for USM</seealso>
+ for more info. </p>
+ <marker id="append_usm_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>append_usm_config(Dir, Conf) -> ok</name>
+ <fsummary>Append the manager usm config to the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [usm_entry()]</v>
+ </type>
+ <desc>
+ <p>Append the usm config to the current manager usm
+ config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#usm">Security data for USM</seealso>
+ for more info. </p>
+ <marker id="read_usm_config"></marker>
+ </desc>
+ </func>
+ <func>
+ <name>read_usm_config(Dir) -> Conf</name>
+ <fsummary>Read the manager usm config from the config file</fsummary>
+ <type>
+ <v>Dir = string()</v>
+ <v>Conf = [usm_entry()]</v>
+ </type>
+ <desc>
+ <p>Read the current manager usm config file. </p>
+ <p><c>Dir</c> is the path to the directory where to store the
+ config file. </p>
+ <p>See
+ <seealso marker="snmp_manager_config_files#usm">Security data for USM</seealso>
+ for more info. </p>
+ <marker id="end"></marker>
+ </desc>
+ </func>
+ </funcs>
+
+</erlref>
+