From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/snmp/doc/src/snmp.xml | 72 +++---- lib/snmp/doc/src/snmp_community_mib.xml | 10 +- lib/snmp/doc/src/snmp_framework_mib.xml | 10 +- lib/snmp/doc/src/snmp_generic.xml | 28 +-- lib/snmp/doc/src/snmp_index.xml | 18 +- lib/snmp/doc/src/snmp_notification_mib.xml | 10 +- lib/snmp/doc/src/snmp_pdus.xml | 26 +-- lib/snmp/doc/src/snmp_standard_mib.xml | 14 +- lib/snmp/doc/src/snmp_target_mib.xml | 16 +- lib/snmp/doc/src/snmp_user_based_sm_mib.xml | 10 +- lib/snmp/doc/src/snmp_view_based_acm_mib.xml | 18 +- lib/snmp/doc/src/snmpa.xml | 206 ++++++++++----------- lib/snmp/doc/src/snmpa_conf.xml | 110 +++++------ lib/snmp/doc/src/snmpa_discovery_handler.xml | 4 +- lib/snmp/doc/src/snmpa_error.xml | 6 +- lib/snmp/doc/src/snmpa_error_io.xml | 6 +- lib/snmp/doc/src/snmpa_error_logger.xml | 6 +- lib/snmp/doc/src/snmpa_error_report.xml | 6 +- lib/snmp/doc/src/snmpa_local_db.xml | 24 +-- lib/snmp/doc/src/snmpa_mpd.xml | 6 +- lib/snmp/doc/src/snmpa_network_interface.xml | 12 +- .../doc/src/snmpa_network_interface_filter.xml | 10 +- .../snmpa_notification_delivery_info_receiver.xml | 6 +- lib/snmp/doc/src/snmpa_notification_filter.xml | 4 +- lib/snmp/doc/src/snmpa_supervisor.xml | 10 +- lib/snmp/doc/src/snmpc.xml | 10 +- lib/snmp/doc/src/snmpm.xml | 168 ++++++++--------- lib/snmp/doc/src/snmpm_conf.xml | 48 ++--- lib/snmp/doc/src/snmpm_mpd.xml | 8 +- lib/snmp/doc/src/snmpm_network_interface.xml | 20 +- .../doc/src/snmpm_network_interface_filter.xml | 10 +- lib/snmp/doc/src/snmpm_user.xml | 14 +- 32 files changed, 463 insertions(+), 463 deletions(-) (limited to 'lib/snmp/doc/src') diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index bd671bb40e..d20f1a8d06 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -32,7 +32,7 @@ snmp.xml - snmp + snmp Interface functions to the SNMP toolkit

The module snmp contains interface functions to the @@ -56,7 +56,7 @@ - config() -> ok | {error, Reason} + config() -> ok | {error, Reason} Configure with a simple interactive tool

