From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/snmp/doc/src/snmpm_conf.xml | 364 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 364 insertions(+) create mode 100644 lib/snmp/doc/src/snmpm_conf.xml (limited to 'lib/snmp/doc/src/snmpm_conf.xml') 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 @@ + + + + +
+ + 20062009 + Ericsson AB. All Rights Reserved. + + + 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. + + + + snmpm_conf + + + + + + + + snmpm_conf.xml +
+ snmpm_conf + Utility functions for handling the manager config files. + +

The module snmpm_conf contains various utility functions to + used for manipulating (write/append/read) the config files of the + SNMP manager.

+ + + + + manager_entry(Tag, Val) -> manager_entry() + Create an manager entry + + Tag = address | port | engine_id | max_message_size + Val = term() + manager_entry() = term() + + +

Create an entry for the manager config file, + manager.conf.

+

The type of Val depends on the value of Tag, + see + Manager Information + for more info.

+ + + + + write_manager_config(Dir, Conf) -> ok + write_manager_config(Dir, Hdr, Conf) -> ok + Write the manager config to the config file + + Dir = string() + Hdr = string() + Conf = [manager_entry()] + + +

Write the manager config to the manager config file.

+

Dir is the path to the directory where to store the + config file.

+

Hdr is an optional file header (note that this text is + written to the file as is).

+

See + Manager Information + for more info.

+ + + + + append_manager_config(Dir, Conf) -> ok + Append the manager config to the config file + + Dir = string() + Conf = [manager_entry()] + + +

Append the config to the current manager config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Manager Information + for more info.

+ + + + + read_manager_config(Dir) -> Conf + Read the manager config from the config file + + Dir = string() + Conf = [manager_entry()] + + +

Read the current manager config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Manager Information + for more info.

+ + + + + users_entry(UserId) -> users_entry() + users_entry(UserId, UserMod) -> users_entry() + users_entry(UserId, UserMod, UserData) -> users_entry() + Create an users entry + + UserId = term() + UserMod = atom() + UserData = term() + standard_entry() = term() + + +

Create an entry for the manager users config file, + users.conf.

+

users_entry(UserId) translates to the following call: + users_entry(UserId, snmpm_user_default).

+

users_entry(UserId, UserMod) translates to the following + call: users_entry(UserId, UserMod, undefined).

+

See + Users + for more info.

+ + + + + write_users_config(Dir, Conf) -> ok + write_users_config(Dir, Hdr, Conf) -> ok + Write the manager users config to the config file + + Dir = string() + Hdr = string() + Conf = [users_entry()] + + +

Write the manager users config to the manager users + config file.

+

Dir is the path to the directory where to store the + config file.

+

Hdr is an optional file header (note that this text is + written to the file as is).

+

See + Users + for more info.

+ + + + + append_users_config(Dir, Conf) -> ok + Append the manager users config to the config file + + Dir = string() + Conf = [users_entry()] + + +

Append the users config to the current manager users + config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Users + for more info.

+ + + + + read_users_config(Dir) -> Conf + Read the manager users config from the config file + + Dir = string() + Conf = [users_entry()] + + +

Read the current manager users config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Users + for more info.

+ + + + + agents_entry(UserId, TargetName, Comm, Ip, Port, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() + Create an agents entry + + UserId = term() + TargetName = string() + Comm = string() + Ip = string() + Port = integer() + EngineID = string() + Timeout = integer() + MaxMessageSize = integer() + Version = v1 | v2 | v3 + SecModel = v1 | v2c | usm + SecName = string() + SecLevel = noAuthNoPriv | authNoPriv | authPriv + agents_entry() = term() + + +

Create an entry for the manager agents config file, + agents.conf.

+

See + Agents + for more info.

+ + + + + write_agents_config(Dir, Conf) -> ok + write_agents_config(Dir, Hdr, Conf) -> ok + Write the manager agents to the config file + + Dir = string() + Hdr = string() + Conf = [_entry()] + + +

Write the manager agents config to the manager agents + config file.

+

Dir is the path to the directory where to store the + config file.

+

Hdr is an optional file header (note that this text is + written to the file as is).

+

See + Agents + for more info.

+ + + + + append_agents_config(Dir, Conf) -> ok + Append the manager agents to the config file + + Dir = string() + Conf = [agents_entry()] + + +

Append the agents config to the current manager agents + config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Agents + for more info.

+ + + + + read_agents_config(Dir) -> Conf + Read the manager agents config from the config file + + Dir = string() + Conf = [agents_entry()] + + +

Read the current manager agents config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Agents + for more info.

+ + + + + usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + Create an usm entry + + EngineID = string() + UserName = string() + SecName = string() + AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol + AuthKey = [integer()] + PrivP = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol + PrivKey = [integer()] + usm_entry() = term() + + +

Create an entry for the agent community config file, + community.conf.

+

See + Security data for USM + for more info.

+ + + + + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok + Write the manager usm config to the config file + + Dir = string() + Hdr = string() + Conf = [usm_entry()] + + +

Write the manager usm config to the manager usm + config file.

+

Dir is the path to the directory where to store the + config file.

+

Hdr is an optional file header (note that this text is + written to the file as is).

+

See + Security data for USM + for more info.

+ + + + + append_usm_config(Dir, Conf) -> ok + Append the manager usm config to the config file + + Dir = string() + Conf = [usm_entry()] + + +

Append the usm config to the current manager usm + config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Security data for USM + for more info.

+ + + + + read_usm_config(Dir) -> Conf + Read the manager usm config from the config file + + Dir = string() + Conf = [usm_entry()] + + +

Read the current manager usm config file.

+

Dir is the path to the directory where to store the + config file.

+

See + Security data for USM + for more info.

+ + + + + + + -- cgit v1.2.3