snmpa_conf

snmpa_conf

模块

snmpa_conf

模块摘要

处理代理配置文件的实用程序函数。

描述

该模块snmpa_conf包含各种实用功能，用于操作（写/附加/读取）SNMP代理的配置文件。

数据类型

transportDomain() = transportDomainUdpIpv4 | transportDomainUdpIpv6

transportAddress() =
    transportAddressIPv4() | transportAddressIPv6()

transportAddressWithPort() =
    transportAddressIPv4WithPort() | transportAddressIPv6WithPort()

transportAddressWithoutPort() =
    transportAddressIPv4WithoutPort() | transportAddressIPv6WithoutPort()

transportAddressIPv4() =
    transportAddressIPv4WithPort() | transportAddressIPv4WithoutPort()
transportAddressIPv4WithPort =
    {transportAddressIPv4WithoutPort(), inet:port_number()} |
    [byte() x 4, byte() x 2]
transportAddressIPv4WithoutPort =
    inet:ip4_address() | [byte() x 4]

transportAddressIPv6() =
    transportAddressIPv6WithPort() | transportAddressIPv6WithoutPort()
transportAddressIPv6WithPort =
    {transportAddressIPv6WithoutPort(), inet:port_number()} |
    [word() x 8, inet:port_number()] |
    [word() x 8, byte() x 2] |
    {byte() x 16, byte() x 2]
transportAddressIPv6WithoutPort =
    inet:ip6_address() | [word() x 8] | [byte() x 16]

transportAddressMask() =
    [] | transportAddressWithPort()

byte() = 0..255
word() = 0..65535
    

对于inet:ip4_address()，inet:ip6_address()并且inet:port_number()，另见inet:ip_address()

输出

agent_entry(Tag, Val) -> agent_entry()

类型

为代理配置文件创建一个条目，agent.conf。

类型Val取决于价值Tag，请参阅Agent Information更多信息。

write_agent_config(Dir, Conf) -> okwrite_agent_config(Dir, Hdr, Conf) -> ok

类型

将代理配置写入代理配置文件。

Dir 是存放配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Agent Information以了解更多信息。

append_agent_config(Dir, Conf) -> ok

类型

将配置附加到当前代理配置文件。

Dir存储配置文件的目录的路径。

见Agent Information以了解更多信息。

read_agent_config(Dir) -> Conf

类型

读取当前代理配置文件。

Dir存储配置文件的目录的路径。

见Agent Information以了解更多信息。

standard_entry(Tag, Val) -> standard_entry()

类型

为代理标准配置文件创建一个条目，standard.conf。

类型Val取决于价值Tag，请参阅System Information更多信息。

write_standard_config(Dir, Conf) -> okwrite_standard_config(Dir, Hdr, Conf) -> ok

类型

将代理标准配置写入代理标准配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见System Information以了解更多信息。

append_standard_config(Dir, Conf) -> ok

类型

将标准配置附加到当前代理标准配置文件。

Dir存储配置文件的目录的路径。

见System Information以了解更多信息。

read_standard_config(Dir) -> Conf

类型

读取当前代理标准配置文件。

Dir存储配置文件的目录的路径。

见System Information以了解更多信息。

context_entry(Context) -> context_entry()

类型

为代理上下文配置文件创建一个条目context.conf。

见Contexts以了解更多信息。

write_context_config(Dir, Conf) -> okwrite_context_config(Dir, Hdr, Conf) -> ok

类型

将代理上下文配置写入代理上下文配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Contexts以了解更多信息。

append_context_config(Dir, Conf) -> ok

类型

将上下文配置附加到当前代理上下文配置文件。

Dir存储配置文件的目录的路径。

见Contexts以了解更多信息。

read_context_config(Dir) -> Conf

类型

读取当前代理上下文配置文件。

Dir存储配置文件的目录的路径。

见Contexts以了解更多信息。

community_entry(CommunityIndex) -> community_entry()community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry()

类型

为代理社区配置文件创建一个条目，community.conf。

CommunityIndex必须是非空字符串。

community_entry("public")转换为以下调用：community_entry(CommunityIndex, CommunityIndex, "initial", "", "")。

community_entry("all-rights")翻译成以下调用：community_entry(CommunityIndex, CommunityIndex, CommunityIndex, "", "")...

见Community以了解更多信息。

write_community_config(Dir, Conf) -> okwrite_community_config(Dir, Hdr, Conf) -> ok

类型

将代理社区配置写入代理社区配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Community以了解更多信息。

append_community_config(Dir, Conf) -> ok

类型

将社区配置附加到当前代理社区配置文件中。

Dir存储配置文件的目录的路径。

见Community以了解更多信息。

read_community_config(Dir) -> Conf

类型

读取当前代理社区配置文件。

Dir存储配置文件的目录的路径。

见Communities以了解更多信息。

target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry()target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask) -> target_addr_entry()target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry()target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry()

类型

为代理target_addr配置文件创建一个条目target_addr.conf。

Name必须是非空字符串。

target_addr_entry/6翻译成以下调用：target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, [])...