A simple interactive configuration tool. Simple @@ -78,8 +78,8 @@ - start() -> ok | {error, Reason} - start(Type) -> ok | {error, Reason} + start() -> ok | {error, Reason} + start(Type) -> ok | {error, Reason} Start the SNMP application Type = start_type() @@ -93,8 +93,8 @@ - start_agent() -> ok | {error, Reason} - start_agent(Type) -> ok | {error, Reason} + start_agent() -> ok | {error, Reason} + start_agent(Type) -> ok | {error, Reason} Start the agent part of the SNMP application Type = start_type() @@ -117,8 +117,8 @@ - start_manager() -> ok | {error, Reason} - start_manager(Type) -> ok | {error, Reason} + start_manager() -> ok | {error, Reason} + start_manager(Type) -> ok | {error, Reason} Start the manager part of the SNMP application Type = start_type() @@ -141,7 +141,7 @@ - date_and_time() -> DateAndTime + date_and_time() -> DateAndTime Return the current date and time as an OCTET STRING DateAndTime = [int()] @@ -155,7 +155,7 @@ - date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] + date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] Convert a DateAndTime value to a list of possible utc() DateAndTime = [int()] @@ -171,8 +171,8 @@ - date_and_time_to_string(DateAndTime) -> string() - date_and_time_to_string(DateAndTime, Validate) -> string() + date_and_time_to_string(DateAndTime) -> string() + date_and_time_to_string(DateAndTime, Validate) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -194,7 +194,7 @@ - date_and_time_to_string2(DateAndTime) -> string() + date_and_time_to_string2(DateAndTime) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -210,7 +210,7 @@ - local_time_to_date_and_time_dst(Local) -> [DateAndTime] + local_time_to_date_and_time_dst(Local) -> [DateAndTime] Convert a Local time value to a list of possible DateAndTime(s) Local = {{Y,Mo,D},{H,M,S}} @@ -226,7 +226,7 @@ - universal_time_to_date_and_time(UTC) -> DateAndTime + universal_time_to_date_and_time(UTC) -> DateAndTime Convert a UTC value to DateAndTime UTC = {{Y,Mo,D},{H,M,S}} @@ -241,8 +241,8 @@ - validate_date_and_time(DateAndTime) -> bool() - validate_date_and_time(DateAndTime, Validate) -> bool() + validate_date_and_time(DateAndTime) -> bool() + validate_date_and_time(DateAndTime, Validate) -> bool() Check if a DateAndTime value is correct DateAndTime = term() @@ -279,7 +279,7 @@ - passwd2localized_key(Alg, Passwd, EngineID) -> Key + passwd2localized_key(Alg, Passwd, EngineID) -> Key Generates an localized key Alg = algorithm() @@ -298,7 +298,7 @@ - octet_string_to_bits(S) -> Val + octet_string_to_bits(S) -> Val Convert an OCTET-STRING to BITS Val = bits() @@ -312,7 +312,7 @@ - bits_to_octet_string(B) -> Val + bits_to_octet_string(B) -> Val Convert an OCTET-STRING to BITS Val = octet_string() @@ -326,7 +326,7 @@ - read_mib(FileName) -> {ok, mib()} | {error, Reason} + read_mib(FileName) -> {ok, mib()} | {error, Reason} FileName = string() @@ -341,9 +341,9 @@ - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -440,7 +440,7 @@ - change_log_size(LogName, NewSize) -> ok | {error, Reason} + change_log_size(LogName, NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log LogName = string() @@ -463,8 +463,8 @@ - print_version_info() -> void() - print_version_info(Prefix) -> void() + print_version_info() -> void() + print_version_info(Prefix) -> void() Formatted print of result of the versions functions Prefix = string() | integer() @@ -484,8 +484,8 @@ - versions1() -> {ok, Info} | {error, Reason} - versions2() -> {ok, Info} | {error, Reason} + versions1() -> {ok, Info} | {error, Reason} + versions2() -> {ok, Info} | {error, Reason} Retrieve various system and application info Info = [info()] @@ -504,8 +504,8 @@ - print_versions(VersionInfo) -> void() - print_versions(Prefix, VersionInfo) -> void() + print_versions(VersionInfo) -> void() + print_versions(Prefix, VersionInfo) -> void() Formatted print of result of the versions functions VersionInfo = [version_info()] @@ -527,7 +527,7 @@ - enable_trace() -> void() + enable_trace() -> void() Starts a tracer - backup(BackupDir) -> ok | {error, Reason} - backup(Agent, BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} + backup(Agent, BackupDir) -> ok | {error, Reason} Backup agent data BackupDir = string() @@ -216,8 +216,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - info() -> [{Key, Value}] - info(Agent) -> [{Key, Value}] + info() -> [{Key, Value}] + info(Agent) -> [{Key, Value}] Return information about the agent Agent = pid() | atom() @@ -236,7 +236,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - old_info_format(NewInfo) -> OldInfo + old_info_format(NewInfo) -> OldInfo Return information about the agent OldInfo = NewInfo = [{Key, Value}] @@ -273,9 +273,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - load_mibs(Mibs) -> ok | {error, Reason} - load_mibs(Mibs, Force) -> ok | {error, Reason} - load_mibs(Agent, Mibs) -> ok | {error, Reason} + load_mibs(Mibs) -> ok | {error, Reason} + load_mibs(Mibs, Force) -> ok | {error, Reason} + load_mibs(Agent, Mibs) -> ok | {error, Reason} load_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Load MIBs into the agent @@ -321,9 +321,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unload_mibs(Mibs) -> ok | {error, Reason} - unload_mibs(Mibs, Force) -> ok | {error, Reason} - unload_mibs(Agent, Mibs) -> ok | {error, Reason} + unload_mibs(Mibs) -> ok | {error, Reason} + unload_mibs(Mibs, Force) -> ok | {error, Reason} + unload_mibs(Agent, Mibs) -> ok | {error, Reason} unload_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Unload MIBs from the agent @@ -347,8 +347,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_mibs() -> Mibs - which_mibs(Agent) -> Mibs + which_mibs() -> Mibs + which_mibs(Agent) -> Mibs Get a list of all the loaded mibs Agent = pid() | atom() @@ -365,8 +365,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} - whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} Get the path to the mib file Agent = pid() | atom() @@ -385,10 +385,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - current_request_id() -> {value, RequestId} | false - current_context() -> {value, Context} | false - current_community() -> {value, Community} | false - current_address() -> {value, Address} | false + current_request_id() -> {value, RequestId} | false + current_context() -> {value, Context} | false + current_community() -> {value, Community} | false + current_address() -> {value, Address} | false Get the request-id, context, community and address of the current request RequestId = integer() @@ -409,8 +409,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enum_to_int(Name, Enum) -> {value, Int} | false - enum_to_int(Db, Name, Enum) -> {value, Int} | false + enum_to_int(Name, Enum) -> {value, Int} | false + enum_to_int(Db, Name, Enum) -> {value, Int} | false Convert an enum value to an integer Db = term() @@ -435,8 +435,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - int_to_enum(Name, Int) -> {value, Enum} | false - int_to_enum(Db, Name, Int) -> {value, Enum} | false + int_to_enum(Name, Int) -> {value, Enum} | false + int_to_enum(Db, Name, Int) -> {value, Enum} | false Convert an integer to an enum value Db = term() @@ -461,8 +461,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - name_to_oid(Name) -> {value, oid()} | false - name_to_oid(Db, Name) -> {value, oid()} | false + name_to_oid(Name) -> {value, oid()} | false + name_to_oid(Db, Name) -> {value, oid()} | false Convert a symbolic name to an OID Db = term() @@ -482,8 +482,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - oid_to_name(OID) -> {value, Name} | false - oid_to_name(Db, OID) -> {value, Name} | false + oid_to_name(OID) -> {value, Name} | false + oid_to_name(Db, OID) -> {value, Name} | false Convert an OID to a symbolic name Db = term() @@ -503,7 +503,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_aliasnames() -> Result + which_aliasnames() -> Result Get all alias-names known to the agent Result = [atom()] @@ -515,7 +515,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_tables() -> Result + which_tables() -> Result Get all tables known to the agent Result = [atom()] @@ -528,7 +528,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_variables() -> Result + which_variables() -> Result Get all variables known to the agent Result = [atom()] @@ -541,7 +541,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notifications() -> Result + which_notifications() -> Result Get all notifications known to the agent Result = [{Name, MibName, Info}] @@ -558,13 +558,13 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -641,7 +641,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -662,8 +662,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_log_type(NewType) -> {ok, OldType} | {error, Reason} - set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} Change the type of the Audit Trail Log NewType = OldType = atl_type() @@ -684,8 +684,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - mib_of(Oid) -> {ok, MibName} | {error, Reason} - mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} + mib_of(Oid) -> {ok, MibName} | {error, Reason} + mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} Which mib an Oid belongs to Agent = pid() | atom() @@ -704,8 +704,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - me_of(Oid) -> {ok, Me} | {error, Reason} - me_of(Agent, Oid) -> {ok, Me} | {error, Reason} + me_of(Oid) -> {ok, Me} | {error, Reason} + me_of(Agent, Oid) -> {ok, Me} | {error, Reason} Retrieve the mib-entry of an Oid Agent = pid() | atom() @@ -724,8 +724,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - invalidate_mibs_cache() -> void() - invalidate_mibs_cache(Agent) -> void() + invalidate_mibs_cache() -> void() + invalidate_mibs_cache(Agent) -> void() Invalidate the mib server cache Agent = pid() | atom() @@ -739,8 +739,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache() -> void() - enable_mibs_cache(Agent) -> void() + enable_mibs_cache() -> void() + enable_mibs_cache(Agent) -> void() Enable the mib server cache Agent = pid() | atom() @@ -753,8 +753,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache() -> void() - disable_mibs_cache(Agent) -> void() + disable_mibs_cache() -> void() + disable_mibs_cache(Agent) -> void() Disable the mib server cache Agent = pid() | atom() @@ -781,12 +781,12 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} Perform mib server cache gc Agent = pid() | atom() @@ -808,8 +808,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache_autogc() -> void() - enable_mibs_cache_autogc(Agent) -> void() + enable_mibs_cache_autogc() -> void() + enable_mibs_cache_autogc(Agent) -> void() Enable automatic gc of the mib server cache Agent = pid() | atom() @@ -822,8 +822,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache_autogc() -> void() - disable_mibs_cache_autogc(Agent) -> void() + disable_mibs_cache_autogc() -> void() + disable_mibs_cache_autogc(Agent) -> void() Disable automatic gc of the mib server cache Agent = pid() | atom() @@ -836,8 +836,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_age(NewAge) -> ok | {error, Reason} - update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} + update_mibs_cache_age(NewAge) -> ok | {error, Reason} + update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} Change the mib server cache age property Agent = pid() | atom() @@ -852,8 +852,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} - update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} Change the mib server cache gclimit property Agent = pid() | atom() @@ -869,10 +869,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} Register a notification filter Agent = pid() | atom() @@ -897,8 +897,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unregister_notification_filter(Id) -> ok | {error, Reason} - unregister_notification_filter(Agent, Id) -> ok | {error, Reason} + unregister_notification_filter(Id) -> ok | {error, Reason} + unregister_notification_filter(Agent, Id) -> ok | {error, Reason} Unregister a notification filter Agent = pid() | atom() @@ -913,8 +913,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notification_filter() -> Filters - which_notification_filter(Agent) -> Filters + which_notification_filter() -> Filters + which_notification_filter(Agent) -> Filters Which notification filter Agent = pid() | atom() @@ -929,8 +929,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} - set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} Change the request limit NewLimit = OldLimit = infinity | integer() >= 0 @@ -950,7 +950,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} + register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} Register a sub-agent under a sub-tree Agent = pid() | atom() @@ -975,7 +975,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} + unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} Unregister a sub-agent Agent = pid() | atom() @@ -1119,10 +1119,10 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - send_notification(Agent, Notification, Receiver) - send_notification(Agent, Notification, Receiver, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() + send_notification(Agent, Notification, Receiver) + send_notification(Agent, Notification, Receiver, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() Send a notification @@ -1324,13 +1324,13 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} Initiate the discovery process with a manager TargetName = string() @@ -1379,7 +1379,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - convert_config(OldConfig) -> AgentConfig + convert_config(OldConfig) -> AgentConfig Convert old snmp config to new agent config OldConfig = list() @@ -1403,8 +1403,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_worker() -> void() - restart_worker(Agent) -> void() + restart_worker() -> void() + restart_worker(Agent) -> void() Restart the worker process of a multi-threaded agent Agent = pid() | atom() @@ -1419,8 +1419,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_set_worker() -> void() - restart_set_worker(Agent) -> void() + restart_set_worker() -> void() + restart_set_worker(Agent) -> void() Restart the set worker process of a multi-threaded agent Agent = pid() | atom() @@ -1468,7 +1468,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - verbosity(Ref,Verbosity) -> void() + verbosity(Ref,Verbosity) -> void() Assign a new verbosity for the process Ref = pid() | sub_agents | master_agent | net_if | mib_server | symbolic_store | note_store | local_db diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml index 01c52c3c8a..4134a81c0c 100644 --- a/lib/snmp/doc/src/snmpa_conf.xml +++ b/lib/snmp/doc/src/snmpa_conf.xml @@ -32,7 +32,7 @@ snmpa_conf.xml - snmpa_conf + snmpa_conf Utility functions for handling the agent config files.

The module snmpa_conf contains various utility functions to @@ -92,7 +92,7 @@ word() = 0..65535 - agent_entry(Tag, Val) -> agent_entry() + agent_entry(Tag, Val) -> agent_entry() Create an agent entry Tag = intAgentTransports | intAgentUDPPort | intAgentMaxPacketSize | snmpEngineMaxMessageSize | snmpEngineID @@ -111,8 +111,8 @@ word() = 0..65535 - write_agent_config(Dir, Conf) -> ok - write_agent_config(Dir, Hdr, Conf) -> ok + write_agent_config(Dir, Conf) -> ok + write_agent_config(Dir, Hdr, Conf) -> ok Write the agent config to the config file Dir = string() @@ -134,7 +134,7 @@ word() = 0..65535 - append_agent_config(Dir, Conf) -> ok + append_agent_config(Dir, Conf) -> ok Append the agent config to the config file Dir = string() @@ -153,7 +153,7 @@ word() = 0..65535 - read_agent_config(Dir) -> Conf + read_agent_config(Dir) -> Conf Read the agent config from the config file Dir = string() @@ -172,7 +172,7 @@ word() = 0..65535 - standard_entry(Tag, Val) -> standard_entry() + standard_entry(Tag, Val) -> standard_entry() Create an standard entry Tag = sysDescr | sysObjectID | sysContact | sysName | sysLocation | sysServices | snmpEnableAuthenTraps @@ -192,8 +192,8 @@ word() = 0..65535 - write_standard_config(Dir, Conf) -> ok - write_standard_config(Dir, Hdr, Conf) -> ok + write_standard_config(Dir, Conf) -> ok + write_standard_config(Dir, Hdr, Conf) -> ok Write the agent standard config to the config file Dir = string() @@ -216,7 +216,7 @@ word() = 0..65535 - append_standard_config(Dir, Conf) -> ok + append_standard_config(Dir, Conf) -> ok Append the agent standard config to the config file Dir = string() @@ -236,7 +236,7 @@ word() = 0..65535 - read_standard_config(Dir) -> Conf + read_standard_config(Dir) -> Conf Read the agent standard config from the config file Dir = string() @@ -255,7 +255,7 @@ word() = 0..65535 - context_entry(Context) -> context_entry() + context_entry(Context) -> context_entry() Create an context entry Context = string() @@ -273,8 +273,8 @@ word() = 0..65535 - write_context_config(Dir, Conf) -> ok - write_context_config(Dir, Hdr, Conf) -> ok + write_context_config(Dir, Conf) -> ok + write_context_config(Dir, Hdr, Conf) -> ok Write the agent context(s) to the config file Dir = string() @@ -297,7 +297,7 @@ word() = 0..65535 - append_context_config(Dir, Conf) -> ok + append_context_config(Dir, Conf) -> ok Append the agent context(s) to the config file Dir = string() @@ -317,7 +317,7 @@ word() = 0..65535 - read_context_config(Dir) -> Conf + read_context_config(Dir) -> Conf Read the agent context config from the config file Dir = string() @@ -336,8 +336,8 @@ word() = 0..65535 - community_entry(CommunityIndex) -> community_entry() - community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() + community_entry(CommunityIndex) -> community_entry() + community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() Create an community entry CommunityIndex = string() @@ -364,8 +364,8 @@ word() = 0..65535 - write_community_config(Dir, Conf) -> ok - write_community_config(Dir, Hdr, Conf) -> ok + write_community_config(Dir, Conf) -> ok + write_community_config(Dir, Hdr, Conf) -> ok Write the agent community config to the config file Dir = string() @@ -388,7 +388,7 @@ word() = 0..65535 - append_community_config(Dir, Conf) -> ok + append_community_config(Dir, Conf) -> ok Append the agent community config to the config file Dir = string() @@ -408,7 +408,7 @@ word() = 0..65535 - read_community_config(Dir) -> Conf + read_community_config(Dir) -> Conf Read the agent community config from the config file Dir = string() @@ -427,10 +427,10 @@ word() = 0..65535 - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() + 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_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() Create an target_addr entry Name = string() @@ -464,8 +464,8 @@ word() = 0..65535 - write_target_addr_config(Dir, Conf) -> ok - write_target_addr_config(Dir, Hdr, Conf) -> ok + write_target_addr_config(Dir, Conf) -> ok + write_target_addr_config(Dir, Hdr, Conf) -> ok Write the agent target_addr config to the config file Dir = string() @@ -488,7 +488,7 @@ word() = 0..65535 - append_target_addr_config(Dir, Conf) -> ok + append_target_addr_config(Dir, Conf) -> ok Append the agent target_addr config to the config file Dir = string() @@ -508,7 +508,7 @@ word() = 0..65535 - read_target_addr_config(Dir) -> Conf + read_target_addr_config(Dir) -> Conf Read the agent target_addr config from the config file Dir = string() @@ -527,9 +527,9 @@ word() = 0..65535 - 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_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() Create an target_params entry Name = string() @@ -564,8 +564,8 @@ word() = 0..65535 - write_target_params_config(Dir, Conf) -> ok - write_target_params_config(Dir, Hdr, Conf) -> ok + write_target_params_config(Dir, Conf) -> ok + write_target_params_config(Dir, Hdr, Conf) -> ok Write the agent target_params config to the config file Dir = string() @@ -588,7 +588,7 @@ word() = 0..65535 - append_target_params_config(Dir, Conf) -> ok + append_target_params_config(Dir, Conf) -> ok Append the agent target_params config to the config file Dir = string() @@ -608,7 +608,7 @@ word() = 0..65535 - read_target_params_config(Dir) -> Conf + read_target_params_config(Dir) -> Conf Read the agent target_params config from the config file Dir = string() @@ -627,10 +627,10 @@ word() = 0..65535 - 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_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() Create an vacm entry SecModel = v1 | v2c | usm @@ -665,8 +665,8 @@ word() = 0..65535 - write_vacm_config(Dir, Conf) -> ok - write_vacm_config(Dir, Hdr, Conf) -> ok + write_vacm_config(Dir, Conf) -> ok + write_vacm_config(Dir, Hdr, Conf) -> ok Write the agent vacm config to the config file Dir = string() @@ -690,7 +690,7 @@ word() = 0..65535 - append_vacm_config(Dir, Conf) -> ok + append_vacm_config(Dir, Conf) -> ok Append the agent vacm config to the config file Dir = string() @@ -710,7 +710,7 @@ word() = 0..65535 - read_vacm_config(Dir) -> Conf + read_vacm_config(Dir) -> Conf Read the agent vacm config from the config file Dir = string() @@ -729,8 +729,8 @@ word() = 0..65535 - usm_entry(EngineId) -> usm_entry() - usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() + usm_entry(EngineId) -> usm_entry() + usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() Create an usm entry EngineId = string() @@ -762,8 +762,8 @@ word() = 0..65535 - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the agent usm config to the config file Dir = string() @@ -786,7 +786,7 @@ word() = 0..65535 - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the agent usm config to the config file Dir = string() @@ -805,7 +805,7 @@ word() = 0..65535 - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the agent usm config from the config file Dir = string() @@ -824,7 +824,7 @@ word() = 0..65535 - notify_entry(Name, Tag, Type) -> notify_entry() + notify_entry(Name, Tag, Type) -> notify_entry() Create an notify entry Name = string() @@ -845,8 +845,8 @@ word() = 0..65535 - write_notify_config(Dir, Conf) -> ok - write_notify_config(Dir, Hdr, Conf) -> ok + write_notify_config(Dir, Conf) -> ok + write_notify_config(Dir, Hdr, Conf) -> ok Write the agent notify config to the config file Dir = string() @@ -869,7 +869,7 @@ word() = 0..65535 - append_notify_config(Dir, Conf) -> ok + append_notify_config(Dir, Conf) -> ok Append the agent notify config to the config file Dir = string() @@ -889,7 +889,7 @@ word() = 0..65535 - read_notify_config(Dir) -> Conf + read_notify_config(Dir) -> Conf Read the agent notify config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpa_discovery_handler.xml b/lib/snmp/doc/src/snmpa_discovery_handler.xml index 0ea72a880c..21b8746c11 100644 --- a/lib/snmp/doc/src/snmpa_discovery_handler.xml +++ b/lib/snmp/doc/src/snmpa_discovery_handler.xml @@ -32,7 +32,7 @@ snmpa_discovery_handler.xml - snmpa_discovery_handler + snmpa_discovery_handler Behaviour module for the SNMP agent discovery handler.

This module defines the behaviour of the agent discovery @@ -51,7 +51,7 @@ - stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} + stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} Discovery stage 1 finish TargetName = string() diff --git a/lib/snmp/doc/src/snmpa_error.xml b/lib/snmp/doc/src/snmpa_error.xml index 7cc4a3513d..6e6761b7a5 100644 --- a/lib/snmp/doc/src/snmpa_error.xml +++ b/lib/snmp/doc/src/snmpa_error.xml @@ -32,7 +32,7 @@ snmpa_error.xml - snmpa_error + snmpa_error Functions for Reporting SNMP Errors @@ -57,7 +57,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -76,7 +76,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_io.xml b/lib/snmp/doc/src/snmpa_error_io.xml index bcb2688646..d78e09ff13 100644 --- a/lib/snmp/doc/src/snmpa_error_io.xml +++ b/lib/snmp/doc/src/snmpa_error_io.xml @@ -32,7 +32,7 @@ snmpa_error_io.xml - snmpa_error_io + snmpa_error_io Functions for Reporting SNMP Errors on stdio

