snmpa_discovery_handler(3erl) [linux man page]
snmpa_discovery_handler(3erl) Erlang Module Definition snmpa_discovery_handler(3erl) NAME
snmpa_discovery_handler - Behaviour module for the SNMP agent discovery handler. DESCRIPTION
This module defines the behaviour of the agent discovery handler. A snmpa_discovery_handler compliant module must export the following functions: * stage1_finish/2 The semantics of them and their exact signatures are explained below. EXPORTS
stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} Types TargetName = string() ManagerEngineID = string() ExtraInfo = term() usm_entry() = tuple() compatible with usm.conf NewExtraInfo = term() This function is called at the end of stage 1 of the discovery process. It should return either the atom ignore or {ok, usm_entry() | [usm_entry()]} . See usm_entry() and usm_entry/13 for more info. If the function returns ignore , then it is assumed that either: * The caller (of the discovery function) will make the needed updates later. * The callback function itself did the updates. In either case, the agent will do nothing, but return the retrieved ManagerEngineID (see discovery for more info) and possible con- tinue with stage 2 of the discovery process. The ExtraInfo argument is passed on from the discovery function. This function may return an updated NewExtraInfo that will be used in subsequent calls to the callback functions. Intended for future use. The purpose of this function is to generate the usm- related security data needed for usm processing in the agent. Specifically, updating the usmUserTable. When an usm_entry() tuple (or a list of such tuples) is returned, this data is then added to the usmUserTable by the (master-) agent. When an usm_entry() tuple (or a list of such tuples) is returned, this data is then added to the usmUserTable by the (master-) agent. Note: Note that the function does not check if this entry already exists. Note: Note that this function is executed in the context of the master-agent process. Ericsson AB snmp 4.19 snmpa_discovery_handler(3erl)
Check Out this Related Man Page
snmpm_conf(3erl) Erlang Module Definition snmpm_conf(3erl) NAME
snmpm_conf - Utility functions for handling the manager config files. DESCRIPTION
The module snmpm_conf contains various utility functions to used for manipulating (write/append/read) the config files of the SNMP manager. EXPORTS
manager_entry(Tag, Val) -> manager_entry() Types 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 Types 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 Types 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 Types 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() Types 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 Types 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 Types 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 Types 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() Types 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 Types 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 Types 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 Types 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() Types 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 Types 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 Types 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 Types 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. Ericsson AB snmp 4.19 snmpm_conf(3erl)