afab91c3e0a0394e690deb1f9e4b5f8b439a6968
[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 RPMs will need
10 to be installed.  This is typically seen as attempts to build res_snmp
11 as net-snmp-devel is available, but then failures to find certain
12 libraries.
13
14 SNMP support comes in two varieties -- as a sub-agent to a running SNMP
15 daemon using the AgentX protocol, or as a full standalone agent.  If
16 you wish to run a full standalone agent, Asterisk must run as root in
17 order to find to port 161.
18
19 Configuring access when running as a full agent is something that is
20 left as an exercise to the reader.
21
22 To enable access to the Asterisk SNMP subagent from a master SNMP
23 daemon, one will need to enable AgentX support, and also make sure that
24 Asterisk will be able to access the Unix domain socket.  One way of
25 doing this is to add the following to /etc/snmp/snmpd.conf:
26
27         # Enable AgentX support
28         master agentx
29
30         # Set permissions on AgentX socket and containing
31         # directory such that process in group 'asterisk'
32         # will be able to connect
33         agentXPerms  0660 0550 nobody asterisk
34
35 This assumes that you run Asterisk under group 'asterisk' (and does
36 not care what user you run as).