The module snmpa_error_io implements the @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_logger.xml b/lib/snmp/doc/src/snmpa_error_logger.xml index 4feb2e7f32..b0565a6839 100644 --- a/lib/snmp/doc/src/snmpa_error_logger.xml +++ b/lib/snmp/doc/src/snmpa_error_logger.xml @@ -32,7 +32,7 @@ snmpa_error_logger.xml - snmpa_error_logger + snmpa_error_logger Functions for Reporting SNMP Errors through the error_logger

The module snmpa_error_logger implements the @@ -54,7 +54,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -70,7 +70,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_report.xml b/lib/snmp/doc/src/snmpa_error_report.xml index 282d9b4e59..f08dc1df23 100644 --- a/lib/snmp/doc/src/snmpa_error_report.xml +++ b/lib/snmp/doc/src/snmpa_error_report.xml @@ -32,7 +32,7 @@ snmpa_error_report.xml - snmpa_error_report + snmpa_error_report Behaviour module for reporting SNMP agent errors @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_local_db.xml b/lib/snmp/doc/src/snmpa_local_db.xml index ac8d466ab3..229f22ab70 100644 --- a/lib/snmp/doc/src/snmpa_local_db.xml +++ b/lib/snmp/doc/src/snmpa_local_db.xml @@ -32,7 +32,7 @@ snmpa_local_db.xml - snmpa_local_db + snmpa_local_db The SNMP built-in database

