Add ability to generate ASCII documentation from the TeX files.
[asterisk/asterisk.git] / doc / snmp.txt
1 Asterisk SNMP Support
2 ---------------------
3
4 Rudimentary support for SNMP access to Asterisk is available.  To build
5 this, one needs to have Net-SNMP development headers and libraries on
6 the build system, including any libraries Net-SNMP depends on.
7
8 Note that on some (many?) Linux-distributions the dependency list in
9 the net-snmp-devel list is not complete, and additional packages will 
10 need to be installed.  This is usually seen as configure failing to 
11 detect net-snmp-devel as the configure script does a sanity check of 
12 the net-snmp build environment, based on the output of 
13 'net-snmp-config --agent-libs'.  
14
15 To see what your distribution requires, run 'net-snmp-config --agent-libs'.
16
17 You will receive a response similar to the following:
18 -L/usr/lib -lnetsnmpmibs -lnetsnmpagent -lnetsnmphelpers -lnetsnmp -ldl 
19 -lrpm -lrpmio -lpopt -lz -lcrypto -lm -lsensors -L/usr/lib/lib -lwrap 
20 -Wl,-E -Wl,-rpath,/usr/lib/perl5/5.8.8/i386-linux-thread-multi/CORE 
21 -L/usr/local/lib 
22 /usr/lib/perl5/5.8.8/i386-linux-thread-multi/auto/DynaLoader/DynaLoader.a 
23 -L/usr/lib/perl5/5.8.8/i386-linux-thread-multi/CORE -lperl -lresolv -lnsl 
24 -ldl -lm -lcrypt -lutil -lpthread -lc
25
26 The packages required may include the following:
27         * bzip2-devel
28         * lm_sensors-devel
29         * newt-devel
30
31 SNMP support comes in two varieties -- as a sub-agent to a running SNMP
32 daemon using the AgentX protocol, or as a full standalone agent.  If
33 you wish to run a full standalone agent, Asterisk must run as root in
34 order to bind to port 161.
35
36 Configuring access when running as a full agent is something that is
37 left as an exercise to the reader.
38
39 To enable access to the Asterisk SNMP subagent from a master SNMP
40 daemon, one will need to enable AgentX support, and also make sure that
41 Asterisk will be able to access the Unix domain socket.  One way of
42 doing this is to add the following to /etc/snmp/snmpd.conf:
43
44         # Enable AgentX support
45         master agentx
46
47         # Set permissions on AgentX socket and containing
48         # directory such that process in group 'asterisk'
49         # will be able to connect
50         agentXPerms  0660 0550 nobody asterisk
51
52 This assumes that you run Asterisk under group 'asterisk' (and does
53 not care what user you run as).