檢視原始碼 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 建立一個條目。

請參閱 代理 以獲取更多資訊。

連結到此函式

append_agents_config(Dir, Conf)

檢視原始碼
-spec append_agents_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [agent_entry()].

將代理配置附加到目前的管理器代理配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 代理 以獲取更多資訊。

連結到此函式

append_manager_config(Dir, Conf)

檢視原始碼
-spec append_manager_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [manager_entry()].

將配置附加到目前的管理器配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 管理器資訊 以獲取更多資訊。

連結到此函式

append_users_config(Dir, Conf)

檢視原始碼
-spec append_users_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].

將使用者配置附加到目前的管理器使用者配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 使用者 以獲取更多資訊。

連結到此函式

append_usm_config(Dir, Conf)

檢視原始碼
-spec append_usm_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [usm_entry()].

將 USM 配置附加到目前的管理器 USM 配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 USM 的安全性資料 以獲取更多資訊。

連結到此函式

manager_entry(Tag, Val)

檢視原始碼
-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 的值,請參閱 管理器資訊 以獲取更多資訊。

連結到此函式

read_agents_config(Dir)

檢視原始碼
-spec read_agents_config(Dir) -> {ok, Conf} | {error, Reason}
                            when Dir :: snmp:dir(), Conf :: [agent_entry()], Reason :: term().

讀取目前的管理器代理配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 代理 以獲取更多資訊。

連結到此函式

read_manager_config(Dir)

檢視原始碼
-spec read_manager_config(Dir) -> {ok, Conf} | {error, Reason}
                             when Dir :: snmp:dir(), Conf :: [manager_entry()], Reason :: term().

讀取目前的管理器配置檔。

Dir 是要儲存配置檔的目錄路徑。

請參閱 管理器資訊 以獲取更多資訊。

連結到此函式

read_users_config(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().

等同於 users_entry(UserId, snmpm_user_default)

連結到此函式

users_entry(UserId, UserMod)

檢視原始碼
-spec users_entry(UserId, UserMod) -> UserEntry
                     when
                         UserId :: snmpm:user_id(),
                         UserMod :: snmpm:snmpm_user(),
                         UserEntry :: user_entry().

等同於 users_entry(UserId, UserMod, undefined)

連結到此函式

users_entry(UserId, UserMod, UserData)

檢視原始碼
-spec users_entry(UserId, UserMod, UserData) -> UserEntry
                     when
                         UserId :: snmpm:user_id(),
                         UserMod :: snmpm:snmpm_user(),
                         UserData :: term(),
                         UserEntry :: user_entry().

等同於 users_entry(UserId, UserMod, UserData, [])

連結到此函式

users_entry(UserId, UserMod, UserData, DefaultAgentConfig)

檢視原始碼 (自 OTP 27.0 起)
-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) 管理器設定 使用者指南的 使用者 章節以獲取更多資訊。

連結到此函式

usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey)

檢視原始碼
-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

連結到此函式

usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey)

檢視原始碼
-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 的安全性資料 以獲取更多資訊。

連結到此函式

write_agents_config(Dir, Conf)

檢視原始碼
-spec write_agents_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [agent_entry()].

等同於 write_agents_config/3

連結到此函式

write_agents_config(Dir, Hdr, Conf)

檢視原始碼
-spec write_agents_config(Dir, Hdr, Conf) -> ok
                             when Dir :: snmp:dir(), Hdr :: string(), Conf :: [agent_entry()].

將管理器代理配置寫入管理器代理配置檔。

Dir 是要儲存配置檔的目錄路徑。

Hdr 是一個可選的檔案標頭 (請注意,此文字將按原樣寫入檔案)。

請參閱 代理 以獲取更多資訊。

連結到此函式

write_manager_config(Dir, Conf)

檢視原始碼
-spec write_manager_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [manager_entry()].

等同於 write_manager_config/3

連結到此函式

write_manager_config(Dir, Hdr, Conf)

檢視原始碼
-spec write_manager_config(Dir, Hdr, Conf) -> ok
                              when Dir :: snmp:dir(), Hdr :: string(), Conf :: [manager_entry()].

將管理器配置寫入管理器配置檔。

Dir 是要儲存配置檔的目錄路徑。

Hdr 是一個可選的檔案標頭 (請注意,此文字將按原樣寫入檔案)。

請參閱 管理器資訊 以獲取更多資訊。

連結到此函式

write_users_config(Dir, Conf)

檢視原始碼
-spec write_users_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].

等同於 write_users_config/3

連結到此函式

write_users_config(Dir, Hdr, Conf)

檢視原始碼
-spec write_users_config(Dir, Hdr, Conf) -> ok
                            when Dir :: snmp:dir(), Hdr :: string(), Conf :: [user_entry()].

將管理器使用者配置寫入管理器使用者配置檔。

Dir 是要儲存配置檔的目錄路徑。

Hdr 是一個可選的檔案標頭 (請注意,此文字將按原樣寫入檔案)。

請參閱 使用者 以獲取更多資訊。

連結到此函式

write_usm_config(Dir, Conf)

檢視原始碼
-spec write_usm_config(Dir, Conf) -> ok when Dir :: snmp:dir(), Conf :: [user_entry()].

等同於 write_usm_config/3

連結到此函式

write_usm_config(Dir, Hdr, Conf)

檢視原始碼
-spec write_usm_config(Dir, Hdr, Conf) -> ok
                          when Dir :: snmp:dir(), Hdr :: string(), Conf :: [user_entry()].

將管理器 USM 配置寫入管理器 USM 配置檔。

Dir 是要儲存配置檔的目錄路徑。

Hdr 是一個可選的檔案標頭 (請注意,此文字將按原樣寫入檔案)。

請參閱 USM 的安全性資料 以獲取更多資訊。