查看源代码 snmpm_conf (snmp v5.18)
用于处理管理器配置文件的实用函数。
模块 snmpm_conf 包含各种实用函数，用于操作（写入/追加/读取）SNMP 管理器的配置文件。
概要
类型
一个不透明的数据结构，包含管理器中一个代理的所有配置。
一个不透明的数据结构，表示管理器的单个配置条目。
一个不透明的数据结构，包含管理器中一个用户的所有配置。
一个不透明的数据结构，包含有关管理器中 USM 的安全数据的信息。
函数
为管理器代理配置文件 agents.conf 创建一个条目。
将代理配置追加到当前管理器代理配置文件。
将配置追加到当前管理器配置文件。
将用户配置追加到当前管理器用户配置文件。
将 USM 配置追加到当前管理器 USM 配置文件。
为管理器配置文件 manager.conf 创建一个条目。
读取当前管理器代理配置文件。
读取当前管理器配置文件。
读取当前管理器用户配置文件。
读取当前管理器 USM 配置文件。
为管理器用户配置文件 users.conf 创建一个条目。
为代理社区配置文件 community.conf 创建一个条目。
将管理器代理配置写入管理器代理配置文件。
将管理器配置写入管理器配置文件。
将管理器用户配置写入管理器用户配置文件。
将管理器 USM 配置写入管理器 USM 配置文件。
类型
-opaque agent_entry()
一个不透明的数据结构，包含管理器中一个代理的所有配置。
-opaque manager_entry()
一个不透明的数据结构，表示管理器的单个配置条目。
-opaque user_entry()
一个不透明的数据结构，包含管理器中一个用户的所有配置。
-opaque usm_entry()
一个不透明的数据结构，包含有关管理器中 USM 的安全数据的信息。
函数
-spec agents_entry(UserId, TargetName, Comm, TDomain, TAddr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> Entry when UserId :: snmpm:user_id(), TargetName :: snmpm:target_name(), Comm :: snmp:community(), TDomain :: snmp:tdomain(), TAddr :: snmp:taddress(), EngineID :: snmp:engine_id(), Timeout :: snmpm:register_timeout(), MaxMessageSize :: snmp:mms(), Version :: snmp:version(), SecModel :: snmp:sec_model(), SecName :: snmp:sec_name(), SecLevel :: snmp:sec_level(), Entry :: agent_entry(); (UserId, TargetName, Comm, Ip, Port, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> Entry when UserId :: snmpm:user_id(), TargetName :: snmpm:target_name(), Comm :: snmp:community(), Ip :: inet:ip_address(), Port :: inet:port_number(), EngineID :: snmp:engine_id(), Timeout :: snmpm:register_timeout(), MaxMessageSize :: snmp:mms(), Version :: snmp:version(), SecModel :: snmp:sec_model(), SecName :: snmp:sec_name(), SecLevel :: snmp:sec_level(), Entry :: agent_entry().
为管理器代理配置文件 agents.conf 创建一个条目。
有关详细信息，请参阅 代理。
-spec append_agents_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [agent_entry()].
将代理配置追加到当前管理器代理配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 代理。
-spec append_manager_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [manager_entry()].
将配置追加到当前管理器配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅管理器信息。
-spec append_users_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].
将用户配置追加到当前管理器用户配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 用户。
将 USM 配置追加到当前管理器 USM 配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 USM 的安全数据。
-spec manager_entry(Tag, Val) -> ManagerEntry when Tag :: transports | port | engine_id | max_message_size, Val :: term(), ManagerEntry :: manager_entry(); (Tag, Val) -> ManagerEntry when Tag :: address, Val :: term(), ManagerEntry :: manager_entry().
为管理器配置文件 manager.conf 创建一个条目。
Val 的类型取决于 Tag 的值，有关详细信息，请参阅 管理器信息。
-spec read_agents_config(Dir) -> {ok, Conf} | {error, Reason} when Dir :: snmp:dir(), Conf :: [agent_entry()], Reason :: term().
读取当前管理器代理配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 代理。
-spec read_manager_config(Dir) -> {ok, Conf} | {error, Reason} when Dir :: snmp:dir(), Conf :: [manager_entry()], Reason :: term().
读取当前管理器配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅管理器信息。
-spec read_users_config(Dir) -> {ok, Conf} | {error, Reason} when Dir :: snmp:dir(), Conf :: [user_entry()], Reason :: term().
读取当前管理器用户配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 用户。
-spec read_usm_config(Dir) -> {ok, Conf} | {error, Reason} when Dir :: snmp:dir(), Conf :: [usm_entry()], Reason :: term().
读取当前管理器 USM 配置文件。
Dir 是存储配置文件的目录路径。
有关详细信息，请参阅 USM 的安全数据。
-spec users_entry(UserId) -> UserEntry when UserId :: snmpm:user_id(), UserEntry :: user_entry().
-spec users_entry(UserId, UserMod) -> UserEntry when UserId :: snmpm:user_id(), UserMod :: snmpm:snmpm_user(), UserEntry :: user_entry().
-spec users_entry(UserId, UserMod, UserData) -> UserEntry when UserId :: snmpm:user_id(), UserMod :: snmpm:snmpm_user(), UserData :: term(), UserEntry :: user_entry().
-spec users_entry(UserId, UserMod, UserData, DefaultAgentConfig) -> UserEntry when UserId :: snmpm:user_id(), UserMod :: snmpm:snmpm_user(), UserData :: term(), DefaultAgentConfig :: [snmpm:agent_config()], UserEntry :: user_entry().
为管理器用户配置文件 users.conf 创建一个条目。
有关详细信息，请参阅 (SNMP) 管理器配置用户指南的 用户 章节。
-spec usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> UsmEntry when EngineID :: snmp:engine_id(), UserName :: snmp:usm_name(), AuthP :: snmp:usm_auth_protocol(), AuthKey :: snmp:usm_auth_key(), PrivP :: snmp:usm_priv_protocol(), PrivKey :: snmp:usm_priv_key(), UsmEntry :: usm_entry().
等效于 usm_entry/7。
-spec usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> UsmEntry when EngineID :: snmp:engine_id(), UserName :: snmp:usm_name(), SecName :: snmp:sec_name(), AuthP :: snmp:usm_auth_protocol(), AuthKey :: snmp:usm_auth_key(), PrivP :: snmp:usm_priv_protocol(), PrivKey :: snmp:usm_priv_key(), UsmEntry :: usm_entry().
为代理社区配置文件 community.conf 创建一个条目。
有关详细信息，请参阅USM 的安全数据。
-spec write_agents_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [agent_entry()].
-spec write_agents_config(Dir, Hdr, Conf) -> ok when Dir :: snmp:dir(), Hdr :: string(), Conf :: [agent_entry()].
将管理器代理配置写入管理器代理配置文件。
Dir 是存储配置文件的目录路径。
Hdr 是可选的文件头（请注意，此文本将按原样写入文件）。
有关详细信息，请参阅 代理。
-spec write_manager_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [manager_entry()].
-spec write_manager_config(Dir, Hdr, Conf) -> ok when Dir :: snmp:dir(), Hdr :: string(), Conf :: [manager_entry()].
将管理器配置写入管理器配置文件。
Dir 是存储配置文件的目录路径。
Hdr 是可选的文件头（请注意，此文本将按原样写入文件）。
有关详细信息，请参阅管理器信息。
-spec write_users_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].
等效于 write_users_config/3。
-spec write_users_config(Dir, Hdr, Conf) -> ok when Dir :: snmp:dir(), Hdr :: string(), Conf :: [user_entry()].
将管理器用户配置写入管理器用户配置文件。
Dir 是存储配置文件的目录路径。
Hdr 是可选的文件头（请注意，此文本将按原样写入文件）。
有关详细信息，请参阅 用户。
-spec write_usm_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].
等效于 write_usm_config/3。
-spec write_usm_config(Dir, Hdr, Conf) -> ok when Dir :: snmp:dir(), Hdr :: string(), Conf :: [user_entry()].
将管理器 USM 配置写入管理器 USM 配置文件。
Dir 是存储配置文件的目录路径。
Hdr 是可选的文件头（请注意，此文本将按原样写入文件）。
有关详细信息，请参阅 USM 的安全数据。