target_addr_entry/7翻译成以下调用：target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, 2048)...

target_addr_entry/8翻译成以下调用：target_addr_entry(Name, Domain, Addr, 1500, 3, TagList, ParamsName, EngineId, TMask, MaxMessageSize)...

见Target Address Definitions以了解更多信息。

write_target_addr_config(Dir, Conf) -> okwrite_target_addr_config(Dir, Hdr, Conf) -> ok

类型

将代理target_addr配置写入代理target_addr配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Target Address Definitions以了解更多信息。

append_target_addr_config(Dir, Conf) -> ok

类型

将target_addr配置追加到当前代理target_addr配置文件。

Dir存储配置文件的目录的路径。

见Target Address Definitions以了解更多信息。

read_target_addr_config(Dir) -> Conf

类型

阅读当前代理target_addr配置文件。

Dir存储配置文件的目录的路径。

见Target Address Definitions以了解更多信息。

target_params_entry(Name, Vsn) -> target_params_entry()target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry()target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry()

类型

为代理target_params配置文件创建一个条目，target_params.conf。

Name必须是非空字符串。

Vsn翻译成MPModel和SecModel 如下所示：

\011  Vsn = v1 => MPModel = v1,  SecModel = v1
\011  Vsn = v2 => MPModel = v2c, SecModel = v2c
\011  Vsn = v3 => MPModel = v3,  SecModel = usm
        

target_params_entry/2转换为以下调用：target_params_entry(Name, Vsn, "initial", noAuthNoPriv)。

target_params_entry/4转换为以下调用：target_params_entry(Name, MPModel, SecModel, SecName, SecLevel)其中MPModel和SecModel映射来自Vsn，见上文。

见Target Parameters Definitions以了解更多信息。

write_target_params_config(Dir, Conf) -> okwrite_target_params_config(Dir, Hdr, Conf) -> ok

类型

将代理target_params配置写入代理target_params配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Target Parameters Definitions以了解更多信息。

append_target_params_config(Dir, Conf) -> ok

类型

将target_params配置追加到当前代理target_params配置文件。

Dir存储配置文件的目录的路径。

见Target Parameters Definitions以了解更多信息。

read_target_params_config(Dir) -> Conf

类型

阅读当前代理target_params配置文件。

Dir存储配置文件的目录的路径。

见Target Parameters Definitions以了解更多信息。

vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry()vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry()vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry()vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry()

类型

为代理vacm配置文件创建一个条目vacm.conf。

vacm_vtf_entry/2翻译成以下调用：vacm_vtf_entry(ViewIndex, ViewSubtree, included, null)...

见MIB Views for VACM以了解更多信息。

write_vacm_config(Dir, Conf) -> okwrite_vacm_config(Dir, Hdr, Conf) -> ok

类型

将代理VACM配置写入代理VACM配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见MIB Views for VACM以了解更多信息。

append_vacm_config(Dir, Conf) -> ok

类型

将VACM配置附加到当前代理VACM配置文件。

Dir存储配置文件的目录的路径。

见MIB Views for VACM以了解更多信息。

read_vacm_config(Dir) -> Conf

类型

读取当前代理VACM配置文件。

Dir存储配置文件的目录的路径。

见MIB Views for VACM以了解更多信息。

usm_entry(EngineId) -> usm_entry()usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry()

类型

为代理VACM配置文件创建一个条目，vacm.conf...

usm_entry/1翻译成以下调用：usm_entry("initial", "initial", zeroDotZero, usmNoAuthProtocol, "", "", usmNoPrivProtocol, "", "", "", "", "")...

见Security data for USM以了解更多信息。

write_usm_config(Dir, Conf) -> okwrite_usm_config(Dir, Hdr, Conf) -> ok

类型

将代理USM配置写入代理USM配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Security data for USM以了解更多信息。

append_usm_config(Dir, Conf) -> ok

类型

将USM配置附加到当前代理VACM配置文件。

Dir存储配置文件的目录的路径。

见Security data for USM以了解更多信息。

read_usm_config(Dir) -> Conf

类型

读取当前代理USM配置文件。

Dir存储配置文件的目录的路径。

见Security data for USM以了解更多信息。

notify_entry(Name, Tag, Type) -> notify_entry()

类型

为代理通知配置文件创建一个条目notify.conf。

Name必须是非空字符串。

见Notify Definitions以了解更多信息。

write_notify_config(Dir, Conf) -> okwrite_notify_config(Dir, Hdr, Conf) -> ok

类型

将代理通知配置写入代理通知配置文件。

Dir存储配置文件的目录的路径。

Hdr 是一个可选的文件头（请注意，此文本按原样写入文件）。

见Notify Definitions以了解更多信息。

append_notify_config(Dir, Conf) -> ok

类型

将Notificconfig追加到当前代理通知配置文件。

Dir存储配置文件的目录的路径。

见Notify Definitions以了解更多信息。

read_notify_config(Dir) -> Conf

类型

读取当前代理通知配置文件。

Dir存储配置文件的目录的路径。

见Notify Definitions以了解更多信息。