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