The module snmpa_local_db contains functions for @@ -86,7 +86,7 @@ - dump() -> ok | {error, Reason} + dump() -> ok | {error, Reason} Dump the database to disk Reason = term() @@ -97,7 +97,7 @@ - match(NameDb, Pattern) + match(NameDb, Pattern) Perform a match on the table

Performs an ets/dets matching on the table. @@ -106,9 +106,9 @@ - print() - print(TableName) - print(TableName, Db) + print() + print(TableName) + print(TableName, Db) Print the database to screen TableName = atom() @@ -124,7 +124,7 @@ - table_create(NameDb) -> bool() + table_create(NameDb) -> bool() Create a table

Creates a table. If the table already exist, the old copy @@ -135,7 +135,7 @@ - table_create_row(NameDb, RowIndex, Row) -> bool() + table_create_row(NameDb, RowIndex, Row) -> bool() Create a row in a table Row = {Val1, Val2, ..., ValN} @@ -147,28 +147,28 @@ - table_delete(NameDb) -> void() + table_delete(NameDb) -> void() Delete a table

Deletes a table.

- table_delete_row(NameDb, RowIndex) -> bool() + table_delete_row(NameDb, RowIndex) -> bool() Delete the row in the table

Deletes the row in the table.

 - table_exists(NameDb) -> bool() + table_exists(NameDb) -> bool() Check if a table exists

