diff options
author | Micael Karlberg <[email protected]> | 2012-02-22 14:16:48 +0100 |
---|---|---|
committer | Micael Karlberg <[email protected]> | 2012-02-22 14:53:10 +0100 |
commit | f9f7bde8524e9863b689275691f4b4711e30d0ff (patch) | |
tree | 48df6b404f8a2e71ed267de9fb9882ab39d97d20 /lib/snmp/doc/src/snmpm.xml | |
parent | b5465108cd1456984872e2d04a51af021b4fe110 (diff) | |
download | otp-f9f7bde8524e9863b689275691f4b4711e30d0ff.tar.gz otp-f9f7bde8524e9863b689275691f4b4711e30d0ff.tar.bz2 otp-f9f7bde8524e9863b689275691f4b4711e30d0ff.zip |
[snmp] Add log_to_io function for both manager and agent
Add a log_to_io Audit Trail Log converter function for
both the manager (snmpm) and agent (snmpa).
Also fixed the converter functions in the logger module,
snmp_log, which previously sometimes did not work
properly (re-open an already open log with different
properties).
OTP-9940
Diffstat (limited to 'lib/snmp/doc/src/snmpm.xml')
-rw-r--r-- | lib/snmp/doc/src/snmpm.xml | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index c36a1b2a24..9bbb6cdbdb 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2004</year><year>2011</year> + <year>2004</year><year>2012</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -1237,6 +1237,38 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 See <seealso marker="snmp#log_to_txt">snmp:log_to_txt</seealso> for more info.</p> + <marker id="log_to_io"></marker> + </desc> + </func> + + <func> + <name>log_to_io(LogDir) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs, LogName) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason}</name> + <name>log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason}</name> + <fsummary>Convert an Audit Trail Log to text format</fsummary> + <type> + <v>LogDir = string()</v> + <v>Mibs = [MibName]</v> + <v>MibName = string()</v> + <v>LogName = string()</v> + <v>LogFile = string()</v> + <v>Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} </v> + <v>Reason = disk_log_open_error() | file_open_error() | term()</v> + <v>disk_log_open_error() = {LogName, term()}</v> + <v>file_open_error() = {OutFile, term()}</v> + </type> + <desc> + <p>Converts an Audit Trail Log to a readable format and + prints it on stdio. + <c>LogName</c> defaults to "snmpm_log". + <c>LogFile</c> defaults to "snmpm.log". + See <seealso marker="snmp#log_to_io">snmp:log_to_io</seealso> + for more info.</p> + <marker id="change_log_size"></marker> </desc> </func> |