From c27def2281391d4c70791f7406c1eee4f08c18da Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Tue, 21 Feb 2012 11:04:09 +0100 Subject: [snmp] Release notes and documentation for the new transport module Added the release notes and documentation for the new transport module, snmpm_net_if_mt. OTP-9876 --- lib/snmp/doc/src/notes.xml | 67 ++++++++++++++++++++++ lib/snmp/doc/src/snmp_config.xml | 12 ++-- lib/snmp/doc/src/snmp_manager_netif.xml | 43 +++++++------- .../doc/src/snmpm_network_interface_filter.xml | 9 +-- 4 files changed, 101 insertions(+), 30 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml index 071b16a8f6..82c7deb467 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -33,6 +33,73 @@ +
+ SNMP Development Toolkit 4.22 +

Version 4.22 supports code replacement in runtime from/to + version 4.21.7 4.21.6 4.21.5, 4.21.4, 4.21.3, 4.21.2, 4.21.1 and 4.21.

+ +
+ Improvements and new features + + + + +

[manager] Introduced a new transport module, + snmpm_net_if_mt, + which handles all incomming and outgoing + traffic in newly created processes. The message/request is + processed and then the process exits.

+

Own Id: OTP-9876

+ + + + +
+ +
+ Fixed Bugs and Malfunctions +

-

+ + +
+ +
+ Incompatibilities +

-

+ + + +
+ +
+ +
SNMP Development Toolkit 4.21.5

Version 4.21.5 supports code replacement in runtime from/to diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml index fc8562b638..7431805489 100644 --- a/lib/snmp/doc/src/snmp_config.xml +++ b/lib/snmp/doc/src/snmp_config.xml @@ -523,17 +523,17 @@ {no_reuse, no_reuse()} | {filter, manager_net_if_filter_options()}

These options are actually specific to the used module. - The ones shown here are applicable to the default - manager_net_if_module().

+ The ones shown here are applicable to the default + manager_net_if_module().

For defaults see the options in manager_net_if_option().

]]> -

Module which handles the network interface part for the - SNMP manager. Must implement the - snmpm_network_interface behaviour.

-

Default is snmpm_net_if.

+

The module which handles the network interface part for the + SNMP manager. It must implement the + snmpm_network_interface behaviour.

+

Default is snmpm_net_if.

]]> diff --git a/lib/snmp/doc/src/snmp_manager_netif.xml b/lib/snmp/doc/src/snmp_manager_netif.xml index 2738ca76c1..169e20d10b 100644 --- a/lib/snmp/doc/src/snmp_manager_netif.xml +++ b/lib/snmp/doc/src/snmp_manager_netif.xml @@ -1,10 +1,10 @@ - +
- 20042009 + 20042012 Ericsson AB. All Rights Reserved. @@ -35,31 +35,34 @@ The Purpose of Manager Net if +

The Network Interface (Net if) process delivers SNMP PDUs to the - manager server, and receives SNMP PDUs from the manager server. - The most common behaviour of a Net if process is that is receives - request PDU from the manager server, encodes the PDU into bytes - and transmits the bytes onto the network to an agent. When the - reply from the agent is received by the Net if process, which it - decodes into an SNMP PDU, which it sends to the manager server. -

+ manager server, and receives SNMP PDUs from the manager server. + The most common behaviour of a Net if process is that is receives + request PDU from the manager server, encodes the PDU into bytes + and transmits the bytes onto the network to an agent. When the + reply from the agent is received by the Net if process, which it + decodes into an SNMP PDU, which it sends to the manager server.

+

However, that simple behaviour can be modified in numerous - ways. For example, the Net if process can apply some kind of - encrypting/decrypting scheme on the bytes. -

-

It is also possible to write your own Net if process. The default - Net if process is implemented in the module snmpm_net_if and - it uses UDP as the transport protocol. -

-

This section describes how to write a Net if process. -

+ ways. For example, the Net if process can apply some kind of + encrypting/decrypting scheme on the bytes.

+ +

The snmp application provides two different modules, + snmpm_net_if (the default) and snmpm_net_if_mt, + both uses the UDP as the transport protocol. The difference + between the two modules is that the latter is "multi-threaded", + i.e. for each message/request a new process is created that + process the message/request and then exits.

+ +

It is also possible to write your own Net if process, + this section describes how to write a Net if processdo that.

Mandatory Functions

A Net if process must implement the SNMP manager - network interface behaviour. -

+ network interface behaviour.

diff --git a/lib/snmp/doc/src/snmpm_network_interface_filter.xml b/lib/snmp/doc/src/snmpm_network_interface_filter.xml index ea1e183848..5f80cec94e 100644 --- a/lib/snmp/doc/src/snmpm_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpm_network_interface_filter.xml @@ -1,10 +1,10 @@ - +
- 20072009 + 20072012 Ericsson AB. All Rights Reserved. @@ -72,9 +72,10 @@

Note that the network interface filter is something which is used by the network interface implementation provided by the application - (snmpm_net_if). The default filter accepts all messages.

+ (snmpm_net_if and snmpm_net_if_mt). + The default filter accepts all messages.

A network interface filter can e.g. be used during testing or for load - regulation.

+ regulation.