Checks if a table exists.

 - table_get_row(NameDb, RowIndex) -> Row | undefined + table_get_row(NameDb, RowIndex) -> Row | undefined Get a row from the table Row = {Val1, Val2, ..., ValN} diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml index 4a0c5b61d5..d76a9c4a94 100644 --- a/lib/snmp/doc/src/snmpa_mpd.xml +++ b/lib/snmp/doc/src/snmpa_mpd.xml @@ -32,7 +32,7 @@ snmpa_mpd.xml - snmpa_mpd + snmpa_mpd Message Processing and Dispatch module for the SNMP agent

The module snmpa_mpd implements the version independent @@ -52,7 +52,7 @@ - init(Vsns) -> mpd_state() + init(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -211,7 +211,7 @@ - discarded_pdu(Variable) -> void() + discarded_pdu(Variable) -> void() Increment the variable associated with a discarded pdu Variable = atom() diff --git a/lib/snmp/doc/src/snmpa_network_interface.xml b/lib/snmp/doc/src/snmpa_network_interface.xml index d4d4989e90..3e79df11b1 100644 --- a/lib/snmp/doc/src/snmpa_network_interface.xml +++ b/lib/snmp/doc/src/snmpa_network_interface.xml @@ -32,7 +32,7 @@ snmpa_network_interface.xml - snmpa_network_interface + snmpa_network_interface Behaviour module for the SNMP agent network interface.

This module defines the behaviour of the agent network @@ -68,7 +68,7 @@ - start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} + start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} Start-link the network interface process Prio = priority() @@ -93,7 +93,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -112,7 +112,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of a running network interface process Pid = pid() @@ -126,7 +126,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -147,7 +147,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpa_network_interface_filter.xml b/lib/snmp/doc/src/snmpa_network_interface_filter.xml index 7cd08f8935..02c7d291dd 100644 --- a/lib/snmp/doc/src/snmpa_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpa_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpa_network_interface_filter.xml - snmpa_network_interface_filter + snmpa_network_interface_filter Behaviour module for the SNMP agent network-interface filter.

