diff options
Diffstat (limited to 'lib/snmp/doc/src/snmpa_conf.xml')
| -rw-r--r-- | lib/snmp/doc/src/snmpa_conf.xml | 861 |
1 files changed, 861 insertions, 0 deletions
diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml new file mode 100644 index 0000000000..f383394b7a --- /dev/null +++ b/lib/snmp/doc/src/snmpa_conf.xml @@ -0,0 +1,861 @@ +<?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>snmpa_conf</title> + <prepared></prepared> + <responsible></responsible> + <docno></docno> + <approved></approved> + <checked></checked> + <date></date> + <rev></rev> + <file>snmpa_conf.xml</file> + </header> + <module>snmpa_conf</module> + <modulesummary>Utility functions for handling the agent config files.</modulesummary> + <description> + <p>The module <c>snmpa_conf</c> contains various utility functions to + used for manipulating (write/append/read) the config files of the + SNMP agent. </p> + + <marker id="agent_entry"></marker> + </description> + <funcs> + <func> + <name>agent_entry(Tag, Val) -> agent_entry()</name> + <fsummary>Create an agent entry</fsummary> + <type> + <v>Tag = intAgentIpAddress | intAgentUDPPort | intAgentMaxPacketSize | snmpEngineMaxMessageSize | snmpEngineID</v> + <v>Val = term()</v> + <v>agent_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent config file, <c>agent.conf</c>. </p> + <p>The type of <c>Val</c> depends on the value of <c>Tag</c>, + see + <seealso marker="snmp_agent_config_files#agent_information">Agent Information</seealso> + for more info. </p> + + <marker id="write_agent_config"></marker> + </desc> + </func> + + <func> + <name>write_agent_config(Dir, Conf) -> ok</name> + <name>write_agent_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [agent_entry()]</v> + </type> + <desc> + <p>Write the agent config to the agent 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_agent_config_files#agent_information">Agent Information</seealso> + for more info. </p> + + <marker id="append_agent_config"></marker> + </desc> + </func> + + <func> + <name>append_agent_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [agent_entry()]</v> + </type> + <desc> + <p>Append the config to the current agent 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_agent_config_files#agent_information">Agent Information</seealso> + for more info. </p> + + <marker id="read_agent_config"></marker> + </desc> + </func> + + <func> + <name>read_agent_config(Dir) -> Conf</name> + <fsummary>Read the agent config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [agent_entry()]</v> + </type> + <desc> + <p>Read the current agent 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_agent_config_files#agent_information">Agent Information</seealso> + for more info. </p> + + <marker id="standard_entry"></marker> + </desc> + </func> + + <func> + <name>standard_entry(Tag, Val) -> standard_entry()</name> + <fsummary>Create an standard entry</fsummary> + <type> + <v>Tag = sysDescr | sysObjectID | sysContact | sysName | sysLocation | sysServices | snmpEnableAuthenTraps</v> + <v>Val = term()</v> + <v>standard_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent standard config file, + <c>standard.conf</c>. </p> + <p>The type of <c>Val</c> depends on the value of <c>Tag</c>, + see + <seealso marker="snmp_agent_config_files#system_information">System Information</seealso> + for more info. </p> + + <marker id="write_standard_config"></marker> + </desc> + </func> + + <func> + <name>write_standard_config(Dir, Conf) -> ok</name> + <name>write_standard_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent standard config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [standard_entry()]</v> + </type> + <desc> + <p>Write the agent standard config to the agent standard + 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_agent_config_files#system_information">System Information</seealso> + for more info. </p> + + <marker id="append_standard_config"></marker> + </desc> + </func> + + <func> + <name>append_standard_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent standard config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [standard_entry()]</v> + </type> + <desc> + <p>Append the standard config to the current agent standard + 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_agent_config_files#system_information">System Information</seealso> + for more info. </p> + + <marker id="read_standard_config"></marker> + </desc> + </func> + + <func> + <name>read_standard_config(Dir) -> Conf</name> + <fsummary>Read the agent standard config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [standard_entry()]</v> + </type> + <desc> + <p>Read the current agent standard 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_agent_config_files#system_information">System Information</seealso> + for more info. </p> + + <marker id="context_entry"></marker> + </desc> + </func> + + <func> + <name>context_entry(Context) -> context_entry()</name> + <fsummary>Create an context entry</fsummary> + <type> + <v>Context = string()</v> + <v>context_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent context config file, + <c>context.conf</c>. </p> + <p>See + <seealso marker="snmp_agent_config_files#context">Contexts</seealso> + for more info. </p> + + <marker id="write_context_config"></marker> + </desc> + </func> + + <func> + <name>write_context_config(Dir, Conf) -> ok</name> + <name>write_context_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent context(s) to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [context_entry()]</v> + </type> + <desc> + <p>Write the agent context config to the agent context + 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_agent_config_files#context">Contexts</seealso> + for more info. </p> + + <marker id="append_context_config"></marker> + </desc> + </func> + + <func> + <name>append_context_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent context(s) to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [context_entry()]</v> + </type> + <desc> + <p>Append the context config to the current agent context + 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_agent_config_files#context">Contexts</seealso> + for more info. </p> + + <marker id="read_context_config"></marker> + </desc> + </func> + + <func> + <name>read_context_config(Dir) -> Conf</name> + <fsummary>Read the agent context config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [context_entry()]</v> + </type> + <desc> + <p>Read the current agent context 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_agent_config_files#context">Contexts</seealso> + for more info. </p> + + <marker id="community_entry"></marker> + </desc> + </func> + + <func> + <name>community_entry(CommunityIndex) -> community_entry()</name> + <name>community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry()</name> + <fsummary>Create an community entry</fsummary> + <type> + <v>CommunityIndex = string()</v> + <v>CommunityName = string()</v> + <v>SecName = string()</v> + <v>CtxName = string()</v> + <v>TransportTag = string()</v> + <v>community_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent community config file, + <c>community.conf</c>. </p> + <p><c>CommunityIndex</c> must be a <em>non-empty</em> string. </p> + <p><c>community_entry("public")</c> translates to the following call: + <c>community_entry(CommunityIndex, CommunityIndex, "initial", "", "")</c>. </p> + <p><c>community_entry("all-rights")</c> translates to the following + call: <c>community_entry(CommunityIndex, CommunityIndex, CommunityIndex, "", "")</c>. </p> + <p>See + <seealso marker="snmp_agent_config_files#community">Community</seealso> + for more info. </p> + + <marker id="write_community_config"></marker> + </desc> + </func> + + <func> + <name>write_community_config(Dir, Conf) -> ok</name> + <name>write_community_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent community config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [community_entry()]</v> + </type> + <desc> + <p>Write the agent community config to the agent community + 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_agent_config_files#community">Community</seealso> + for more info. </p> + + <marker id="append_community_config"></marker> + </desc> + </func> + + <func> + <name>append_community_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent community config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [community_entry()]</v> + </type> + <desc> + <p>Append the community config to the current agent community + 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_agent_config_files#community">Community</seealso> + for more info. </p> + + <marker id="read_community_config"></marker> + </desc> + </func> + + <func> + <name>read_community_config(Dir) -> Conf</name> + <fsummary>Read the agent community config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [community_entry()]</v> + </type> + <desc> + <p>Read the current agent community 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_agent_config_files#community">Communities</seealso> + for more info. </p> + + <marker id="target_addr_entry"></marker> + </desc> + </func> + + <func> + <name>target_addr_entry(Name, Ip, TagList, ParamsName, EngineId) -> target_addr_entry()</name> + <name>target_addr_entry(Name, Ip, TagList, ParamsName, EngineId, TMask) -> target_addr_entry()</name> + <name>target_addr_entry(Name, Ip, Udp, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry()</name> + <name>target_addr_entry(Name, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry()</name> + <fsummary>Create an target_addr entry</fsummary> + <type> + <v>Name = string()</v> + <v>Ip = string()</v> + <v>Udp = integer()</v> + <v>Timeout = integer()</v> + <v>RetryCount = integer()</v> + <v>TagList = string()</v> + <v>ParamsName = string()</v> + <v>EngineId = string()</v> + <v>TMask = string()</v> + <v>MaxMessageSize = integer()</v> + <v>target_addr_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent target_addr config file, + <c>target_addr.conf</c>. </p> + <p><c>Name</c> must be a <em>non-empty</em> string. </p> + <p><c>target_addr_entry/5</c> translates to the following call: + <c>target_addr_entry(Name, Ip, TagList, ParamsName, EngineId)</c>. </p> + <p><c>target_addr_entry/6</c> translates to the following call: + <c>target_addr_entry(Name, Ip, 162, TagList, ParamsName, EngineId, TMask, 2048)</c>. </p> + <p><c>target_addr_entry/8</c> translates to the following call: + <c>target_addr_entry(Name, Ip, Udp, 1500, 3, TagList, ParamsName, EngineId, TMask, MaxMessageSize)</c>. </p> + <p>See + <seealso marker="snmp_agent_config_files#target_addr">Target Address Definitions</seealso> + for more info. </p> + + <marker id="write_target_addr_config"></marker> + </desc> + </func> + + <func> + <name>write_target_addr_config(Dir, Conf) -> ok</name> + <name>write_target_addr_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent target_addr config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [target_addr_entry()]</v> + </type> + <desc> + <p>Write the agent target_addr config to the agent target_addr + 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_agent_config_files#target_addr">Target Address Definitions</seealso> + for more info. </p> + + <marker id="append_target_addr_config"></marker> + </desc> + </func> + + <func> + <name>append_target_addr_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent target_addr config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [target_addr_entry()]</v> + </type> + <desc> + <p>Append the target_addr config to the current agent target_addr + 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_agent_config_files#target_addr">Target Address Definitions</seealso> + for more info. </p> + + <marker id="read_target_addr_config"></marker> + </desc> + </func> + + <func> + <name>read_target_addr_config(Dir) -> Conf</name> + <fsummary>Read the agent target_addr config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [target_addr_entry()]</v> + </type> + <desc> + <p>Read the current agent target_addr 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_agent_config_files#target_addr">Target Address Definitions</seealso> + for more info. </p> + + <marker id="target_params_entry"></marker> + </desc> + </func> + + <func> + <name>target_params_entry(Name, Vsn) -> target_params_entry()</name> + <name>target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry()</name> + <name>target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry()</name> + <fsummary>Create an target_params entry</fsummary> + <type> + <v>Name = string()</v> + <v>Vsn = v1 | v2 | v3</v> + <v>MPModel = v1 | v2c | v3</v> + <v>SecModel = v1 | v2c | usm</v> + <v>SecName = string()</v> + <v>SecLevel = noAuthNoPriv | authNoPriv | authPriv</v> + <v>target_params_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent target_params config file, + <c>target_params.conf</c>. </p> + <p><c>Name</c> must be a <em>non-empty</em> string. </p> + <p><c>Vsn</c> translates into <c>MPModel</c> and <c>SecModel</c> as follows:</p> + <pre> +\011 Vsn = v1 => MPModel = v1, SecModel = v1 +\011 Vsn = v2 => MPModel = v2c, SecModel = v2c +\011 Vsn = v3 => MPModel = v3, SecModel = usm + </pre> + <p><c>target_params_entry/2</c> translates to the following call: + <c>target_params_entry(Name, Vsn, "initial", noAuthNoPriv)</c>. </p> + <p><c>target_params_entry/4</c> translates to the following + call: <c>target_params_entry(Name, MPModel, SecModel, SecName, SecLevel)</c> where <c>MPModel</c> and + <c>SecModel</c> is mapped from <c>Vsn</c>, see above. </p> + <p>See + <seealso marker="snmp_agent_config_files#target_params">Target Parameters Definitions</seealso> + for more info. </p> + + <marker id="write_target_params_config"></marker> + </desc> + </func> + + <func> + <name>write_target_params_config(Dir, Conf) -> ok</name> + <name>write_target_params_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent target_params config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [target_params_entry()]</v> + </type> + <desc> + <p>Write the agent target_params config to the agent target_params + 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_agent_config_files#target_params">Target Parameters Definitions</seealso> + for more info. </p> + + <marker id="append_target_params_config"></marker> + </desc> + </func> + + <func> + <name>append_target_params_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent target_params config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [target_params_entry()]</v> + </type> + <desc> + <p>Append the target_params config to the current agent target_params + 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_agent_config_files#target_params">Target Parameters Definitions</seealso> + for more info. </p> + + <marker id="read_target_params_config"></marker> + </desc> + </func> + + <func> + <name>read_target_params_config(Dir) -> Conf</name> + <fsummary>Read the agent target_params config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [target_params_entry()]</v> + </type> + <desc> + <p>Read the current agent target_params 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_agent_config_files#target_params">Target Parameters Definitions</seealso> + for more info. </p> + + <marker id="vacm_entry"></marker> + </desc> + </func> + + <func> + <name>vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry()</name> + <name>vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry()</name> + <name>vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry()</name> + <name>vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry()</name> + <fsummary>Create an vacm entry</fsummary> + <type> + <v>SecModel = v1 | v2c | usm</v> + <v>SecName = string()</v> + <v>GroupName = string()</v> + <v>Prefix = string()</v> + <v>SecLevel = noAuthNoPriv | authNoPriv | authPriv</v> + <v>Match = prefix | exact</v> + <v>ReadView = string()</v> + <v>WriteView = string()</v> + <v>NotifyView = string()</v> + <v>ViewIndex = integer()</v> + <v>ViewSubtree = [integer()]</v> + <v>ViewStatus = included | excluded</v> + <v>ViewMask = null | [zero_or_one()]</v> + <v>zero_or_one() = 0 | 1</v> + <v>vacm_s2g_entry() = term()</v> + <v>vacm_acc_entry() = term()</v> + <v>vacm_vtf_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent vacm config file, + <c>vacm.conf</c>. </p> + <p><c>vacm_vtf_entry/2</c> translates to the following call: + <c>vacm_vtf_entry(ViewIndex, ViewSubtree, included, null)</c>. </p> + <p>See + <seealso marker="snmp_agent_config_files#vacm">MIB Views for VACM</seealso> + for more info. </p> + + <marker id="write_vacm_config"></marker> + </desc> + </func> + + <func> + <name>write_vacm_config(Dir, Conf) -> ok</name> + <name>write_vacm_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent vacm config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [vacm_entry()]</v> + <v>vacm_entry() = vacm_sg2_entry() | vacm_acc_entry() | vacm_vtf_entry()</v> + </type> + <desc> + <p>Write the agent vacm config to the agent vacm + 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_agent_config_files#vacm">MIB Views for VACM</seealso> + for more info. </p> + + <marker id="append_vacm_config"></marker> + </desc> + </func> + + <func> + <name>append_vacm_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent vacm config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [vacm_entry()]</v> + </type> + <desc> + <p>Append the vacm config to the current agent vacm + 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_agent_config_files#vacm">MIB Views for VACM</seealso> + for more info. </p> + + <marker id="read_vacm_config"></marker> + </desc> + </func> + + <func> + <name>read_vacm_config(Dir) -> Conf</name> + <fsummary>Read the agent vacm config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [vacm_entry()]</v> + </type> + <desc> + <p>Read the current agent vacm 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_agent_config_files#vacm">MIB Views for VACM</seealso> + for more info. </p> + + <marker id="usm_entry"></marker> + </desc> + </func> + + <func> + <name>usm_entry(EngineId) -> usm_entry()</name> + <name>usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry()</name> + <fsummary>Create an usm entry</fsummary> + <type> + <v>EngineId = string()</v> + <v>UserName = string()</v> + <v>SecName = string()</v> + <v>Clone = zeroDotZero | [integer()]</v> + <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol, | usmHMACSHAAuthProtocol</v> + <v>AuthKeyC = string()</v> + <v>OwnAuthKeyC = string()</v> + <v>PrivP = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol</v> + <v>PrivKeyC = string()</v> + <v>OwnPrivKeyC = string()</v> + <v>Public = string()</v> + <v>AuthKey = [integer()]</v> + <v>PrivKey = [integer()]</v> + <v>usm_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent vacm config file, + <c>vacm.conf</c>. </p> + <p><c>usm_entry/1</c> translates to the following call: + <c>usm_entry("initial", "initial", zeroDotZero, usmNoAuthProtocol, "", "", usmNoPrivProtocol, "", "", "", "", "")</c>. </p> + <p>See + <seealso marker="snmp_agent_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 agent 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 agent usm config to the agent 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_agent_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 agent 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 agent vacm + 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_agent_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 agent usm config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [usm_entry()]</v> + </type> + <desc> + <p>Read the current agent 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_agent_config_files#usm">Security data for USM</seealso> + for more info. </p> + + <marker id="notify_entry"></marker> + </desc> + </func> + + <func> + <name>notify_entry(Name, Tag, Type) -> notify_entry()</name> + <fsummary>Create an notify entry</fsummary> + <type> + <v>Name = string()</v> + <v>Tag = string()</v> + <v>Type = trap | inform</v> + <v>community_entry() = term()</v> + </type> + <desc> + <p>Create an entry for the agent notify config file, + <c>notify.conf</c>. </p> + <p><c>Name</c> must be a <em>non-empty</em> string. </p> + <p>See + <seealso marker="snmp_agent_config_files#notify">Notify Definitions</seealso> + for more info. </p> + + <marker id="write_notify_config"></marker> + </desc> + </func> + + <func> + <name>write_notify_config(Dir, Conf) -> ok</name> + <name>write_notify_config(Dir, Hdr, Conf) -> ok</name> + <fsummary>Write the agent notify config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Hdr = string()</v> + <v>Conf = [notify_entry()]</v> + </type> + <desc> + <p>Write the agent notify config to the agent notify + 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_agent_config_files#notify">Notify Definitions</seealso> + for more info. </p> + + <marker id="append_notify_config"></marker> + </desc> + </func> + + <func> + <name>append_notify_config(Dir, Conf) -> ok</name> + <fsummary>Append the agent notify config to the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [notify_entry()]</v> + </type> + <desc> + <p>Append the notify config to the current agent notify + 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_agent_config_files#notify">Notify Definitions</seealso> + for more info. </p> + + <marker id="read_notify_config"></marker> + </desc> + </func> + + <func> + <name>read_notify_config(Dir) -> Conf</name> + <fsummary>Read the agent notify config from the config file</fsummary> + <type> + <v>Dir = string()</v> + <v>Conf = [community_entry()]</v> + </type> + <desc> + <p>Read the current agent notify 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_agent_config_files#notify">Notify Definitions</seealso> + for more info. </p> + <marker id="end"></marker> + </desc> + </func> + </funcs> + +</erlref> + |