Add SNMP support (bug #6439)
[asterisk/asterisk.git] / doc / asterisk-mib.txt
1 ASTERISK-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4         OBJECT-TYPE, MODULE-IDENTITY, Integer32, Counter32, TimeTicks
5                 FROM SNMPv2-SMI
6
7         TEXTUAL-CONVENTION, DisplayString, TruthValue
8                 FROM SNMPv2-TC
9
10         digium
11                 FROM DIGIUM-MIB;
12
13 asterisk MODULE-IDENTITY
14         LAST-UPDATED    "200602041900Z"
15         ORGANIZATION    "Digium, Inc."
16         CONTACT-INFO
17                 "Mark Spencer
18                 Email: markster@digium.com"
19         DESCRIPTION
20                 "Asterisk is an Open Source PBX.  This MIB defined
21                 objects for managing Asterisk instances."
22         ::= { digium 1 }
23
24 asteriskVersion         OBJECT IDENTIFIER ::= { asterisk 1 }
25 asteriskConfiguration   OBJECT IDENTIFIER ::= { asterisk 2 }
26 asteriskModules         OBJECT IDENTIFIER ::= { asterisk 3 }
27 asteriskIndications     OBJECT IDENTIFIER ::= { asterisk 4 }
28 asteriskChannels        OBJECT IDENTIFIER ::= { asterisk 5 }
29
30 -- asteriskVersion
31
32 astVersionString OBJECT-TYPE
33         SYNTAX          DisplayString
34         MAX-ACCESS      read-only
35         STATUS          current
36         DESCRIPTION
37                 "Text version string of the version of Asterisk that
38                 the SNMP Agent was compiled to run against."
39         ::= { asteriskVersion 1 }
40
41 astVersionTag OBJECT-TYPE
42         SYNTAX          Unsigned32
43         MAX-ACCESS      read-only
44         STATUS          current
45         DESCRIPTION
46                 "SubVersion revision of the version of Asterisk that
47                 the SNMP Agent was compiled to run against -- this is
48                 typically 0 for release-versions of Asterisk."
49         ::= { asteriskVersion 2 }
50
51 -- asteriskConfiguration
52
53 astConfigUpTime OBJECT-TYPE
54         SYNTAX          TimeTicks
55         MAX-ACCESS      read-only
56         STATUS          current
57         DESCRIPTION
58                 "Time ticks since Asterisk was started."
59         ::= { asteriskConfiguration 1 }
60
61 astConfigReloadTime OBJECT-TYPE
62         SYNTAX          TimeTicks
63         MAX-ACCESS      read-only
64         STATUS          current
65         DESCRIPTION
66                 "Time ticks since Asterisk was last reloaded."
67         ::= { asteriskConfiguration 2 }
68
69 astConfigPid OBJECT-TYPE
70         SYNTAX          Integer32
71         MAX-ACCESS      read-only
72         STATUS          current
73         DESCRIPTION
74                 "The process id of the running Asterisk process."
75         ::= { asteriskConfiguration 3 }
76
77 astConfigSocket OBJECT-TYPE
78         SYNTAX          DisplayString
79         MAX-ACCESS      read-only
80         STATUS          current
81         DESCRIPTION
82                 "The control socket for giving Asterisk commands."
83         ::= { asteriskConfiguration 4 }
84
85 -- asteriskModules
86
87 astNumModules OBJECT-TYPE
88         SYNTAX          Integer32
89         MAX-ACCESS      read-only
90         STATUS          current
91         DESCRIPTION
92                 "Number of modules currently loaded into Asterisk."
93         ::= { asteriskModules 1 }
94
95 -- asteriskIndications
96
97 astNumIndications OBJECT-TYPE
98         SYNTAX          Integer32
99         MAX-ACCESS      read-only
100         STATUS          current
101         DESCRIPTION
102                 "Number of indications currently defined in Asterisk."
103         ::= { asteriskIndications 1 }
104
105 astCurrentIndication OBJECT-TYPE
106         SYNTAX          DisplayString
107         MAX-ACCESS      read-only
108         STATUS          current
109         DESCRIPTION
110                 "Default indication zone to use."
111         ::= { asteriskIndications 2 }
112
113 astIndicationsTable OBJECT-TYPE
114         SYNTAX          SEQUENCE OF AstIndicationsEntry
115         MAX-ACCESS      not-accessible
116         STATUS          current
117         DESCRIPTION
118                 "Table with all the indication zones currently know to
119                 the running Asterisk instance."
120         ::= { asteriskIndications 3 }
121
122 astIndicationsEntry OBJECT-TYPE
123         SYNTAX          AstIndicationsEntry
124         MAX-ACCESS      not-accessible
125         STATUS          current
126         DESCRIPTION
127                 "Information about a single indication zone."
128         INDEX           { astIndIndex }
129         ::= { astIndicationsTable 1 }
130
131 AstIndicationsEntry ::= SEQUENCE {
132         astIndIndex             Integer32,
133         astIndCountry           DisplayString,
134         astIndAlias             DisplayString,
135         astIndDescription       DisplayString
136 }
137
138 astIndIndex OBJECT-TYPE
139         SYNTAX          Integer32
140         MAX-ACCESS      read-only
141         STATUS          current
142         DESCRIPTION
143                 "Numerical index into the table of indication zones."
144         ::= { astIndicationsEntry 1 }
145
146 astIndCountry OBJECT-TYPE
147         SYNTAX          DisplayString
148         MAX-ACCESS      read-only
149         STATUS          current
150         DESCRIPTION
151                 "Country for which the indication zone is valid,
152                 typically this is the ISO 2-letter code of the country."
153         ::= { astIndicationsEntry 2 }
154
155 astIndAlias OBJECT-TYPE
156         SYNTAX          DisplayString
157         MAX-ACCESS      read-only
158         STATUS          current
159         DESCRIPTION
160                 ""
161         ::= { astIndicationsEntry 3 }
162
163 astIndDescription OBJECT-TYPE
164         SYNTAX          DisplayString
165         MAX-ACCESS      read-only
166         STATUS          current
167         DESCRIPTION
168                 "Description of the indication zone, usually the full
169                 name of the country it is valid for."
170         ::= { astIndicationsEntry 4 }
171
172 -- asteriskChannels
173
174 astNumChannels OBJECT-TYPE
175         SYNTAX          Integer32
176         MAX-ACCESS      read-only
177         STATUS          current
178         DESCRIPTION
179                 "Current number of active channels."
180         ::= { asteriskChannels 1 }
181
182 astChanTable OBJECT-TYPE
183         SYNTAX          SEQUENCE OF AstChanEntry
184         MAX-ACCESS      not-accessible
185         STATUS          current
186         DESCRIPTION
187                 "Table with details of the currently active channels
188                 in the Asterisk instance."
189         ::= { asteriskChannels 2 }
190
191 astChanEntry OBJECT-TYPE
192         SYNTAX          AstChanEntry
193         MAX-ACCESS      not-accessible
194         STATUS          current
195         DESCRIPTION
196                 "Details of a single channel."
197         INDEX           { astChanIndex }
198         ::= { astChanTable 1 }
199
200 AstChanEntry ::= SEQUENCE {
201         astChanIndex            Integer32,
202         astChanName             DisplayString,
203         astChanLanguage         DisplayString,
204         astChanType             DisplayString,
205         astChanMusicClass       DisplayString,
206         astChanBridge           DisplayString,
207         astChanMasq             DisplayString,
208         astChanMasqr            DisplayString,
209         astChanWhenHangup       TimeTicks,
210         astChanApp              DisplayString,
211         astChanData             DisplayString,
212         astChanContext          DisplayString,
213         astChanMacroContext     DisplayString,
214         astChanMacroExten       DisplayString,
215         astChanMacroPri         Integer32,
216         astChanExten            DisplayString,
217         astChanPri              Integer32,
218         astChanAccountCode      DisplayString,
219         astChanForwardTo        DisplayString,
220         astChanUniqueId         DisplayString,
221         astChanCallGroup        Unsigned32,
222         astChanPickupGroup      Unsigned32,
223         astChanState            INTEGER,
224         astChanMuted            TruthValue,
225         astChanRings            Integer32,
226         astChanCidDNID          DisplayString,
227         astChanCidNum           DisplayString,
228         astChanCidName          DisplayString,
229         astChanCidANI           DisplayString,
230         astChanCidRDNIS         DisplayString,
231         astChanCidPresentation  DisplayString,
232         astChanCidANI2          Integer32,
233         astChanCidTON           Integer32,
234         astChanCidTNS           Integer32,
235         astChanAMAFlags         INTEGER,
236         astChanADSI             INTEGER,
237         astChanToneZone         DisplayString,
238         astChanHangupCause      INTEGER,
239         astChanVariables        DisplayString,
240         astChanFlags            BITS,
241         astChanTransferCap      INTEGER
242 }
243
244 astChanIndex OBJECT-TYPE
245         SYNTAX          Integer32
246         MAX-ACCESS      read-only
247         STATUS          current
248         DESCRIPTION
249                 "Index into the channel table."
250         ::= { astChanEntry 1 }
251
252 astChanName OBJECT-TYPE
253         SYNTAX          DisplayString
254         MAX-ACCESS      read-only
255         STATUS          current
256         DESCRIPTION
257                 "Name of the currentl channel."
258         ::= { astChanEntry 2 }
259
260 astChanLanguage OBJECT-TYPE
261         SYNTAX          DisplayString
262         MAX-ACCESS      read-only
263         STATUS          current
264         DESCRIPTION
265                 "Which language the current channel is configured to
266                 use -- used mainly for prompts."
267         ::= { astChanEntry 3 }
268
269 astChanType OBJECT-TYPE
270         SYNTAX          DisplayString
271         MAX-ACCESS      read-only
272         STATUS          current
273         DESCRIPTION
274                 "Underlying technology for the current channel."
275         ::= { astChanEntry 4 }
276
277 astChanMusicClass OBJECT-TYPE
278         SYNTAX          DisplayString
279         MAX-ACCESS      read-only
280         STATUS          current
281         DESCRIPTION
282                 "Music class to be used for Music on Hold for this
283                 channel."
284         ::= { astChanEntry 5 }
285
286 astChanBridge OBJECT-TYPE
287         SYNTAX          DisplayString
288         MAX-ACCESS      read-only
289         STATUS          current
290         DESCRIPTION
291                 "Which channel this channel is currently bridged (in a
292                 conversation) with."
293         ::= { astChanEntry 6 }
294
295 astChanMasq OBJECT-TYPE
296         SYNTAX          DisplayString
297         MAX-ACCESS      read-only
298         STATUS          current
299         DESCRIPTION
300                 "Channel masquerading for us."
301         ::= { astChanEntry 7 }
302
303 astChanMasqr OBJECT-TYPE
304         SYNTAX          DisplayString
305         MAX-ACCESS      read-only
306         STATUS          current
307         DESCRIPTION
308                 "Channel we are masquerading for."
309         ::= { astChanEntry 8 }
310
311 astChanWhenHangup OBJECT-TYPE
312         SYNTAX          TimeTicks
313         MAX-ACCESS      read-only
314         STATUS          current
315         DESCRIPTION
316                 "How long until this channel will be hung up."
317         ::= { astChanEntry 9 }
318
319 astChanApp OBJECT-TYPE
320         SYNTAX          DisplayString
321         MAX-ACCESS      read-only
322         STATUS          current
323         DESCRIPTION
324                 "Current application for the channel."
325         ::= { astChanEntry 10 }
326
327 astChanData OBJECT-TYPE
328         SYNTAX          DisplayString
329         MAX-ACCESS      read-only
330         STATUS          current
331         DESCRIPTION
332                 "Arguments passed to the current application."
333         ::= { astChanEntry 11 }
334
335 astChanContext OBJECT-TYPE
336         SYNTAX          DisplayString
337         MAX-ACCESS      read-only
338         STATUS          current
339         DESCRIPTION
340                 "Current extension context."
341         ::= { astChanEntry 12 }
342
343 astChanMacroContext OBJECT-TYPE
344         SYNTAX          DisplayString
345         MAX-ACCESS      read-only
346         STATUS          current
347         DESCRIPTION
348                 "Current macro context."
349         ::= { astChanEntry 13 }
350
351 astChanMacroExten OBJECT-TYPE
352         SYNTAX          DisplayString
353         MAX-ACCESS      read-only
354         STATUS          current
355         DESCRIPTION
356                 "Current macro extension."
357         ::= { astChanEntry 14 }
358
359 astChanMacroPri OBJECT-TYPE
360         SYNTAX          Integer32
361         MAX-ACCESS      read-only
362         STATUS          current
363         DESCRIPTION
364                 "Current macro priority."
365         ::= { astChanEntry 15 }
366
367 astChanExten OBJECT-TYPE
368         SYNTAX          DisplayString
369         MAX-ACCESS      read-only
370         STATUS          current
371         DESCRIPTION
372                 "Current extension."
373         ::= { astChanEntry 16 }
374
375 astChanPri OBJECT-TYPE
376         SYNTAX          Integer32
377         MAX-ACCESS      read-only
378         STATUS          current
379         DESCRIPTION
380                 "Current priority."
381         ::= { astChanEntry 17 }
382
383 astChanAccountCode OBJECT-TYPE
384         SYNTAX          DisplayString
385         MAX-ACCESS      read-only
386         STATUS          current
387         DESCRIPTION
388                 "Account Code for billing."
389         ::= { astChanEntry 18 }
390
391 astChanForwardTo OBJECT-TYPE
392         SYNTAX          DisplayString
393         MAX-ACCESS      read-only
394         STATUS          current
395         DESCRIPTION
396                 "Where to forward to if asked to dial on this
397                 interface."
398         ::= { astChanEntry 19 }
399
400 astChanUniqueId OBJECT-TYPE
401         SYNTAX          DisplayString
402         MAX-ACCESS      read-only
403         STATUS          current
404         DESCRIPTION
405                 "Unique Channel Identifier."
406         ::= { astChanEntry 20 }
407
408 astChanCallGroup OBJECT-TYPE
409         SYNTAX          Unsigned32
410         MAX-ACCESS      read-only
411         STATUS          current
412         DESCRIPTION
413                 "Call Group."
414         ::= { astChanEntry 21 }
415
416 astChanPickupGroup OBJECT-TYPE
417         SYNTAX          Unsigned32
418         MAX-ACCESS      read-only
419         STATUS          current
420         DESCRIPTION
421                 "Pickup Group."
422         ::= { astChanEntry 22 }
423
424 astChanState OBJECT-TYPE
425         SYNTAX          INTEGER {
426                 stateDown(0),
427                 stateReserved(1),
428                 stateOffHook(2),
429                 stateDialing(3),
430                 stateRing(4),
431                 stateRinging(5),
432                 stateUp(6),
433                 stateBusy(7),
434                 stateDialingOffHook(8),
435                 statePreRing(9)
436         }
437         MAX-ACCESS      read-only
438         STATUS          current
439         DESCRIPTION
440                 "Channel state."
441         ::= { astChanEntry 23 }
442
443 astChanMuted OBJECT-TYPE
444         SYNTAX          TruthValue
445         MAX-ACCESS      read-only
446         STATUS          current
447         DESCRIPTION
448                 "Transmission of voice data has been muted."
449         ::= { astChanEntry 24 }
450
451 astChanRings OBJECT-TYPE
452         SYNTAX          Integer32
453         MAX-ACCESS      read-only
454         STATUS          current
455         DESCRIPTION
456                 "Number of rings so far."
457         ::= { astChanEntry 25 }
458
459 astChanCidDNID OBJECT-TYPE
460         SYNTAX          DisplayString
461         MAX-ACCESS      read-only
462         STATUS          current
463         DESCRIPTION
464                 "Dialled Number ID."
465         ::= { astChanEntry 26 }
466
467 astChanCidNum OBJECT-TYPE
468         SYNTAX          DisplayString
469         MAX-ACCESS      read-only
470         STATUS          current
471         DESCRIPTION
472                 "Caller Number."
473         ::= { astChanEntry 27 }
474
475 astChanCidName OBJECT-TYPE
476         SYNTAX          DisplayString
477         MAX-ACCESS      read-only
478         STATUS          current
479         DESCRIPTION
480                 "Caller Name."
481         ::= { astChanEntry 28 }
482
483 astCanCidANI OBJECT-TYPE
484         SYNTAX          DisplayString
485         MAX-ACCESS      read-only
486         STATUS          current
487         DESCRIPTION
488                 "ANI"
489         ::= { astChanEntry 29 }
490
491 astChanCidRDNIS OBJECT-TYPE
492         SYNTAX          DisplayString
493         MAX-ACCESS      read-only
494         STATUS          current
495         DESCRIPTION
496                 "Redirected Dialled Number Service."
497         ::= { astChanEntry 30 }
498
499 astChanCidPresentation OBJECT-TYPE
500         SYNTAX          DisplayString
501         MAX-ACCESS      read-only
502         STATUS          current
503         DESCRIPTION
504                 "Number Presentation/Screening."
505         ::= { astChanEntry 31 }
506
507 astChanCidANI2 OBJECT-TYPE
508         SYNTAX          Integer32
509         MAX-ACCESS      read-only
510         STATUS          current
511         DESCRIPTION
512                 "ANI 2 (info digit)."
513         ::= { astChanEntry 32 }
514
515 astChanCidTON OBJECT-TYPE
516         SYNTAX          Integer32
517         MAX-ACCESS      read-only
518         STATUS          current
519         DESCRIPTION
520                 "Type of Number."
521         ::= { astChanEntry 33 }
522
523 astChanCidTNS OBJECT-TYPE
524         SYNTAX          Integer32
525         MAX-ACCESS      read-only
526         STATUS          current
527         DESCRIPTION
528                 "Transit Network Select."
529         ::= { astChanEntry 34 }
530
531 astChanAMAFlags OBJECT-TYPE
532         SYNTAX          INTEGER {
533                 Default(0),
534                 Omit(1),
535                 Billing(2),
536                 Documentation(3)
537         }
538         MAX-ACCESS      read-only
539         STATUS          current
540         DESCRIPTION
541                 "AMA Flags."
542         ::= { astChanEntry 35 }
543
544 astChanADSI OBJECT-TYPE
545         SYNTAX          INTEGER {
546                 Unknown(0),
547                 Available(1),
548                 Unavailable(2),
549                 OffHookOnly(3)
550         }
551         MAX-ACCESS      read-only
552         STATUS          current
553         DESCRIPTION
554                 "Whether or not ADSI is detected on CPE."
555         ::= { astChanEntry 36 }
556
557 astChanToneZone OBJECT-TYPE
558         SYNTAX          DisplayString
559         MAX-ACCESS      read-only
560         STATUS          current
561         DESCRIPTION
562                 "Indication zone to use for channel."
563         ::= { astChanEntry 37 }
564
565 astChanHangupCause OBJECT-TYPE
566         SYNTAX          INTEGER {
567                 NotDefined(0),
568                 Unregistered(3),
569                 Normal(16),
570                 Busy(17),
571                 NoAnswer(19),
572                 Congestion(34),
573                 Failure(38),
574                 NoSuchDriver(66)
575         }
576         MAX-ACCESS      read-only
577         STATUS          current
578         DESCRIPTION
579                 "Why is the channel hung up."
580         ::= { astChanEntry 38 }
581
582 astChanVariables OBJECT-TYPE
583         SYNTAX          DisplayString
584         MAX-ACCESS      read-only
585         STATUS          current
586         DESCRIPTION
587                 "Channel Variables defined for this channel."
588         ::= { astChanEntry 39 }
589
590 astChanFlags OBJECT-TYPE
591         SYNTAX          BITS {
592                 WantsJitter(0),
593                 DeferDTMF(1),
594                 WriteInterrupt(2),
595                 Blocking(3),
596                 Zombie(4),
597                 Exception(5),
598                 MusicOnHold(6),
599                 Spying(7),
600                 NativeBridge(8),
601                 AutoIncrementingLoop(9)
602         }
603         MAX-ACCESS      read-only
604         STATUS          current
605         DESCRIPTION
606                 "Flags set on this channel."
607         ::= { astChanEntry 40 }
608
609 astChanTransferCap OBJECT-TYPE
610         SYNTAX          INTEGER {
611                 Speech(0),
612                 Digital(8),
613                 RestrictedDigital(9),
614                 3kAudio(16),
615                 DigitalWithTones(17),
616                 Video(24)
617         }
618         MAX-ACCESS      read-only
619         STATUS          current
620         DESCRIPTION
621                 "Transfer Capabilities for this channel."
622         ::= { astChanEntry 41 }
623
624 astNumChanTypes OBJECT-TYPE
625         SYNTAX          Integer32
626         MAX-ACCESS      read-only
627         STATUS          current
628         DESCRIPTION
629                 "Number of channel types (technologies) supported."
630         ::= { asteriskChannels 3 }
631
632 astChanTypeTable OBJECT-TYPE
633         SYNTAX          SEQUENCE OF AstChanTypeEntry
634         MAX-ACCESS      not-accessible
635         STATUS          current
636         DESCRIPTION
637                 "Table with details of the supported channel types."
638         ::= { asteriskChannels 4 }
639
640 astChanTypeEntry OBJECT-TYPE
641         SYNTAX          AstChanTypeEntry
642         MAX-ACCESS      not-accessible
643         STATUS          current
644         DESCRIPTION
645                 "Information about a technology we support, including
646                 how many channels are currently using this technology."
647         INDEX           { astChanTypeIndex }
648         ::= { astChanTypeTable 1 }
649
650 AstChanTypeEntry ::= SEQUENCE {
651         astChanTypeIndex        Integer32,
652         astChanTypeName         DisplayString,
653         astChanTypeDesc         DisplayString,
654         astChanTypeDeviceState  Integer32,
655         astChanTypeIndications  Integer32,
656         astChanTypeTransfer     Integer32,
657         astChanTypeChannels     Gauge32
658 }
659
660 astChanTypeIndex OBJECT-TYPE
661         SYNTAX          Integer32
662         MAX-ACCESS      read-only
663         STATUS          current
664         DESCRIPTION
665                 "Index into the table of channel types."
666         ::= { astChanTypeEntry 1 }
667
668 astChanTypeName OBJECT-TYPE
669         SYNTAX          DisplayString
670         MAX-ACCESS      read-only
671         STATUS          current
672         DESCRIPTION
673                 "Unique name of the technology we are describing."
674         ::= { astChanTypeEntry 2 }
675
676 astChanTypeDesc OBJECT-TYPE
677         SYNTAX          DisplayString
678         MAX-ACCESS      read-only
679         STATUS          current
680         DESCRIPTION
681                 "Description of the channel type (technology)."
682         ::= { astChanTypeEntry 3 }
683
684 astChanTypeDeviceState OBJECT-TYPE
685         SYNTAX          TruthValue
686         MAX-ACCESS      read-only
687         STATUS          current
688         DESCRIPTION
689                 "Whether the current technology can hold device states."
690         ::= { astChanTypeEntry 4 }
691
692 astChanTypeIndications OBJECT-TYPE
693         SYNTAX          TruthValue
694         MAX-ACCESS      read-only
695         STATUS          current
696         DESCRIPTION
697                 "Whether the current technology supports progress indication."
698         ::= { astChanTypeEntry 5 }
699
700 astChanTypeTransfer OBJECT-TYPE
701         SYNTAX          TruthValue
702         MAX-ACCESS      read-only
703         STATUS          current
704         DESCRIPTION
705                 "Whether the current technology supports transfers, where
706                 Asterisk can get out from inbetween two bridged channels."
707         ::= { astChanTypeEntry 6 }
708
709 astChanTypeChannels OBJECT-TYPE
710         SYNTAX          Gauge32
711         MAX-ACCESS      read-only
712         STATUS          current
713         DESCRIPTION
714                 "Number of active channels using the current technology."
715         ::= { astChanTypeEntry 7 }
716
717 END