This module defines the behaviour of the agent network interface @@ -101,7 +101,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -131,7 +131,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -148,7 +148,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Targets, PduType) -> Reply + accept_send_pdu(Targets, PduType) -> Reply Shall the pdu be sent Targets = targets() diff --git a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml index cbae158544..5dad372710 100644 --- a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml +++ b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml @@ -34,7 +34,7 @@ snmpa_notification_delivery_info_receiver.xml - snmpa_notification_delivery_info_receiver + snmpa_notification_delivery_info_receiver Behaviour module for the SNMP agent notification delivery information receiver. @@ -76,7 +76,7 @@ - delivery_targets(Tag, Targets, Extra) -> void() + delivery_targets(Tag, Targets, Extra) -> void() Inform about target addresses Tag = term() @@ -97,7 +97,7 @@ - delivery_info(Tag, Target, DeliveryResult, Extra) -> void() + delivery_info(Tag, Target, DeliveryResult, Extra) -> void() Inform about delivery result Tag = term() diff --git a/lib/snmp/doc/src/snmpa_notification_filter.xml b/lib/snmp/doc/src/snmpa_notification_filter.xml index 0f16ba4440..902412ccc5 100644 --- a/lib/snmp/doc/src/snmpa_notification_filter.xml +++ b/lib/snmp/doc/src/snmpa_notification_filter.xml @@ -32,7 +32,7 @@ snmpa_notification_filter.xml - snmpa_notification_filter + snmpa_notification_filter Behaviour module for the SNMP agent notification filters.

This module defines the behaviour of the agent notification @@ -51,7 +51,7 @@ - handle_notification(Notif, Data) -> Reply + handle_notification(Notif, Data) -> Reply Handle a notification Reply = send | {send, NewNotif} | dont_send diff --git a/lib/snmp/doc/src/snmpa_supervisor.xml b/lib/snmp/doc/src/snmpa_supervisor.xml index 86c6fbc350..e11cde390f 100644 --- a/lib/snmp/doc/src/snmpa_supervisor.xml +++ b/lib/snmp/doc/src/snmpa_supervisor.xml @@ -32,7 +32,7 @@ snmpa_supervisor.xml - snmpa_supervisor + snmpa_supervisor A supervisor for the SNMP agent Processes

This is the top supervisor for the agent part of the SNMP @@ -42,7 +42,7 @@ - start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for sub-agents only Opts = [opt()] @@ -60,7 +60,7 @@ - start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for all agents Opts = [opt()] @@ -82,7 +82,7 @@ - start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} + start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} Start a sub-agent ParentAgent = pid() @@ -99,7 +99,7 @@ - stop_sub_agent(SubAgent) -> ok | no_such_child + stop_sub_agent(SubAgent) -> ok | no_such_child Stop a sub-agent SubAgent = pid() diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml index aba51bb500..b22b32a133 100644 --- a/lib/snmp/doc/src/snmpc.xml +++ b/lib/snmp/doc/src/snmpc.xml @@ -32,7 +32,7 @@ snmpc.xml - snmpc + snmpc Interface Functions to the SNMP toolkit MIB compiler

The module snmpc contains interface functions to the @@ -43,8 +43,8 @@ - compile(File) - compile(File, Options) -> {ok, BinFileName} | {error, Reason} + compile(File) + compile(File, Options) -> {ok, BinFileName} | {error, Reason} Compile the specified MIB File = string() @@ -236,7 +236,7 @@ - is_consistent(Mibs) -> ok | {error, Reason} + is_consistent(Mibs) -> ok | {error, Reason} Check for OID conflicts between MIBs Mibs = [MibName] @@ -252,7 +252,7 @@ - mib_to_hrl(MibName) -> ok | {error, Reason} + mib_to_hrl(MibName) -> ok | {error, Reason} Generate constants for the objects in the MIB MibName = string() diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index 9b8029330e..c45df98ee0 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -32,7 +32,7 @@ snmpm.xml - snmpm + snmpm Interface functions to the SNMP toolkit manager

