From 8f184f6d4bace131e95c3ac905fb8bd0b4895bee Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Thu, 6 Sep 2018 19:21:18 +0200 Subject: [snmp] Updated doc for atl conversion functions OTP-15287 (ERIERL-206) --- lib/snmp/doc/src/snmp.xml | 31 +++++++++++++++++++++++-------- lib/snmp/doc/src/snmpa.xml | 36 +++++++++++++++++++++--------------- lib/snmp/doc/src/snmpm.xml | 36 +++++++++++++++++++++--------------- 3 files changed, 65 insertions(+), 38 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index 801193675c..2d44e3ff83 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -341,10 +341,10 @@ - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {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 LogDir = string() @@ -355,6 +355,9 @@ LogFile = string() Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} Block = boolean() + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = term() @@ -394,16 +397,25 @@ and Vsn is the SNMP version. PDU is a textual version of the protocol data unit. There is a new line between Vsn and PDU.

+ +

If the entire log is successfully converted, the function + will return ok. + If one of more entries fail to convert, the function will instead + return {ok, {NumOK, NumERR}}, where the counters indicate + how many valid and erroneous entries where found. + If instead {error, Reason} is returned, the conversion + encountered a fatal error and where either never done of aborted + midway.

- log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Block | Stop) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop, Block) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -412,6 +424,9 @@ LogName = string() LogFile = string() Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = term() diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index d756ff7a65..fd56c89a7e 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -559,13 +559,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 | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {error, Reason} + 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 LogDir = string() @@ -576,6 +576,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} LogName = string() LogFile = string() Start = Stop = null | calendar:datetime() | {local_time, calendar:datetime()} | {universal_time, calendar:datetime()} + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = disk_log_open_error() | file_open_error() | term() disk_log_open_error() = {LogName, term()} file_open_error() = {OutFile, term()} @@ -597,14 +600,14 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - log_to_io(LogDir) -> ok | {error, Reason} - log_to_io(LogDir, Block | Mibs) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, Block | LogName) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {error, Reason} + log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -614,6 +617,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} LogName = string() LogFile = string() Start = Stop = null | calendar:datetime() | {local_time, calendar:datetime()} | {universal_time, calendar:datetime()} + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = disk_log_open_error() | file_open_error() | term() disk_log_open_error() = {LogName, term()} file_open_error() = {OutFile, term()} diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index 4818aeb697..cdab7c51d7 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -1216,13 +1216,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 | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {error, Reason} + 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 LogDir = string() @@ -1233,6 +1233,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 LogName = string() LogFile = string() Start = Stop = null | calendar:datetime() | {local_time, calendar:datetime()} | {universal_time, calendar:datetime()} + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = disk_log_open_error() | file_open_error() | term() disk_log_open_error() = {LogName, term()} file_open_error() = {OutFile, term()} @@ -1254,15 +1257,15 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - log_to_io(LogDir) -> ok | {error, Reason} - log_to_io(LogDir, Block | Mibs) -> ok | {error, Reason} + log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} log_to_io(LogDir, Mibs) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, Block | LogName) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -1272,6 +1275,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 LogName = string() LogFile = string() Start = Stop = null | calendar:datetime() | {local_time, calendar:datetime()} | {universal_time, calendar:datetime()} + Cnt = {NumOK, NumERR} + NumOK = non_neg_integer() + NumERR = pos_integer() Reason = disk_log_open_error() | file_open_error() | term() disk_log_open_error() = {LogName, term()} file_open_error() = {OutFile, term()} -- cgit v1.2.3 From b665dd1fdab1c03b123911b5ccaca4dd0fc2809c Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Fri, 7 Sep 2018 12:55:41 +0200 Subject: [snmp] Update copyright end date OTP-15287 (ERIERL-206) --- lib/snmp/doc/src/snmp.xml | 2 +- lib/snmp/doc/src/snmpa.xml | 2 +- lib/snmp/doc/src/snmpm.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index 2d44e3ff83..480ed2e825 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -4,7 +4,7 @@
- 19962016 + 19962018 Ericsson AB. All Rights Reserved. diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index fd56c89a7e..b78f14da01 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -4,7 +4,7 @@
- 20042016 + 20042018 Ericsson AB. All Rights Reserved. diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index cdab7c51d7..be4cd58a1a 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -4,7 +4,7 @@
- 20042016 + 20042018 Ericsson AB. All Rights Reserved. -- cgit v1.2.3 From 229795aba1d4da773938715f2e5122d4885af826 Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Fri, 7 Sep 2018 18:31:16 +0200 Subject: [snmp] Add proper version Also fixed case clause. OTP-15287 (ERIERL-206) --- lib/snmp/doc/src/notes.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml index f64e0cca97..1607363ad1 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -4,7 +4,7 @@
- 19962017 + 19962018 Ericsson AB. All Rights Reserved. @@ -48,7 +48,7 @@ - +
SNMP 5.2.10 -- cgit v1.2.3