← Back to branch summary

~ubuntu-branches/ubuntu/karmic/erlang/karmic-security

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmp_manager_funct_descr.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-01 10:14:38 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090501101438-6qlr6rsdxgyzrg2z
Tags: 1:13.b-dfsg-2
* Cleaned up patches: removed unneeded patch which helped to support
  different SCTP library versions, made sure that changes for m68k
  architecture applied only when building on this architecture.
* Removed duplicated information from binary packages descriptions.
* Don't require libsctp-dev build-dependency on solaris-i386 architecture
  which allows to build Erlang on Nexenta (thanks to Tim Spriggs for
  the suggestion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmp_manager_funct_descr.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE chapter SYSTEM "chapter.dtd">
 
3
 
 
4
<chapter>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2004</year><year>2009</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>Manager Functional Description</title>
 
25
    <prepared></prepared>
 
26
    <responsible></responsible>
 
27
    <docno></docno>
 
28
    <approved></approved>
 
29
    <checked></checked>
 
30
    <date></date>
 
31
    <rev></rev>
 
32
    <file>snmp_manager_funct_descr.xml</file>
 
33
  </header>
 
34
 
 
35
  <section>
 
36
    <title>Features</title>
 
37
    <marker id="features"></marker>
 
38
    <p>The manager provided with the tool is a lightweight manager
 
39
      that basically provides a means to communicate with agents.</p>
 
40
    <p>It does not really implement any management capabilities by 
 
41
      itself. That is up to the <em>user</em>. 
 
42
      </p>
 
43
    <p>A <em>user</em> in this context is basically a module implementing
 
44
      the <seealso marker="snmpm_user">snmpm_user</seealso> behaviour. 
 
45
      A <em>user</em> can issue snmp requests and receive 
 
46
      notification/traps.</p>
 
47
    <p>Agents to be accessed by the manager needs to be registered by 
 
48
      a user. Once registered, they can be accessed by all registered 
 
49
      users.</p>
 
50
    <p>Notifications/traps from an agent is delivered to the user that 
 
51
      did the registration.</p>
 
52
    <p>Any message from an agent that is not registered is delivered to 
 
53
      the <em>default user</em>.</p>
 
54
    <p>By default, the <em>default user</em> is set to the 
 
55
      <c>snmpm_user_default</c> module, which simply sends an info message
 
56
      to the error_logger. It is however highly recommended that this
 
57
      module be replaced by another that does something useful
 
58
      (see <seealso marker="snmp_config#configuration_params">configuration params</seealso> for more info).</p>
 
59
    <p>When using version 3, then (at least one) <em>usm user</em> has to 
 
60
      be registered.</p>
 
61
    <p>Requests can be issued in two different ways. Synchronous (see
 
62
      <seealso marker="snmpm#sync_set">sync_set</seealso>,
 
63
      <seealso marker="snmpm#sync_get">sync_get</seealso>, 
 
64
      <seealso marker="snmpm#sync_get_next">sync_get_next</seealso> and 
 
65
      <seealso marker="snmpm#sync_get_bulk">sync_get_bulk</seealso>)
 
66
      and asynchronous (see 
 
67
      <seealso marker="snmpm#async_set">async_set</seealso>,
 
68
      <seealso marker="snmpm#async_get">async_get</seealso>, 
 
69
      <seealso marker="snmpm#async_get_next">async_get_next</seealso> and  
 
70
      <seealso marker="snmpm#async_get_bulk">async_get_bulk</seealso>). 
 
71
      With synchronous 
 
72
      the snmp reply is returned by the function. With asynchronous,
 
73
      the reply will instead be delivered through a call to one of the
 
74
      <c>handle_pdu</c> callback function defined by the 
 
75
      <seealso marker="snmpm_user#handle_pdu">handle_pdu</seealso> 
 
76
      behaviour.</p>
 
77
  </section>
 
78
 
 
79
  <section>
 
80
    <title>Operation</title>
 
81
    <marker id="operation"></marker>
 
82
    <p>The following steps are needed to get the manager running:</p>
 
83
    <list type="ordered">
 
84
      <item>
 
85
        <p>[optional] Implement the default user.</p>
 
86
      </item>
 
87
      <item>
 
88
        <p>Implement the user(s).</p>
 
89
      </item>
 
90
      <item>
 
91
        <p>Configure the application (manager).</p>
 
92
      </item>
 
93
      <item>
 
94
        <p>Start the application (manager).</p>
 
95
      </item>
 
96
      <item>
 
97
        <p>Register the user(s).</p>
 
98
      </item>
 
99
      <item>
 
100
        <p>The user(s) register their agents.</p>
 
101
      </item>
 
102
    </list>
 
103
  </section>
 
104
 
 
105
  <section>
 
106
    <title>MIB loading</title>
 
107
    <marker id="mib_loading"></marker>
 
108
    <p>It is possible to load mibs into the manager, but this is not 
 
109
      necessary for normal operation, and not recomended.</p>
 
110
  </section>
 
111
</chapter>
 
112