The module snmpm contains interface functions to the @@ -77,7 +77,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - monitor() -> Ref + monitor() -> Ref Monitor the snmp manager Ref = reference() @@ -92,7 +92,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - demonitor(Ref) -> void() + demonitor(Ref) -> void() Turn off monitoring of the snmp manager Ref = reference() @@ -105,7 +105,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - notify_started(Timeout) -> Pid + notify_started(Timeout) -> Pid Request to be notified when manager started Timeout = integer() @@ -148,7 +148,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - cancel_notify_started(Pid) -> void() + cancel_notify_started(Pid) -> void() Cancel request to be notified when manager started Pid = pid() @@ -161,8 +161,8 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - register_user(Id, Module, Data) -> ok | {error, Reason} - register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user(Id, Module, Data) -> ok | {error, Reason} + register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a user of the manager Id = term() @@ -204,8 +204,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_user_monitor(Id, Module, Data) -> ok | {error, Reason} - register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a monitored user of the manager Id = term() @@ -252,7 +252,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_user(Id) -> ok | {error, Reason} + unregister_user(Id) -> ok | {error, Reason} Unregister the user Id = term() @@ -265,7 +265,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_users() -> Users + which_users() -> Users Get a list of all users Users = [UserId] @@ -279,7 +279,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_agent(UserId, TargetName, Config) -> ok | {error, Reason} + register_agent(UserId, TargetName, Config) -> ok | {error, Reason} Register this agent UserId = term() @@ -325,7 +325,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_agent(UserId, TargetName) -> ok | {error, Reason} + unregister_agent(UserId, TargetName) -> ok | {error, Reason} Unregister the user UserId = term() @@ -339,7 +339,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} + agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} Retrieve agent config TargetName = target_name() @@ -355,7 +355,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason} - update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} + update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} Update agent config UserId = term() @@ -379,8 +379,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_agents() -> Agents - which_agents(UserId) -> Agents + which_agents() -> Agents + which_agents(UserId) -> Agents List the registered agents UserId = term() @@ -396,7 +396,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} + register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} Register this USM user EngineID = string() @@ -427,7 +427,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} + unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} Unregister this USM user EngineID = string() @@ -442,7 +442,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} + usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} Retrieve usm user config EngineID = string() @@ -458,7 +458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} + update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} Update agent config EngineID = string() @@ -475,7 +475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users() -> UsmUsers + which_usm_users() -> UsmUsers List all the registered usm users UsmUsers = [{EngineID,UserName}] @@ -490,7 +490,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users(EngineID) -> UsmUsers + which_usm_users(EngineID) -> UsmUsers List the registered usm users UsmUsers = [UserName] @@ -559,11 +559,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-request UserId = term() @@ -647,11 +647,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-request UserId = term() @@ -737,11 +737,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-next-request UserId = term() @@ -814,11 +814,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-next-request UserId = term() @@ -906,11 +906,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous set-request UserId = term() @@ -990,11 +990,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous set-request UserId = term() @@ -1082,11 +1082,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-bulk-request UserId = term() @@ -1162,11 +1162,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-bulk-request UserId = term() @@ -1199,7 +1199,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - cancel_async_request(UserId, ReqId) -> ok | {error, Reason} + cancel_async_request(UserId, ReqId) -> ok | {error, Reason} Cancel a asynchronous request UserId = term() @@ -1215,13 +1215,13 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -1299,7 +1299,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -1321,7 +1321,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type NewType = OldType = atl_type() @@ -1340,7 +1340,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - load_mib(Mib) -> ok | {error, Reason} + load_mib(Mib) -> ok | {error, Reason} Load a MIB into the manager Mib = MibName @@ -1361,7 +1361,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unload_mib(Mib) -> ok | {error, Reason} + unload_mib(Mib) -> ok | {error, Reason} Unload a MIB from the manager Mib = MibName @@ -1382,7 +1382,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_mibs() -> Mibs + which_mibs() -> Mibs Which mibs are loaded into the manager Mibs = [{MibName, MibFile}] @@ -1397,7 +1397,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - name_to_oid(Name) -> {ok, Oids} | {error, Reason} + name_to_oid(Name) -> {ok, Oids} | {error, Reason} Get all the possible oid's for an alias-name Name = atom() @@ -1414,7 +1414,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_name(Oid) -> {ok, Name} | {error, Reason} + oid_to_name(Oid) -> {ok, Name} | {error, Reason} Get the alias-name of the oid Oid = oid() @@ -1429,7 +1429,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_type(Oid) -> {ok, Type} | {error, Reason} + oid_to_type(Oid) -> {ok, Type} | {error, Reason} Get the type of the the oid Oid = oid() @@ -1444,7 +1444,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - backup(BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} Backup manager data BackupDir = string() @@ -1458,7 +1458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - info() -> [{Key, Value}] + info() -> [{Key, Value}] Return information about the manager Key = atom() @@ -1475,7 +1475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - verbosity(Ref, Verbosity) -> void() + verbosity(Ref, Verbosity) -> void() Assign a new verbosity for the process Ref = server | config | net_if | note_store | all @@ -1492,8 +1492,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - format_reason(Reason) -> string() - format_reason(Prefix, Reason) -> string() + format_reason(Reason) -> string() + format_reason(Prefix, Reason) -> string() Assign a new verbosity for the process Reason = term() diff --git a/lib/snmp/doc/src/snmpm_conf.xml b/lib/snmp/doc/src/snmpm_conf.xml index a3097e5f7e..17ecf2df7c 100644 --- a/lib/snmp/doc/src/snmpm_conf.xml +++ b/lib/snmp/doc/src/snmpm_conf.xml @@ -32,7 +32,7 @@ snmpm_conf.xml - snmpm_conf + snmpm_conf Utility functions for handling the manager config files.

