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