-- cgit v1.2.3 From b5465108cd1456984872e2d04a51af021b4fe110 Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Tue, 21 Feb 2012 12:25:34 +0100 Subject: [snmp] More documentaion regarding the new manager net-if module OTP-9876 --- lib/snmp/doc/src/snmp_app.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml index 694e619da1..5f8672423f 100644 --- a/lib/snmp/doc/src/snmp_app.xml +++ b/lib/snmp/doc/src/snmp_app.xml @@ -1,4 +1,4 @@ - + @@ -35,8 +35,8 @@ The SNMP Application

This chapter describes the snmp - application in OTP. The SNMP application provides the following - services:

+ application in OTP. The SNMP application provides the following + services:

a multilingual extensible SNMP agent

@@ -525,15 +525,15 @@ {no_reuse, no_reuse()} | {filter, manager_net_if_filter_options()}

These options are actually specific to the used module. - The ones shown here are applicable to the default - manager_net_if_module().

+ The ones shown here are applicable to the default + manager_net_if_module().

For defaults see the options in manager_net_if_option().

 ]]> -

Module which handles the network interface part for the - SNMP manager. Must implement the +

The module which handles the network interface part for the + SNMP manager. It must implement the snmpm_network_interface behaviour.

Default is snmpm_net_if.

 -- cgit v1.2.3 From f9f7bde8524e9863b689275691f4b4711e30d0ff Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Wed, 22 Feb 2012 14:16:48 +0100 Subject: [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 --- lib/snmp/doc/src/notes.xml | 9 +++++++++ lib/snmp/doc/src/snmp.xml | 28 ++++++++++++++++++++++++++-- lib/snmp/doc/src/snmpa.xml | 34 +++++++++++++++++++++++++++++++++- lib/snmp/doc/src/snmpm.xml | 34 +++++++++++++++++++++++++++++++++- 4 files changed, 101 insertions(+), 4 deletions(-) (limited to 'lib/snmp/doc') diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml index 82c7deb467..e7fb4e2287 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -45,6 +45,15 @@ --> + +

Added the log_to_io audit-trail-log converter function to the + api modules of both the + manager + and + agent.

+

Own Id: OTP-9940

+ +

[manager] Introduced a new transport module, snmpm_net_if_mt, diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index af0833f005..3e6610891f 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -1,10 +1,10 @@ - +

- 19962009 + 19962012 Ericsson AB. All Rights Reserved. @@ -391,6 +391,30 @@ version of the protocol data unit. There is a new line between Vsn and PDU.

+ + + + + + log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason} + Convert an Audit Trail Log to text format + + LogDir = string() + Mibs = [MibName] + MibName = string() + LogName = string() + LogFile = string() + Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} + Reason = term() + + +

Converts an Audit Trail Log to a readable format and + prints it on stdio. See + log_to_txt + above for more info.

+ diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index 27d89ea4e3..9984a10fea 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -4,7 +4,7 @@
- 20042011 + 20042012 Ericsson AB. All Rights Reserved. @@ -495,6 +495,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} + log_to_txt(LogDir) log_to_txt(LogDir, Mibs) log_to_txt(LogDir, Mibs, OutFile) -> ok | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName) -> ok | {error, Reason} @@ -522,6 +523,37 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} See snmp:log_to_txt for more info.

+ + + + + + log_to_io(LogDir) -> ok | {error, Reason} + log_to_io(LogDir, Mibs) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason} + Convert an Audit Trail Log to text format + + LogDir = string() + Mibs = [MibName] + MibName = string() + LogName = string() + LogFile = string() + Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} + Reason = disk_log_open_error() | file_open_error() | term() + disk_log_open_error() = {LogName, term()} + file_open_error() = {OutFile, term()} + + +

Converts an Audit Trail Log to a readable format and + prints it on stdio. + LogName defaults to "snmpa_log". + LogFile defaults to "snmpa.log". + See snmp:log_to_io + for more info.

+ 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 @@
- 20042011 + 20042012 Ericsson AB. All Rights Reserved. @@ -1237,6 +1237,38 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 See snmp:log_to_txt for more info.

+ + + + + + log_to_io(LogDir) -> ok | {error, Reason} + log_to_io(LogDir, Mibs) -> ok | {error, Reason} + log_to_io(LogDir, Mibs) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason} + Convert an Audit Trail Log to text format + + LogDir = string() + Mibs = [MibName] + MibName = string() + LogName = string() + LogFile = string() + Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} + Reason = disk_log_open_error() | file_open_error() | term() + disk_log_open_error() = {LogName, term()} + file_open_error() = {OutFile, term()} + + +

Converts an Audit Trail Log to a readable format and + prints it on stdio. + LogName defaults to "snmpm_log". + LogFile defaults to "snmpm.log". + See snmp:log_to_io + for more info.

+ -- cgit v1.2.3 From 14a757d5444719c33e9fbca8d97114d58229291f Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Wed, 22 Feb 2012 14:40:36 +0100 Subject: [snmp] Updated release notes and appup file OTP-9876 OTP-9940 --- 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 e7fb4e2287..ffbdec5a5b 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -46,8 +46,8 @@ -

Added the log_to_io audit-trail-log converter function to the - api modules of both the +

Added the log_to_io audit-trail-log converter function + to the api modules of both the manager and agent.

-- cgit v1.2.3