The module snmpm_conf contains various utility functions to @@ -42,7 +42,7 @@ - manager_entry(Tag, Val) -> manager_entry() + manager_entry(Tag, Val) -> manager_entry() Create an manager entry Tag = address | port | engine_id | max_message_size @@ -60,8 +60,8 @@ - write_manager_config(Dir, Conf) -> ok - write_manager_config(Dir, Hdr, Conf) -> ok + write_manager_config(Dir, Conf) -> ok + write_manager_config(Dir, Hdr, Conf) -> ok Write the manager config to the config file Dir = string() @@ -81,7 +81,7 @@ - append_manager_config(Dir, Conf) -> ok + append_manager_config(Dir, Conf) -> ok Append the manager config to the config file Dir = string() @@ -98,7 +98,7 @@ - read_manager_config(Dir) -> Conf + read_manager_config(Dir) -> Conf Read the manager config from the config file Dir = string() @@ -115,9 +115,9 @@ - users_entry(UserId) -> users_entry() - users_entry(UserId, UserMod) -> users_entry() - users_entry(UserId, UserMod, UserData) -> users_entry() + users_entry(UserId) -> users_entry() + users_entry(UserId, UserMod) -> users_entry() + users_entry(UserId, UserMod, UserData) -> users_entry() Create an users entry UserId = term() @@ -139,8 +139,8 @@ - write_users_config(Dir, Conf) -> ok - write_users_config(Dir, Hdr, Conf) -> ok + write_users_config(Dir, Conf) -> ok + write_users_config(Dir, Hdr, Conf) -> ok Write the manager users config to the config file Dir = string() @@ -161,7 +161,7 @@ - append_users_config(Dir, Conf) -> ok + append_users_config(Dir, Conf) -> ok Append the manager users config to the config file Dir = string() @@ -179,7 +179,7 @@ - read_users_config(Dir) -> Conf + read_users_config(Dir) -> Conf Read the manager users config from the config file Dir = string() @@ -196,7 +196,7 @@ - agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() + agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() Create an agents entry UserId = term() @@ -223,8 +223,8 @@ - write_agents_config(Dir, Conf) -> ok - write_agents_config(Dir, Hdr, Conf) -> ok + write_agents_config(Dir, Conf) -> ok + write_agents_config(Dir, Hdr, Conf) -> ok Write the manager agents to the config file Dir = string() @@ -245,7 +245,7 @@ - append_agents_config(Dir, Conf) -> ok + append_agents_config(Dir, Conf) -> ok Append the manager agents to the config file Dir = string() @@ -263,7 +263,7 @@ - read_agents_config(Dir) -> Conf + read_agents_config(Dir) -> Conf Read the manager agents config from the config file Dir = string() @@ -280,8 +280,8 @@ - usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() - usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + 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() @@ -303,8 +303,8 @@ - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the manager usm config to the config file Dir = string() @@ -325,7 +325,7 @@ - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the manager usm config to the config file Dir = string() @@ -343,7 +343,7 @@ - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the manager usm config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml index c8b2797ea7..b024f8d294 100644 --- a/lib/snmp/doc/src/snmpm_mpd.xml +++ b/lib/snmp/doc/src/snmpm_mpd.xml @@ -32,7 +32,7 @@ snmpm_mpd.xml - snmpm_mpd + snmpm_mpd Message Processing and Dispatch module for the SNMP manager

The module snmpm_mpd implements the version independent @@ -48,7 +48,7 @@ - init_mpd(Vsns) -> mpd_state() + init_mpd(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -92,7 +92,7 @@ - generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a request message to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' @@ -117,7 +117,7 @@ - generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a response packet to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' diff --git a/lib/snmp/doc/src/snmpm_network_interface.xml b/lib/snmp/doc/src/snmpm_network_interface.xml index 73892aa2e8..e4a66ceef2 100644 --- a/lib/snmp/doc/src/snmpm_network_interface.xml +++ b/lib/snmp/doc/src/snmpm_network_interface.xml @@ -32,7 +32,7 @@ snmpm_network_interface.xml - snmpm_network_interface + snmpm_network_interface Behaviour module for the SNMP manager network interface.

This module defines the behaviour of the manager network @@ -79,7 +79,7 @@ - start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} + start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} Start-link the network interface process Server = pid() @@ -95,7 +95,7 @@ - stop(Pid) -> void() + stop(Pid) -> void() Stop the network interface process Pid = pid() @@ -108,7 +108,7 @@ - send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() + send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() Request the network interface process to send this pdu Pid = pid() @@ -142,7 +142,7 @@ - inform_response(Pid, Ref, Addr, Port) -> void() + inform_response(Pid, Ref, Addr, Port) -> void() Send the inform-request ack Pid = pid() @@ -163,7 +163,7 @@ - note_store(Pid, NoteStore) -> void() + note_store(Pid, NoteStore) -> void() Change the verbosity of the network interface process Pid = pid() @@ -179,7 +179,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -198,7 +198,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of the network interface process Pid = pid() @@ -212,7 +212,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -233,7 +233,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpm_network_interface_filter.xml b/lib/snmp/doc/src/snmpm_network_interface_filter.xml index 742cd53fc6..a50572da51 100644 --- a/lib/snmp/doc/src/snmpm_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpm_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpm_network_interface_filter.xml - snmpm_network_interface_filter + snmpm_network_interface_filter Behaviour module for the SNMP manager network-interface filter.

This module defines the behaviour of the manager network interface @@ -100,7 +100,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -132,7 +132,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -150,7 +150,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Domain, Addr, PduType) -> boolean() + accept_send_pdu(Domain, Addr, PduType) -> boolean() Shall the pdu be sent Domain = transportDomain() diff --git a/lib/snmp/doc/src/snmpm_user.xml b/lib/snmp/doc/src/snmpm_user.xml index ef35f0eaaf..9abf596c83 100644 --- a/lib/snmp/doc/src/snmpm_user.xml +++ b/lib/snmp/doc/src/snmpm_user.xml @@ -32,7 +32,7 @@ snmpm_user.xml - snmpm_user + snmpm_user Behaviour module for the SNMP manager user.

This module defines the behaviour of the manager user. @@ -93,7 +93,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_error(ReqId, Reason, UserData) -> void() + handle_error(ReqId, Reason, UserData) -> void() Handle error ReqId = integer() @@ -122,7 +122,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply + handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply Handle agent Domain = transportDomainUdpIpv4 | transportDomainUdpIpv6 @@ -181,7 +181,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() + handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() Handle the reply to an asynchronous request TargetName = target_name() @@ -202,7 +202,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply + handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply Handle a trap/notification message TargetName = TargetName2 = target_name() @@ -225,7 +225,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply + handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply Handle a inform message TargetName = TargetName2 = target_name() @@ -253,7 +253,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_report(TargetName, SnmpReportInfo, UserData) -> Reply + handle_report(TargetName, SnmpReportInfo, UserData) -> Reply Handle a report message TargetName = TargetName2 = target_name() -- cgit v1.2.3