Merged revisions 72933 via svnmerge from
[asterisk/asterisk.git] / doc / tex / ast_cli_commands.tex
1 % This file is automatically generated by the "core dump clidocs" CLI command.  Any manual edits will be lost.
2 \section{!}
3 \subsection{Summary}
4 \begin{verbatim}
5 Execute a shell command
6 \end{verbatim}
7 \subsection{Usage}
8 \begin{verbatim}
9 Usage: !<command>
10        Executes a given shell command
11
12 \end{verbatim}
13
14
15 \section{abort halt}
16 \subsection{Summary}
17 \begin{verbatim}
18 Cancel a running halt
19 \end{verbatim}
20 \subsection{Usage}
21 \begin{verbatim}
22 Usage: abort shutdown
23        Causes Asterisk to abort an executing shutdown or restart, and resume normal
24        call operations.
25
26 \end{verbatim}
27
28
29 \section{ael debug contexts}
30 \subsection{Summary}
31 \begin{verbatim}
32 Enable AEL contexts debug (does nothing)
33 \end{verbatim}
34 \subsection{Usage}
35 \begin{verbatim}
36 (null)
37 \end{verbatim}
38
39
40 \section{ael debug macros}
41 \subsection{Summary}
42 \begin{verbatim}
43 Enable AEL macros debug (does nothing)
44 \end{verbatim}
45 \subsection{Usage}
46 \begin{verbatim}
47 (null)
48 \end{verbatim}
49
50
51 \section{ael debug read}
52 \subsection{Summary}
53 \begin{verbatim}
54 Enable AEL read debug (does nothing)
55 \end{verbatim}
56 \subsection{Usage}
57 \begin{verbatim}
58 (null)
59 \end{verbatim}
60
61
62 \section{ael debug tokens}
63 \subsection{Summary}
64 \begin{verbatim}
65 Enable AEL tokens debug (does nothing)
66 \end{verbatim}
67 \subsection{Usage}
68 \begin{verbatim}
69 (null)
70 \end{verbatim}
71
72
73 \section{ael nodebug}
74 \subsection{Summary}
75 \begin{verbatim}
76 Disable AEL debug messages
77 \end{verbatim}
78 \subsection{Usage}
79 \begin{verbatim}
80 (null)
81 \end{verbatim}
82
83
84 \section{ael reload}
85 \subsection{Summary}
86 \begin{verbatim}
87 Reload AEL configuration
88 \end{verbatim}
89 \subsection{Usage}
90 \begin{verbatim}
91 (null)
92 \end{verbatim}
93
94
95 \section{agent logoff}
96 \subsection{Summary}
97 \begin{verbatim}
98 Sets an agent offline
99 \end{verbatim}
100 \subsection{Usage}
101 \begin{verbatim}
102 Usage: agent logoff <channel> [soft]
103        Sets an agent as no longer logged in.
104        If 'soft' is specified, do not hangup existing calls.
105
106 \end{verbatim}
107
108
109 \section{agent show}
110 \subsection{Summary}
111 \begin{verbatim}
112 Show status of agents
113 \end{verbatim}
114 \subsection{Usage}
115 \begin{verbatim}
116 Usage: agent show
117        Provides summary information on agents.
118
119 \end{verbatim}
120
121
122 \section{agent show online}
123 \subsection{Summary}
124 \begin{verbatim}
125 Show all online agents
126 \end{verbatim}
127 \subsection{Usage}
128 \begin{verbatim}
129 Usage: agent show online
130         Provides a list of all online agents.
131
132 \end{verbatim}
133
134
135 \section{agi debug}
136 \subsection{Summary}
137 \begin{verbatim}
138 Enable AGI debugging
139 \end{verbatim}
140 \subsection{Usage}
141 \begin{verbatim}
142 Usage: agi debug
143        Enables dumping of AGI transactions for debugging purposes
144
145 \end{verbatim}
146
147
148 \section{agi debug off}
149 \subsection{Summary}
150 \begin{verbatim}
151 Disable AGI debugging
152 \end{verbatim}
153 \subsection{Usage}
154 \begin{verbatim}
155 Usage: agi debug off
156        Disables dumping of AGI transactions for debugging purposes
157
158 \end{verbatim}
159
160
161 \section{agi dump commanddocs}
162 \subsection{Summary}
163 \begin{verbatim}
164 Dump agi command documentation in LaTeX format
165 \end{verbatim}
166 \subsection{Usage}
167 \begin{verbatim}
168 Usage: agi dump commanddocs [command]
169        Dump manager action documentation to /tmp/ast_agi_commands.tex.
170
171 \end{verbatim}
172
173
174 \section{agi dumphtml}
175 \subsection{Summary}
176 \begin{verbatim}
177 Dumps a list of agi commands in html format
178 \end{verbatim}
179 \subsection{Usage}
180 \begin{verbatim}
181 Usage: agi dumphtml <filename>
182         Dumps the agi command list in html format to given filename
183
184 \end{verbatim}
185
186
187 \section{agi show}
188 \subsection{Summary}
189 \begin{verbatim}
190 List AGI commands or specific help
191 \end{verbatim}
192 \subsection{Usage}
193 \begin{verbatim}
194 Usage: agi show [topic]
195        When called with a topic as an argument, displays usage
196        information on the given command.  If called without a
197        topic, it provides a list of AGI commands.
198
199 \end{verbatim}
200
201
202 \section{cdr status}
203 \subsection{Summary}
204 \begin{verbatim}
205 Display the CDR status
206 \end{verbatim}
207 \subsection{Usage}
208 \begin{verbatim}
209 Usage: cdr status
210         Displays the Call Detail Record engine system status.
211
212 \end{verbatim}
213
214
215 \section{console active}
216 \subsection{Summary}
217 \begin{verbatim}
218 Sets/displays active console
219 \end{verbatim}
220 \subsection{Usage}
221 \begin{verbatim}
222 Usage: console active [device]
223        If used without a parameter, displays which device is the current
224 console.  If a device is specified, the console sound device is changed to
225 the device specified.
226
227 \end{verbatim}
228
229
230 \section{console answer}
231 \subsection{Summary}
232 \begin{verbatim}
233 Answer an incoming console call
234 \end{verbatim}
235 \subsection{Usage}
236 \begin{verbatim}
237 Usage: console answer
238        Answers an incoming call on the console (OSS) channel.
239
240 \end{verbatim}
241
242
243 \section{console autoanswer [on|off]}
244 \subsection{Summary}
245 \begin{verbatim}
246 Sets/displays autoanswer
247 \end{verbatim}
248 \subsection{Usage}
249 \begin{verbatim}
250 Usage: console autoanswer [on|off]
251        Enables or disables autoanswer feature.  If used without
252        argument, displays the current on/off status of autoanswer.
253        The default value of autoanswer is in 'oss.conf'.
254
255 \end{verbatim}
256
257
258 \section{console boost}
259 \subsection{Summary}
260 \begin{verbatim}
261 Sets/displays mic boost in dB
262 \end{verbatim}
263 \subsection{Usage}
264 \begin{verbatim}
265 (null)
266 \end{verbatim}
267
268
269 \section{console dial}
270 \subsection{Summary}
271 \begin{verbatim}
272 Dial an extension on the console
273 \end{verbatim}
274 \subsection{Usage}
275 \begin{verbatim}
276 Usage: console dial [extension[@context]]
277        Dials a given extension (and context if specified)
278
279 \end{verbatim}
280
281
282 \section{console flash}
283 \subsection{Summary}
284 \begin{verbatim}
285 Flash a call on the console
286 \end{verbatim}
287 \subsection{Usage}
288 \begin{verbatim}
289 Usage: console flash
290        Flashes the call currently placed on the console.
291
292 \end{verbatim}
293
294
295 \section{console hangup}
296 \subsection{Summary}
297 \begin{verbatim}
298 Hangup a call on the console
299 \end{verbatim}
300 \subsection{Usage}
301 \begin{verbatim}
302 Usage: console hangup
303        Hangs up any call currently placed on the console.
304
305 \end{verbatim}
306
307
308 \section{console {mute|unmute}}
309 \subsection{Summary}
310 \begin{verbatim}
311 Disable/Enable mic input
312 \end{verbatim}
313 \subsection{Usage}
314 \begin{verbatim}
315 Usage: console {mute|unmute}
316        Mute/unmute the microphone.
317
318 \end{verbatim}
319
320
321 \section{console send text}
322 \subsection{Summary}
323 \begin{verbatim}
324 Send text to the remote device
325 \end{verbatim}
326 \subsection{Usage}
327 \begin{verbatim}
328 Usage: console send text <message>
329        Sends a text message for display on the remote terminal.
330
331 \end{verbatim}
332
333
334 \section{console transfer}
335 \subsection{Summary}
336 \begin{verbatim}
337 Transfer a call to a different extension
338 \end{verbatim}
339 \subsection{Usage}
340 \begin{verbatim}
341 Usage: console transfer <extension>[@context]
342        Transfers the currently connected call to the given extension (and
343 context if specified)
344
345 \end{verbatim}
346
347
348 \section{core clear profile}
349 \subsection{Summary}
350 \begin{verbatim}
351 Clear profiling info
352 \end{verbatim}
353 \subsection{Usage}
354 \begin{verbatim}
355 (null)
356 \end{verbatim}
357
358
359 \section{core dump appdocs}
360 \subsection{Summary}
361 \begin{verbatim}
362 Dump application documentation in LaTeX format
363 \end{verbatim}
364 \subsection{Usage}
365 \begin{verbatim}
366 Usage: core dump appdocs [application]
367        Dump Application documentation to /tmp/ast_appdocs.tex.
368
369 \end{verbatim}
370
371
372 \section{core dump clidocs}
373 \subsection{Summary}
374 \begin{verbatim}
375 Dump CLI command documentation in LaTeX format
376 \end{verbatim}
377 \subsection{Usage}
378 \begin{verbatim}
379 Usage: core dump clidocs
380        Dump CLI command documentation to /tmp/ast_cli_commands.tex.
381
382 \end{verbatim}
383
384
385 \section{core dump funcdocs}
386 \subsection{Summary}
387 \begin{verbatim}
388 Dump function documentation in LaTeX format
389 \end{verbatim}
390 \subsection{Usage}
391 \begin{verbatim}
392 Usage: core dump funcdocs [function]
393        Dump Application documentation to /tmp/ast_funcdocs.tex.
394
395 \end{verbatim}
396
397
398 \section{core set debug channel}
399 \subsection{Summary}
400 \begin{verbatim}
401 Enable/disable debugging on a channel
402 \end{verbatim}
403 \subsection{Usage}
404 \begin{verbatim}
405 Usage: core set debug channel <all|channel> [off]
406        Enables/disables debugging on all or on a specific channel.
407
408 \end{verbatim}
409
410
411 \section{core set {debug|verbose} [off|atleast]}
412 \subsection{Summary}
413 \begin{verbatim}
414 Set level of debug/verbose chattiness
415 \end{verbatim}
416 \subsection{Usage}
417 \begin{verbatim}
418 Usage: core set {debug|verbose} [atleast] <level>
419        core set {debug|verbose} off
420        Sets level of debug or verbose messages to be displayed.
421         0 or off means no messages should be displayed.
422         Equivalent to -d[d[...]] or -v[v[v...]] on startup
423
424 \end{verbatim}
425
426
427 \section{core set global}
428 \subsection{Summary}
429 \begin{verbatim}
430 Set global dialplan variable
431 \end{verbatim}
432 \subsection{Usage}
433 \begin{verbatim}
434 Usage: core set global <name> <value>
435        Set global dialplan variable <name> to <value>
436
437 \end{verbatim}
438
439
440 \section{core show applications}
441 \subsection{Summary}
442 \begin{verbatim}
443 Shows registered dialplan applications
444 \end{verbatim}
445 \subsection{Usage}
446 \begin{verbatim}
447 Usage: core show applications [{like|describing} <text>]
448        List applications which are currently available.
449        If 'like', <text> will be a substring of the app name
450        If 'describing', <text> will be a substring of the description
451
452 \end{verbatim}
453
454
455 \section{core show application}
456 \subsection{Summary}
457 \begin{verbatim}
458 Describe a specific dialplan application
459 \end{verbatim}
460 \subsection{Usage}
461 \begin{verbatim}
462 Usage: core show application <application> [<application> [<application> [...]]]
463        Describes a particular application.
464
465 \end{verbatim}
466
467
468 \section{core show channels [concise|verbose|count]}
469 \subsection{Summary}
470 \begin{verbatim}
471 Display information on channels
472 \end{verbatim}
473 \subsection{Usage}
474 \begin{verbatim}
475 Usage: core show channels [concise|verbose|count]
476        Lists currently defined channels and some information about them. If
477        'concise' is specified, the format is abridged and in a more easily
478        machine parsable format. If 'verbose' is specified, the output includes
479        more and longer fields. If 'count' is specified only the channel and call
480        count is output.
481
482 \end{verbatim}
483
484
485 \section{core show channel}
486 \subsection{Summary}
487 \begin{verbatim}
488 Display information on a specific channel
489 \end{verbatim}
490 \subsection{Usage}
491 \begin{verbatim}
492 Usage: core show channel <channel>
493        Shows lots of information about the specified channel.
494
495 \end{verbatim}
496
497
498 \section{core show channeltypes}
499 \subsection{Summary}
500 \begin{verbatim}
501 List available channel types
502 \end{verbatim}
503 \subsection{Usage}
504 \begin{verbatim}
505 Usage: core show channeltypes
506        Lists available channel types registered in your Asterisk server.
507
508 \end{verbatim}
509
510
511 \section{core show channeltype}
512 \subsection{Summary}
513 \begin{verbatim}
514 Give more details on that channel type
515 \end{verbatim}
516 \subsection{Usage}
517 \begin{verbatim}
518 Usage: core show channeltype <name>
519         Show details about the specified channel type, <name>.
520
521 \end{verbatim}
522
523
524 \section{core show codecs}
525 \subsection{Summary}
526 \begin{verbatim}
527 Displays a list of codecs
528 \end{verbatim}
529 \subsection{Usage}
530 \begin{verbatim}
531 Usage: core show codecs [audio|video|image]
532        Displays codec mapping
533
534 \end{verbatim}
535
536
537 \section{core show codecs audio}
538 \subsection{Summary}
539 \begin{verbatim}
540 Displays a list of audio codecs
541 \end{verbatim}
542 \subsection{Usage}
543 \begin{verbatim}
544 Usage: core show codecs [audio|video|image]
545        Displays codec mapping
546
547 \end{verbatim}
548
549
550 \section{core show codecs image}
551 \subsection{Summary}
552 \begin{verbatim}
553 Displays a list of image codecs
554 \end{verbatim}
555 \subsection{Usage}
556 \begin{verbatim}
557 Usage: core show codecs [audio|video|image]
558        Displays codec mapping
559
560 \end{verbatim}
561
562
563 \section{core show codecs video}
564 \subsection{Summary}
565 \begin{verbatim}
566 Displays a list of video codecs
567 \end{verbatim}
568 \subsection{Usage}
569 \begin{verbatim}
570 Usage: core show codecs [audio|video|image]
571        Displays codec mapping
572
573 \end{verbatim}
574
575
576 \section{core show codec}
577 \subsection{Summary}
578 \begin{verbatim}
579 Shows a specific codec
580 \end{verbatim}
581 \subsection{Usage}
582 \begin{verbatim}
583 Usage: core show codec <number>
584        Displays codec mapping
585
586 \end{verbatim}
587
588
589 \section{core show config mappings}
590 \subsection{Summary}
591 \begin{verbatim}
592 Display config mappings (file names to config engines)
593 \end{verbatim}
594 \subsection{Usage}
595 \begin{verbatim}
596 Usage: core show config mappings
597         Shows the filenames to config engines.
598
599 \end{verbatim}
600
601
602 \section{core show file formats}
603 \subsection{Summary}
604 \begin{verbatim}
605 Displays file formats
606 \end{verbatim}
607 \subsection{Usage}
608 \begin{verbatim}
609 Usage: core show file formats
610        Displays currently registered file formats (if any)
611
612 \end{verbatim}
613
614
615 \section{core show file version}
616 \subsection{Summary}
617 \begin{verbatim}
618 List versions of files used to build Asterisk
619 \end{verbatim}
620 \subsection{Usage}
621 \begin{verbatim}
622 Usage: core show file version [like <pattern>]
623        Lists the revision numbers of the files used to build this copy of Asterisk.
624        Optional regular expression pattern is used to filter the file list.
625
626 \end{verbatim}
627
628
629 \section{core show functions}
630 \subsection{Summary}
631 \begin{verbatim}
632 Shows registered dialplan functions
633 \end{verbatim}
634 \subsection{Usage}
635 \begin{verbatim}
636 Usage: core show functions [like <text>]
637        List builtin functions, optionally only those matching a given string
638
639 \end{verbatim}
640
641
642 \section{core show function}
643 \subsection{Summary}
644 \begin{verbatim}
645 Describe a specific dialplan function
646 \end{verbatim}
647 \subsection{Usage}
648 \begin{verbatim}
649 Usage: core show function <function>
650        Describe a particular dialplan function.
651
652 \end{verbatim}
653
654
655 \section{core show globals}
656 \subsection{Summary}
657 \begin{verbatim}
658 Show global dialplan variables
659 \end{verbatim}
660 \subsection{Usage}
661 \begin{verbatim}
662 Usage: core show globals
663        List current global dialplan variables and their values
664
665 \end{verbatim}
666
667
668 \section{core show hints}
669 \subsection{Summary}
670 \begin{verbatim}
671 Show dialplan hints
672 \end{verbatim}
673 \subsection{Usage}
674 \begin{verbatim}
675 Usage: core show hints
676        List registered hints
677
678 \end{verbatim}
679
680
681 \section{core show image formats}
682 \subsection{Summary}
683 \begin{verbatim}
684 Displays image formats
685 \end{verbatim}
686 \subsection{Usage}
687 \begin{verbatim}
688 Usage: core show image formats
689        displays currently registered image formats (if any)
690
691 \end{verbatim}
692
693
694 \section{core show license}
695 \subsection{Summary}
696 \begin{verbatim}
697 Show the license(s) for this copy of Asterisk
698 \end{verbatim}
699 \subsection{Usage}
700 \begin{verbatim}
701 Usage: core show license
702        Shows the license(s) for this copy of Asterisk.
703
704 \end{verbatim}
705
706
707 \section{core show profile}
708 \subsection{Summary}
709 \begin{verbatim}
710 Display profiling info
711 \end{verbatim}
712 \subsection{Usage}
713 \begin{verbatim}
714 (null)
715 \end{verbatim}
716
717
718 \section{core show settings}
719 \subsection{Summary}
720 \begin{verbatim}
721 Show some core settings
722 \end{verbatim}
723 \subsection{Usage}
724 \begin{verbatim}
725 (null)
726 \end{verbatim}
727
728
729 \section{core show switches}
730 \subsection{Summary}
731 \begin{verbatim}
732 Show alternative switches
733 \end{verbatim}
734 \subsection{Usage}
735 \begin{verbatim}
736 Usage: core show switches
737        List registered switches
738
739 \end{verbatim}
740
741
742 \section{core show sysinfo}
743 \subsection{Summary}
744 \begin{verbatim}
745 Show System Information
746 \end{verbatim}
747 \subsection{Usage}
748 \begin{verbatim}
749 Usage: core show sysinfo
750        List current system information.
751
752 \end{verbatim}
753
754
755 \section{core show threads}
756 \subsection{Summary}
757 \begin{verbatim}
758 Show running threads
759 \end{verbatim}
760 \subsection{Usage}
761 \begin{verbatim}
762 Usage: core show threads
763        List threads currently active in the system.
764
765 \end{verbatim}
766
767
768 \section{core show translation}
769 \subsection{Summary}
770 \begin{verbatim}
771 Display translation matrix
772 \end{verbatim}
773 \subsection{Usage}
774 \begin{verbatim}
775 Usage: core show translation [recalc] [<recalc seconds>]
776        Displays known codec translators and the cost associated
777 with each conversion.  If the argument 'recalc' is supplied along
778 with optional number of seconds to test a new test will be performed
779 as the chart is being displayed.
780
781 \end{verbatim}
782
783
784 \section{core show uptime [seconds]}
785 \subsection{Summary}
786 \begin{verbatim}
787 Show uptime information
788 \end{verbatim}
789 \subsection{Usage}
790 \begin{verbatim}
791 Usage: core show uptime [seconds]
792        Shows Asterisk uptime information.
793        The seconds word returns the uptime in seconds only.
794
795 \end{verbatim}
796
797
798 \section{core show version}
799 \subsection{Summary}
800 \begin{verbatim}
801 Display version info
802 \end{verbatim}
803 \subsection{Usage}
804 \begin{verbatim}
805 Usage: core show version
806        Shows Asterisk version information.
807
808 \end{verbatim}
809
810
811 \section{core show warranty}
812 \subsection{Summary}
813 \begin{verbatim}
814 Show the warranty (if any) for this copy of Asterisk
815 \end{verbatim}
816 \subsection{Usage}
817 \begin{verbatim}
818 Usage: core show warranty
819        Shows the warranty (if any) for this copy of Asterisk.
820
821 \end{verbatim}
822
823
824 \section{database del}
825 \subsection{Summary}
826 \begin{verbatim}
827 Removes database key/value
828 \end{verbatim}
829 \subsection{Usage}
830 \begin{verbatim}
831 Usage: database del <family> <key>
832        Deletes an entry in the Asterisk database for a given
833 family and key.
834
835 \end{verbatim}
836
837
838 \section{database deltree}
839 \subsection{Summary}
840 \begin{verbatim}
841 Removes database keytree/values
842 \end{verbatim}
843 \subsection{Usage}
844 \begin{verbatim}
845 Usage: database deltree <family> [keytree]
846        Deletes a family or specific keytree within a family
847 in the Asterisk database.
848
849 \end{verbatim}
850
851
852 \section{database get}
853 \subsection{Summary}
854 \begin{verbatim}
855 Gets database value
856 \end{verbatim}
857 \subsection{Usage}
858 \begin{verbatim}
859 Usage: database get <family> <key>
860        Retrieves an entry in the Asterisk database for a given
861 family and key.
862
863 \end{verbatim}
864
865
866 \section{database put}
867 \subsection{Summary}
868 \begin{verbatim}
869 Adds/updates database value
870 \end{verbatim}
871 \subsection{Usage}
872 \begin{verbatim}
873 Usage: database put <family> <key> <value>
874        Adds or updates an entry in the Asterisk database for
875 a given family, key, and value.
876
877 \end{verbatim}
878
879
880 \section{database show}
881 \subsection{Summary}
882 \begin{verbatim}
883 Shows database contents
884 \end{verbatim}
885 \subsection{Usage}
886 \begin{verbatim}
887 Usage: database show [family [keytree]]
888        Shows Asterisk database contents, optionally restricted
889 to a given family, or family and keytree.
890
891 \end{verbatim}
892
893
894 \section{database showkey}
895 \subsection{Summary}
896 \begin{verbatim}
897 Shows database contents
898 \end{verbatim}
899 \subsection{Usage}
900 \begin{verbatim}
901 Usage: database showkey <keytree>
902        Shows Asterisk database contents, restricted to a given key.
903
904 \end{verbatim}
905
906
907 \section{dialplan add extension}
908 \subsection{Summary}
909 \begin{verbatim}
910 Add new extension into context
911 \end{verbatim}
912 \subsection{Usage}
913 \begin{verbatim}
914 Usage: dialplan add extension <exten>,<priority>,<app>,<app-data>
915        into <context> [replace]
916
917        This command will add new extension into <context>. If there is an
918        existence of extension with the same priority and last 'replace'
919        arguments is given here we simply replace this extension.
920
921 Example: dialplan add extension 6123,1,Dial,IAX/216.207.245.56/6123 into local
922          Now, you can dial 6123 and talk to Markster :)
923
924 \end{verbatim}
925
926
927 \section{dialplan add ignorepat}
928 \subsection{Summary}
929 \begin{verbatim}
930 Add new ignore pattern
931 \end{verbatim}
932 \subsection{Usage}
933 \begin{verbatim}
934 Usage: dialplan add ignorepat <pattern> into <context>
935        This command adds a new ignore pattern into context <context>
936
937 Example: dialplan add ignorepat _3XX into local
938
939 \end{verbatim}
940
941
942 \section{dialplan add include}
943 \subsection{Summary}
944 \begin{verbatim}
945 Include context in other context
946 \end{verbatim}
947 \subsection{Usage}
948 \begin{verbatim}
949 Usage: dialplan add include <context> into <context>
950        Include a context in another context.
951
952 \end{verbatim}
953
954
955 \section{dialplan reload}
956 \subsection{Summary}
957 \begin{verbatim}
958 Reload extensions and *only* extensions
959 \end{verbatim}
960 \subsection{Usage}
961 \begin{verbatim}
962 Usage: dialplan reload
963        reload extensions.conf without reloading any other modules
964        This command does not delete global variables unless
965        clearglobalvars is set to yes in extensions.conf
966
967 \end{verbatim}
968
969
970 \section{dialplan remove extension}
971 \subsection{Summary}
972 \begin{verbatim}
973 Remove a specified extension
974 \end{verbatim}
975 \subsection{Usage}
976 \begin{verbatim}
977 Usage: dialplan remove extension exten@context [priority]
978        Remove an extension from a given context. If a priority
979        is given, only that specific priority from the given extension
980        will be removed.
981
982 \end{verbatim}
983
984
985 \section{dialplan remove ignorepat}
986 \subsection{Summary}
987 \begin{verbatim}
988 Remove ignore pattern from context
989 \end{verbatim}
990 \subsection{Usage}
991 \begin{verbatim}
992 Usage: dialplan remove ignorepat <pattern> from <context>
993        This command removes an ignore pattern from context <context>
994
995 Example: dialplan remove ignorepat _3XX from local
996
997 \end{verbatim}
998
999
1000 \section{dialplan remove include}
1001 \subsection{Summary}
1002 \begin{verbatim}
1003 Remove a specified include from context
1004 \end{verbatim}
1005 \subsection{Usage}
1006 \begin{verbatim}
1007 Usage: dialplan remove include <context> from <context>
1008        Remove an included context from another context.
1009
1010 \end{verbatim}
1011
1012
1013 \section{dialplan save}
1014 \subsection{Summary}
1015 \begin{verbatim}
1016 Save dialplan
1017 \end{verbatim}
1018 \subsection{Usage}
1019 \begin{verbatim}
1020 Usage: dialplan save [/path/to/extension/file]
1021        Save dialplan created by pbx_config module.
1022
1023 Example: dialplan save                 (/etc/asterisk/extensions.conf)
1024          dialplan save /home/markster  (/home/markster/extensions.conf)
1025
1026 \end{verbatim}
1027
1028
1029 \section{dialplan show}
1030 \subsection{Summary}
1031 \begin{verbatim}
1032 Show dialplan
1033 \end{verbatim}
1034 \subsection{Usage}
1035 \begin{verbatim}
1036 Usage: core show dialplan [exten@][context]
1037        Show dialplan
1038
1039 \end{verbatim}
1040
1041
1042 \section{dnsmgr reload}
1043 \subsection{Summary}
1044 \begin{verbatim}
1045 Reloads the DNS manager configuration
1046 \end{verbatim}
1047 \subsection{Usage}
1048 \begin{verbatim}
1049 Usage: dnsmgr reload
1050        Reloads the DNS manager configuration.
1051
1052 \end{verbatim}
1053
1054
1055 \section{dnsmgr status}
1056 \subsection{Summary}
1057 \begin{verbatim}
1058 Display the DNS manager status
1059 \end{verbatim}
1060 \subsection{Usage}
1061 \begin{verbatim}
1062 Usage: dnsmgr status
1063        Displays the DNS manager status.
1064
1065 \end{verbatim}
1066
1067
1068 \section{dundi debug}
1069 \subsection{Summary}
1070 \begin{verbatim}
1071 Enable DUNDi debugging
1072 \end{verbatim}
1073 \subsection{Usage}
1074 \begin{verbatim}
1075 Usage: dundi debug
1076        Enables dumping of DUNDi packets for debugging purposes
1077
1078 \end{verbatim}
1079
1080
1081 \section{dundi flush}
1082 \subsection{Summary}
1083 \begin{verbatim}
1084 Flush DUNDi cache
1085 \end{verbatim}
1086 \subsection{Usage}
1087 \begin{verbatim}
1088 Usage: dundi flush [stats]
1089        Flushes DUNDi answer cache, used primarily for debug.  If
1090 'stats' is present, clears timer statistics instead of normal
1091 operation.
1092
1093 \end{verbatim}
1094
1095
1096 \section{dundi lookup}
1097 \subsection{Summary}
1098 \begin{verbatim}
1099 Lookup a number in DUNDi
1100 \end{verbatim}
1101 \subsection{Usage}
1102 \begin{verbatim}
1103 Usage: dundi lookup <number>[@context] [bypass]
1104        Lookup the given number within the given DUNDi context
1105 (or e164 if none is specified).  Bypasses cache if 'bypass'
1106 keyword is specified.
1107
1108 \end{verbatim}
1109
1110
1111 \section{dundi no debug}
1112 \subsection{Summary}
1113 \begin{verbatim}
1114 Disable DUNDi debugging
1115 \end{verbatim}
1116 \subsection{Usage}
1117 \begin{verbatim}
1118 Usage: dundi no debug
1119        Disables dumping of DUNDi packets for debugging purposes
1120
1121 \end{verbatim}
1122
1123
1124 \section{dundi no store history}
1125 \subsection{Summary}
1126 \begin{verbatim}
1127 Disable DUNDi historic records
1128 \end{verbatim}
1129 \subsection{Usage}
1130 \begin{verbatim}
1131 Usage: dundi no store history
1132        Disables storing of DUNDi requests and times for debugging
1133 purposes
1134
1135 \end{verbatim}
1136
1137
1138 \section{dundi precache}
1139 \subsection{Summary}
1140 \begin{verbatim}
1141 Precache a number in DUNDi
1142 \end{verbatim}
1143 \subsection{Usage}
1144 \begin{verbatim}
1145 Usage: dundi precache <number>[@context]
1146        Lookup the given number within the given DUNDi context
1147 (or e164 if none is specified) and precaches the results to any
1148 upstream DUNDi push servers.
1149
1150 \end{verbatim}
1151
1152
1153 \section{dundi query}
1154 \subsection{Summary}
1155 \begin{verbatim}
1156 Query a DUNDi EID
1157 \end{verbatim}
1158 \subsection{Usage}
1159 \begin{verbatim}
1160 Usage: dundi query <entity>[@context]
1161        Attempts to retrieve contact information for a specific
1162 DUNDi entity identifier (EID) within a given DUNDi context (or
1163 e164 if none is specified).
1164
1165 \end{verbatim}
1166
1167
1168 \section{dundi show entityid}
1169 \subsection{Summary}
1170 \begin{verbatim}
1171 Display Global Entity ID
1172 \end{verbatim}
1173 \subsection{Usage}
1174 \begin{verbatim}
1175 Usage: dundi show entityid
1176        Displays the global entityid for this host.
1177
1178 \end{verbatim}
1179
1180
1181 \section{dundi show mappings}
1182 \subsection{Summary}
1183 \begin{verbatim}
1184 Show DUNDi mappings
1185 \end{verbatim}
1186 \subsection{Usage}
1187 \begin{verbatim}
1188 Usage: dundi show mappings
1189        Lists all known DUNDi mappings.
1190
1191 \end{verbatim}
1192
1193
1194 \section{dundi show peers}
1195 \subsection{Summary}
1196 \begin{verbatim}
1197 Show defined DUNDi peers
1198 \end{verbatim}
1199 \subsection{Usage}
1200 \begin{verbatim}
1201 Usage: dundi show peers
1202        Lists all known DUNDi peers.
1203
1204 \end{verbatim}
1205
1206
1207 \section{dundi show peer}
1208 \subsection{Summary}
1209 \begin{verbatim}
1210 Show info on a specific DUNDi peer
1211 \end{verbatim}
1212 \subsection{Usage}
1213 \begin{verbatim}
1214 Usage: dundi show peer [peer]
1215        Provide a detailed description of a specifid DUNDi peer.
1216
1217 \end{verbatim}
1218
1219
1220 \section{dundi show precache}
1221 \subsection{Summary}
1222 \begin{verbatim}
1223 Show DUNDi precache
1224 \end{verbatim}
1225 \subsection{Usage}
1226 \begin{verbatim}
1227 Usage: dundi show precache
1228        Lists all known DUNDi scheduled precache updates.
1229
1230 \end{verbatim}
1231
1232
1233 \section{dundi show requests}
1234 \subsection{Summary}
1235 \begin{verbatim}
1236 Show DUNDi requests
1237 \end{verbatim}
1238 \subsection{Usage}
1239 \begin{verbatim}
1240 Usage: dundi show requests
1241        Lists all known pending DUNDi requests.
1242
1243 \end{verbatim}
1244
1245
1246 \section{dundi show trans}
1247 \subsection{Summary}
1248 \begin{verbatim}
1249 Show active DUNDi transactions
1250 \end{verbatim}
1251 \subsection{Usage}
1252 \begin{verbatim}
1253 Usage: dundi show trans
1254        Lists all known DUNDi transactions.
1255
1256 \end{verbatim}
1257
1258
1259 \section{dundi store history}
1260 \subsection{Summary}
1261 \begin{verbatim}
1262 Enable DUNDi historic records
1263 \end{verbatim}
1264 \subsection{Usage}
1265 \begin{verbatim}
1266 Usage: dundi store history
1267        Enables storing of DUNDi requests and times for debugging
1268 purposes
1269
1270 \end{verbatim}
1271
1272
1273 \section{feature show}
1274 \subsection{Summary}
1275 \begin{verbatim}
1276 Lists configured features
1277 \end{verbatim}
1278 \subsection{Usage}
1279 \begin{verbatim}
1280 Usage: feature list
1281        Lists currently configured features.
1282
1283 \end{verbatim}
1284
1285
1286 \section{file convert}
1287 \subsection{Summary}
1288 \begin{verbatim}
1289 Convert audio file
1290 \end{verbatim}
1291 \subsection{Usage}
1292 \begin{verbatim}
1293 Usage: file convert <file_in> <file_out>
1294     Convert from file_in to file_out. If an absolute path is not given, the
1295 default Asterisk sounds directory will be used.
1296
1297 Example:
1298     file convert tt-weasels.gsm tt-weasels.ulaw
1299
1300 \end{verbatim}
1301
1302
1303 \section{funcdevstate list}
1304 \subsection{Summary}
1305 \begin{verbatim}
1306 List currently known custom device states
1307 \end{verbatim}
1308 \subsection{Usage}
1309 \begin{verbatim}
1310 Usage: funcdevstate list
1311        List all custom device states that have been set by using
1312        the DEVSTATE dialplan function.
1313
1314 \end{verbatim}
1315
1316
1317 \section{group show channels}
1318 \subsection{Summary}
1319 \begin{verbatim}
1320 Display active channels with group(s)
1321 \end{verbatim}
1322 \subsection{Usage}
1323 \begin{verbatim}
1324 Usage: group show channels [pattern]
1325        Lists all currently active channels with channel group(s) specified.
1326        Optional regular expression pattern is matched to group names for each
1327        channel.
1328
1329 \end{verbatim}
1330
1331
1332 \section{gtalk reload}
1333 \subsection{Summary}
1334 \begin{verbatim}
1335 Enable Jabber debugging
1336 \end{verbatim}
1337 \subsection{Usage}
1338 \begin{verbatim}
1339 Usage: gtalk reload
1340        Reload gtalk channel driver.
1341
1342 \end{verbatim}
1343
1344
1345 \section{gtalk show channels}
1346 \subsection{Summary}
1347 \begin{verbatim}
1348 Show GoogleTalk Channels
1349 \end{verbatim}
1350 \subsection{Usage}
1351 \begin{verbatim}
1352 Usage: gtalk show channels
1353        Shows current state of the Gtalk channels.
1354
1355 \end{verbatim}
1356
1357
1358 \section{h323 cycle gk}
1359 \subsection{Summary}
1360 \begin{verbatim}
1361 Manually re-register with the Gatekeper
1362 \end{verbatim}
1363 \subsection{Usage}
1364 \begin{verbatim}
1365 Usage: h323 gk cycle
1366        Manually re-register with the Gatekeper (Currently Disabled)
1367
1368 \end{verbatim}
1369
1370
1371 \section{h323 hangup}
1372 \subsection{Summary}
1373 \begin{verbatim}
1374 Manually try to hang up a call
1375 \end{verbatim}
1376 \subsection{Usage}
1377 \begin{verbatim}
1378 Usage: h323 hangup <token>
1379        Manually try to hang up call identified by <token>
1380
1381 \end{verbatim}
1382
1383
1384 \section{h323 reload}
1385 \subsection{Summary}
1386 \begin{verbatim}
1387 Reload H.323 configuration
1388 \end{verbatim}
1389 \subsection{Usage}
1390 \begin{verbatim}
1391 Usage: h323 reload
1392        Reloads H.323 configuration from h323.conf
1393
1394 \end{verbatim}
1395
1396
1397 \section{h323 set debug}
1398 \subsection{Summary}
1399 \begin{verbatim}
1400 Enable H.323 debug
1401 \end{verbatim}
1402 \subsection{Usage}
1403 \begin{verbatim}
1404 Usage: h323 debug
1405        Enables H.323 debug output
1406
1407 \end{verbatim}
1408
1409
1410 \section{h323 set debug off}
1411 \subsection{Summary}
1412 \begin{verbatim}
1413 Disable H.323 debug
1414 \end{verbatim}
1415 \subsection{Usage}
1416 \begin{verbatim}
1417 Usage: h323 no debug
1418        Disables H.323 debug output
1419
1420 \end{verbatim}
1421
1422
1423 \section{h323 set trace}
1424 \subsection{Summary}
1425 \begin{verbatim}
1426 Enable H.323 Stack Tracing
1427 \end{verbatim}
1428 \subsection{Usage}
1429 \begin{verbatim}
1430 Usage: h323 trace <level num>
1431        Enables H.323 stack tracing for debugging purposes
1432
1433 \end{verbatim}
1434
1435
1436 \section{h323 set trace off}
1437 \subsection{Summary}
1438 \begin{verbatim}
1439 Disable H.323 Stack Tracing
1440 \end{verbatim}
1441 \subsection{Usage}
1442 \begin{verbatim}
1443 Usage: h323 no trace
1444        Disables H.323 stack tracing for debugging purposes
1445
1446 \end{verbatim}
1447
1448
1449 \section{h323 show tokens}
1450 \subsection{Summary}
1451 \begin{verbatim}
1452 Show all active call tokens
1453 \end{verbatim}
1454 \subsection{Usage}
1455 \begin{verbatim}
1456 Usage: h323 show tokens
1457        Print out all active call tokens
1458
1459 \end{verbatim}
1460
1461
1462 \section{help}
1463 \subsection{Summary}
1464 \begin{verbatim}
1465 Display help list, or specific help on a command
1466 \end{verbatim}
1467 \subsection{Usage}
1468 \begin{verbatim}
1469 Usage: help [topic]
1470        When called with a topic as an argument, displays usage
1471        information on the given command. If called without a
1472        topic, it provides a list of commands.
1473
1474 \end{verbatim}
1475
1476
1477 \section{http show status}
1478 \subsection{Summary}
1479 \begin{verbatim}
1480 Display HTTP server status
1481 \end{verbatim}
1482 \subsection{Usage}
1483 \begin{verbatim}
1484 Usage: http show status
1485        Lists status of internal HTTP engine
1486
1487 \end{verbatim}
1488
1489
1490 \section{iax2 provision}
1491 \subsection{Summary}
1492 \begin{verbatim}
1493 Provision an IAX device
1494 \end{verbatim}
1495 \subsection{Usage}
1496 \begin{verbatim}
1497 Usage: iax2 provision <host> <template> [forced]
1498        Provisions the given peer or IP address using a template
1499        matching either 'template' or '*' if the template is not
1500        found.  If 'forced' is specified, even empty provisioning
1501        fields will be provisioned as empty fields.
1502
1503 \end{verbatim}
1504
1505
1506 \section{iax2 prune realtime}
1507 \subsection{Summary}
1508 \begin{verbatim}
1509 Prune a cached realtime lookup
1510 \end{verbatim}
1511 \subsection{Usage}
1512 \begin{verbatim}
1513 Usage: iax2 prune realtime [<peername>|all]
1514        Prunes object(s) from the cache
1515
1516 \end{verbatim}
1517
1518
1519 \section{iax2 reload}
1520 \subsection{Summary}
1521 \begin{verbatim}
1522 Reload IAX configuration
1523 \end{verbatim}
1524 \subsection{Usage}
1525 \begin{verbatim}
1526 Usage: iax2 reload
1527        Reloads IAX configuration from iax.conf
1528
1529 \end{verbatim}
1530
1531
1532 \section{iax2 set debug}
1533 \subsection{Summary}
1534 \begin{verbatim}
1535 Enable IAX debugging
1536 \end{verbatim}
1537 \subsection{Usage}
1538 \begin{verbatim}
1539 Usage: iax2 set debug
1540        Enables dumping of IAX packets for debugging purposes
1541
1542 \end{verbatim}
1543
1544
1545 \section{iax2 set debug jb}
1546 \subsection{Summary}
1547 \begin{verbatim}
1548 Enable IAX jitterbuffer debugging
1549 \end{verbatim}
1550 \subsection{Usage}
1551 \begin{verbatim}
1552 Usage: iax2 set debug jb
1553        Enables jitterbuffer debugging information
1554
1555 \end{verbatim}
1556
1557
1558 \section{iax2 set debug jb off}
1559 \subsection{Summary}
1560 \begin{verbatim}
1561 Disable IAX jitterbuffer debugging
1562 \end{verbatim}
1563 \subsection{Usage}
1564 \begin{verbatim}
1565 Usage: iax2 set debug jb off
1566        Disables jitterbuffer debugging information
1567
1568 \end{verbatim}
1569
1570
1571 \section{iax2 set debug off}
1572 \subsection{Summary}
1573 \begin{verbatim}
1574 Disable IAX debugging
1575 \end{verbatim}
1576 \subsection{Usage}
1577 \begin{verbatim}
1578 Usage: iax2 set debug off
1579        Disables dumping of IAX packets for debugging purposes
1580
1581 \end{verbatim}
1582
1583
1584 \section{iax2 set debug trunk}
1585 \subsection{Summary}
1586 \begin{verbatim}
1587 Enable IAX trunk debugging
1588 \end{verbatim}
1589 \subsection{Usage}
1590 \begin{verbatim}
1591 Usage: iax2 set debug trunk
1592        Requests current status of IAX trunking
1593
1594 \end{verbatim}
1595
1596
1597 \section{iax2 set debug trunk off}
1598 \subsection{Summary}
1599 \begin{verbatim}
1600 Disable IAX trunk debugging
1601 \end{verbatim}
1602 \subsection{Usage}
1603 \begin{verbatim}
1604 Usage: iax2 set debug trunk off
1605        Requests current status of IAX trunking
1606
1607 \end{verbatim}
1608
1609
1610 \section{iax2 set mtu}
1611 \subsection{Summary}
1612 \begin{verbatim}
1613 Set the IAX systemwide trunking MTU
1614 \end{verbatim}
1615 \subsection{Usage}
1616 \begin{verbatim}
1617 Usage: iax2 set mtu <value>
1618        Set the system-wide IAX IP mtu to <value> bytes net or zero to disable.
1619        Disabling means that the operating system must handle fragmentation of UDP packets
1620        when the IAX2 trunk packet exceeds the UDP payload size.
1621        This is substantially below the IP mtu. Try 1240 on ethernets.
1622        Must be 172 or greater for G.711 samples.
1623
1624 \end{verbatim}
1625
1626
1627 \section{iax2 show cache}
1628 \subsection{Summary}
1629 \begin{verbatim}
1630 Display IAX cached dialplan
1631 \end{verbatim}
1632 \subsection{Usage}
1633 \begin{verbatim}
1634 Usage: iax2 show cache
1635        Display currently cached IAX Dialplan results.
1636
1637 \end{verbatim}
1638
1639
1640 \section{iax2 show channels}
1641 \subsection{Summary}
1642 \begin{verbatim}
1643 List active IAX channels
1644 \end{verbatim}
1645 \subsection{Usage}
1646 \begin{verbatim}
1647 Usage: iax2 show channels
1648        Lists all currently active IAX channels.
1649
1650 \end{verbatim}
1651
1652
1653 \section{iax2 show firmware}
1654 \subsection{Summary}
1655 \begin{verbatim}
1656 List available IAX firmwares
1657 \end{verbatim}
1658 \subsection{Usage}
1659 \begin{verbatim}
1660 Usage: iax2 show firmware
1661        Lists all known IAX firmware images.
1662
1663 \end{verbatim}
1664
1665
1666 \section{iax2 show netstats}
1667 \subsection{Summary}
1668 \begin{verbatim}
1669 List active IAX channel netstats
1670 \end{verbatim}
1671 \subsection{Usage}
1672 \begin{verbatim}
1673 Usage: iax2 show netstats
1674        Lists network status for all currently active IAX channels.
1675
1676 \end{verbatim}
1677
1678
1679 \section{iax2 show peers}
1680 \subsection{Summary}
1681 \begin{verbatim}
1682 List defined IAX peers
1683 \end{verbatim}
1684 \subsection{Usage}
1685 \begin{verbatim}
1686 Usage: iax2 show peers [registered] [like <pattern>]
1687        Lists all known IAX2 peers.
1688        Optional 'registered' argument lists only peers with known addresses.
1689        Optional regular expression pattern is used to filter the peer list.
1690
1691 \end{verbatim}
1692
1693
1694 \section{iax2 show peer}
1695 \subsection{Summary}
1696 \begin{verbatim}
1697 Show details on specific IAX peer
1698 \end{verbatim}
1699 \subsection{Usage}
1700 \begin{verbatim}
1701 Usage: iax2 show peer <name>
1702        Display details on specific IAX peer
1703
1704 \end{verbatim}
1705
1706
1707 \section{iax2 show provisioning}
1708 \subsection{Summary}
1709 \begin{verbatim}
1710 Display iax provisioning
1711 \end{verbatim}
1712 \subsection{Usage}
1713 \begin{verbatim}
1714 Usage: iax list provisioning [template]
1715        Lists all known IAX provisioning templates or a
1716        specific one if specified.
1717
1718 \end{verbatim}
1719
1720
1721 \section{iax2 show registry}
1722 \subsection{Summary}
1723 \begin{verbatim}
1724 Display IAX registration status
1725 \end{verbatim}
1726 \subsection{Usage}
1727 \begin{verbatim}
1728 Usage: iax2 show registry
1729        Lists all registration requests and status.
1730
1731 \end{verbatim}
1732
1733
1734 \section{iax2 show stats}
1735 \subsection{Summary}
1736 \begin{verbatim}
1737 Display IAX statistics
1738 \end{verbatim}
1739 \subsection{Usage}
1740 \begin{verbatim}
1741 Usage: iax2 show stats
1742        Display statistics on IAX channel driver.
1743
1744 \end{verbatim}
1745
1746
1747 \section{iax2 show threads}
1748 \subsection{Summary}
1749 \begin{verbatim}
1750 Display IAX helper thread info
1751 \end{verbatim}
1752 \subsection{Usage}
1753 \begin{verbatim}
1754 Usage: iax2 show threads
1755        Lists status of IAX helper threads
1756
1757 \end{verbatim}
1758
1759
1760 \section{iax2 show users}
1761 \subsection{Summary}
1762 \begin{verbatim}
1763 List defined IAX users
1764 \end{verbatim}
1765 \subsection{Usage}
1766 \begin{verbatim}
1767 Usage: iax2 show users [like <pattern>]
1768        Lists all known IAX2 users.
1769        Optional regular expression pattern is used to filter the user list.
1770
1771 \end{verbatim}
1772
1773
1774 \section{iax2 test losspct}
1775 \subsection{Summary}
1776 \begin{verbatim}
1777 Set IAX2 incoming frame loss percentage
1778 \end{verbatim}
1779 \subsection{Usage}
1780 \begin{verbatim}
1781 Usage: iax2 test losspct <percentage>
1782        For testing, throws away <percentage> percent of incoming packets
1783
1784 \end{verbatim}
1785
1786
1787 \section{iax2 unregister}
1788 \subsection{Summary}
1789 \begin{verbatim}
1790 Unregister (force expiration) an IAX2 peer from the registry
1791 \end{verbatim}
1792 \subsection{Usage}
1793 \begin{verbatim}
1794 Usage: iax2 unregister <peername>
1795        Unregister (force expiration) an IAX2 peer from the registry.
1796
1797 \end{verbatim}
1798
1799
1800 \section{indication add}
1801 \subsection{Summary}
1802 \begin{verbatim}
1803 Add the given indication to the country
1804 \end{verbatim}
1805 \subsection{Usage}
1806 \begin{verbatim}
1807 Usage: indication add <country> <indication> "<tonelist>"
1808        Add the given indication to the country.
1809
1810 \end{verbatim}
1811
1812
1813 \section{indication remove}
1814 \subsection{Summary}
1815 \begin{verbatim}
1816 Remove the given indication from the country
1817 \end{verbatim}
1818 \subsection{Usage}
1819 \begin{verbatim}
1820 Usage: indication remove <country> <indication>
1821        Remove the given indication from the country.
1822
1823 \end{verbatim}
1824
1825
1826 \section{indication show}
1827 \subsection{Summary}
1828 \begin{verbatim}
1829 Display a list of all countries/indications
1830 \end{verbatim}
1831 \subsection{Usage}
1832 \begin{verbatim}
1833 Usage: indication show [<country> ...]
1834        Display either a condensed for of all country/indications, or the
1835        indications for the specified countries.
1836
1837 \end{verbatim}
1838
1839
1840 \section{jabber debug}
1841 \subsection{Summary}
1842 \begin{verbatim}
1843 Enable Jabber debugging
1844 \end{verbatim}
1845 \subsection{Usage}
1846 \begin{verbatim}
1847 Usage: jabber debug
1848        Enables dumping of Jabber packets for debugging purposes.
1849
1850 \end{verbatim}
1851
1852
1853 \section{jabber debug off}
1854 \subsection{Summary}
1855 \begin{verbatim}
1856 Disable Jabber debug
1857 \end{verbatim}
1858 \subsection{Usage}
1859 \begin{verbatim}
1860 Usage: jabber debug off
1861        Disables dumping of Jabber packets for debugging purposes.
1862
1863 \end{verbatim}
1864
1865
1866 \section{jabber reload}
1867 \subsection{Summary}
1868 \begin{verbatim}
1869 Reload Jabber configuration
1870 \end{verbatim}
1871 \subsection{Usage}
1872 \begin{verbatim}
1873 Usage: jabber reload
1874        Enables reloading of Jabber module.
1875
1876 \end{verbatim}
1877
1878
1879 \section{jabber show connected}
1880 \subsection{Summary}
1881 \begin{verbatim}
1882 Show state of clients and components
1883 \end{verbatim}
1884 \subsection{Usage}
1885 \begin{verbatim}
1886 Usage: jabber debug
1887        Enables dumping of Jabber packets for debugging purposes.
1888
1889 \end{verbatim}
1890
1891
1892 \section{jabber test}
1893 \subsection{Summary}
1894 \begin{verbatim}
1895 Shows roster, but is generally used for mog's debugging.
1896 \end{verbatim}
1897 \subsection{Usage}
1898 \begin{verbatim}
1899 Usage: jabber test [client]
1900        Sends test message for debugging purposes.  A specific client
1901        as configured in jabber.conf can be optionally specified.
1902
1903 \end{verbatim}
1904
1905
1906 \section{keys init}
1907 \subsection{Summary}
1908 \begin{verbatim}
1909 Initialize RSA key passcodes
1910 \end{verbatim}
1911 \subsection{Usage}
1912 \begin{verbatim}
1913 Usage: keys init
1914        Initializes private keys (by reading in pass code from the user)
1915
1916 \end{verbatim}
1917
1918
1919 \section{keys show}
1920 \subsection{Summary}
1921 \begin{verbatim}
1922 Displays RSA key information
1923 \end{verbatim}
1924 \subsection{Usage}
1925 \begin{verbatim}
1926 Usage: keys show
1927        Displays information about RSA keys known by Asterisk
1928
1929 \end{verbatim}
1930
1931
1932 \section{local show channels}
1933 \subsection{Summary}
1934 \begin{verbatim}
1935 List status of local channels
1936 \end{verbatim}
1937 \subsection{Usage}
1938 \begin{verbatim}
1939 Usage: local show channels
1940        Provides summary information on active local proxy channels.
1941
1942 \end{verbatim}
1943
1944
1945 \section{logger mute}
1946 \subsection{Summary}
1947 \begin{verbatim}
1948 Toggle logging output to a console
1949 \end{verbatim}
1950 \subsection{Usage}
1951 \begin{verbatim}
1952 Usage: logger mute
1953        Disables logging output to the current console, making it possible to
1954        gather information without being disturbed by scrolling lines.
1955
1956 \end{verbatim}
1957
1958
1959 \section{logger reload}
1960 \subsection{Summary}
1961 \begin{verbatim}
1962 Reopens the log files
1963 \end{verbatim}
1964 \subsection{Usage}
1965 \begin{verbatim}
1966 Usage: logger reload
1967        Reloads the logger subsystem state.  Use after restarting syslogd(8) if you are using syslog logging.
1968
1969 \end{verbatim}
1970
1971
1972 \section{logger rotate}
1973 \subsection{Summary}
1974 \begin{verbatim}
1975 Rotates and reopens the log files
1976 \end{verbatim}
1977 \subsection{Usage}
1978 \begin{verbatim}
1979 Usage: logger rotate
1980        Rotates and Reopens the log files.
1981
1982 \end{verbatim}
1983
1984
1985 \section{logger show channels}
1986 \subsection{Summary}
1987 \begin{verbatim}
1988 List configured log channels
1989 \end{verbatim}
1990 \subsection{Usage}
1991 \begin{verbatim}
1992 Usage: logger show channels
1993        List configured logger channels.
1994
1995 \end{verbatim}
1996
1997
1998 \section{manager debug}
1999 \subsection{Summary}
2000 \begin{verbatim}
2001 Show, enable, disable debugging of the manager code
2002 \end{verbatim}
2003 \subsection{Usage}
2004 \begin{verbatim}
2005 Usage: manager debug [on|off]
2006         Show, enable, disable debugging of the manager code.
2007
2008 \end{verbatim}
2009
2010
2011 \section{manager dump actiondocs}
2012 \subsection{Summary}
2013 \begin{verbatim}
2014 Dump manager action documentation in LaTeX format
2015 \end{verbatim}
2016 \subsection{Usage}
2017 \begin{verbatim}
2018 Usage: manager dump actiondocs [action]
2019        Dump manager action documentation to /tmp/ast_manager_actiondocs.tex.
2020
2021 \end{verbatim}
2022
2023
2024 \section{manager show command}
2025 \subsection{Summary}
2026 \begin{verbatim}
2027 Show a manager interface command
2028 \end{verbatim}
2029 \subsection{Usage}
2030 \begin{verbatim}
2031 Usage: manager show command <actionname>
2032         Shows the detailed description for a specific Asterisk manager interface command.
2033
2034 \end{verbatim}
2035
2036
2037 \section{manager show commands}
2038 \subsection{Summary}
2039 \begin{verbatim}
2040 List manager interface commands
2041 \end{verbatim}
2042 \subsection{Usage}
2043 \begin{verbatim}
2044 Usage: manager show commands
2045         Prints a listing of all the available Asterisk manager interface commands.
2046
2047 \end{verbatim}
2048
2049
2050 \section{manager show connected}
2051 \subsection{Summary}
2052 \begin{verbatim}
2053 List connected manager interface users
2054 \end{verbatim}
2055 \subsection{Usage}
2056 \begin{verbatim}
2057 Usage: manager show connected
2058         Prints a listing of the users that are currently connected to the
2059 Asterisk manager interface.
2060
2061 \end{verbatim}
2062
2063
2064 \section{manager show eventq}
2065 \subsection{Summary}
2066 \begin{verbatim}
2067 List manager interface queued events
2068 \end{verbatim}
2069 \subsection{Usage}
2070 \begin{verbatim}
2071 Usage: manager show eventq
2072         Prints a listing of all events pending in the Asterisk manger
2073 event queue.
2074
2075 \end{verbatim}
2076
2077
2078 \section{manager show users}
2079 \subsection{Summary}
2080 \begin{verbatim}
2081 List configured manager users
2082 \end{verbatim}
2083 \subsection{Usage}
2084 \begin{verbatim}
2085 Usage: manager show users
2086        Prints a listing of all managers that are currently configured on that
2087  system.
2088
2089 \end{verbatim}
2090
2091
2092 \section{manager show user}
2093 \subsection{Summary}
2094 \begin{verbatim}
2095 Display information on a specific manager user
2096 \end{verbatim}
2097 \subsection{Usage}
2098 \begin{verbatim}
2099  Usage: manager show user <user>
2100         Display all information related to the manager user specified.
2101
2102 \end{verbatim}
2103
2104
2105 \section{meetme}
2106 \subsection{Summary}
2107 \begin{verbatim}
2108 Execute a command on a conference or conferee
2109 \end{verbatim}
2110 \subsection{Usage}
2111 \begin{verbatim}
2112 Usage: meetme (un)lock|(un)mute|kick|list [concise] <confno> <usernumber>
2113        Executes a command for the conference or on a conferee
2114
2115 \end{verbatim}
2116
2117
2118 \section{memory show allocations}
2119 \subsection{Summary}
2120 \begin{verbatim}
2121 Display outstanding memory allocations
2122 \end{verbatim}
2123 \subsection{Usage}
2124 \begin{verbatim}
2125 Usage: memory show allocations [<file>]
2126        Dumps a list of all segments of allocated memory, optionally
2127 limited to those from a specific file
2128
2129 \end{verbatim}
2130
2131
2132 \section{memory show summary}
2133 \subsection{Summary}
2134 \begin{verbatim}
2135 Summarize outstanding memory allocations
2136 \end{verbatim}
2137 \subsection{Usage}
2138 \begin{verbatim}
2139 Usage: memory show summary [<file>]
2140        Summarizes heap memory allocations by file, or optionally
2141 by function, if a file is specified
2142
2143 \end{verbatim}
2144
2145
2146 \section{mgcp audit endpoint}
2147 \subsection{Summary}
2148 \begin{verbatim}
2149 Audit specified MGCP endpoint
2150 \end{verbatim}
2151 \subsection{Usage}
2152 \begin{verbatim}
2153 Usage: mgcp audit endpoint <endpointid>
2154        Lists the capabilities of an endpoint in the MGCP (Media Gateway Control Protocol) subsystem.
2155        mgcp debug MUST be on to see the results of this command.
2156
2157 \end{verbatim}
2158
2159
2160 \section{mgcp reload}
2161 \subsection{Summary}
2162 \begin{verbatim}
2163 Reload MGCP configuration
2164 \end{verbatim}
2165 \subsection{Usage}
2166 \begin{verbatim}
2167 Usage: mgcp reload
2168        Reloads MGCP configuration from mgcp.conf
2169        Deprecated:  please use 'reload chan_mgcp.so' instead.
2170
2171 \end{verbatim}
2172
2173
2174 \section{mgcp set debug}
2175 \subsection{Summary}
2176 \begin{verbatim}
2177 Enable MGCP debugging
2178 \end{verbatim}
2179 \subsection{Usage}
2180 \begin{verbatim}
2181 Usage: mgcp set debug
2182        Enables dumping of MGCP packets for debugging purposes
2183
2184 \end{verbatim}
2185
2186
2187 \section{mgcp set debug off}
2188 \subsection{Summary}
2189 \begin{verbatim}
2190 Disable MGCP debugging
2191 \end{verbatim}
2192 \subsection{Usage}
2193 \begin{verbatim}
2194 Usage: mgcp set debug off
2195        Disables dumping of MGCP packets for debugging purposes
2196
2197 \end{verbatim}
2198
2199
2200 \section{mgcp show endpoints}
2201 \subsection{Summary}
2202 \begin{verbatim}
2203 List defined MGCP endpoints
2204 \end{verbatim}
2205 \subsection{Usage}
2206 \begin{verbatim}
2207 Usage: mgcp show endpoints
2208        Lists all endpoints known to the MGCP (Media Gateway Control Protocol) subsystem.
2209
2210 \end{verbatim}
2211
2212
2213 \section{minivm list accounts}
2214 \subsection{Summary}
2215 \begin{verbatim}
2216 List defined mini-voicemail boxes
2217 \end{verbatim}
2218 \subsection{Usage}
2219 \begin{verbatim}
2220 Usage: minivm list accounts
2221        Lists all mailboxes currently set up
2222
2223 \end{verbatim}
2224
2225
2226 \section{minivm list templates}
2227 \subsection{Summary}
2228 \begin{verbatim}
2229 List message templates
2230 \end{verbatim}
2231 \subsection{Usage}
2232 \begin{verbatim}
2233 Usage: minivm list templates
2234        Lists message templates for e-mail, paging and IM
2235
2236 \end{verbatim}
2237
2238
2239 \section{minivm list zones}
2240 \subsection{Summary}
2241 \begin{verbatim}
2242 List zone message formats
2243 \end{verbatim}
2244 \subsection{Usage}
2245 \begin{verbatim}
2246 Usage: minivm list zones
2247        Lists zone message formats
2248
2249 \end{verbatim}
2250
2251
2252 \section{minivm reload}
2253 \subsection{Summary}
2254 \begin{verbatim}
2255 Reload Mini-voicemail configuration
2256 \end{verbatim}
2257 \subsection{Usage}
2258 \begin{verbatim}
2259 Usage: minivm reload
2260        Reload mini-voicemail configuration and reset statistics
2261
2262 \end{verbatim}
2263
2264
2265 \section{minivm show settings}
2266 \subsection{Summary}
2267 \begin{verbatim}
2268 Show mini-voicemail general settings
2269 \end{verbatim}
2270 \subsection{Usage}
2271 \begin{verbatim}
2272 Usage: minivm show settings
2273        Display Mini-Voicemail general settings
2274
2275 \end{verbatim}
2276
2277
2278 \section{minivm show stats}
2279 \subsection{Summary}
2280 \begin{verbatim}
2281 Show some mini-voicemail statistics
2282 \end{verbatim}
2283 \subsection{Usage}
2284 \begin{verbatim}
2285 Usage: minivm show stats
2286        Display Mini-Voicemail counters
2287
2288 \end{verbatim}
2289
2290
2291 \section{mixmonitor}
2292 \subsection{Summary}
2293 \begin{verbatim}
2294 Execute a MixMonitor command.
2295 \end{verbatim}
2296 \subsection{Usage}
2297 \begin{verbatim}
2298 mixmonitor <start|stop> <chan_name> [args]
2299
2300 The optional arguments are passed to the
2301 MixMonitor application when the 'start' command is used.
2302
2303 \end{verbatim}
2304
2305
2306 \section{module load}
2307 \subsection{Summary}
2308 \begin{verbatim}
2309 Load a module by name
2310 \end{verbatim}
2311 \subsection{Usage}
2312 \begin{verbatim}
2313 Usage: module load <module name>
2314        Loads the specified module into Asterisk.
2315
2316 \end{verbatim}
2317
2318
2319 \section{module reload}
2320 \subsection{Summary}
2321 \begin{verbatim}
2322 Reload configuration
2323 \end{verbatim}
2324 \subsection{Usage}
2325 \begin{verbatim}
2326 Usage: module reload [module ...]
2327        Reloads configuration files for all listed modules which support
2328        reloading, or for all supported modules if none are listed.
2329
2330 \end{verbatim}
2331
2332
2333 \section{module show [like]}
2334 \subsection{Summary}
2335 \begin{verbatim}
2336 List modules and info
2337 \end{verbatim}
2338 \subsection{Usage}
2339 \begin{verbatim}
2340 Usage: module show [like keyword]
2341        Shows Asterisk modules currently in use, and usage statistics.
2342
2343 \end{verbatim}
2344
2345
2346 \section{module unload}
2347 \subsection{Summary}
2348 \begin{verbatim}
2349 Unload a module by name
2350 \end{verbatim}
2351 \subsection{Usage}
2352 \begin{verbatim}
2353 Usage: module unload [-f|-h] <module_1> [<module_2> ... ]
2354        Unloads the specified module from Asterisk. The -f
2355        option causes the module to be unloaded even if it is
2356        in use (may cause a crash) and the -h module causes the
2357        module to be unloaded even if the module says it cannot, 
2358        which almost always will cause a crash.
2359
2360 \end{verbatim}
2361
2362
2363 \section{moh reload}
2364 \subsection{Summary}
2365 \begin{verbatim}
2366 Music On Hold
2367 \end{verbatim}
2368 \subsection{Usage}
2369 \begin{verbatim}
2370 Music On Hold
2371 \end{verbatim}
2372
2373
2374 \section{moh show classes}
2375 \subsection{Summary}
2376 \begin{verbatim}
2377 List MOH classes
2378 \end{verbatim}
2379 \subsection{Usage}
2380 \begin{verbatim}
2381 Lists all MOH classes
2382 \end{verbatim}
2383
2384
2385 \section{moh show files}
2386 \subsection{Summary}
2387 \begin{verbatim}
2388 List MOH file-based classes
2389 \end{verbatim}
2390 \subsection{Usage}
2391 \begin{verbatim}
2392 Lists all loaded file-based MOH classes and their files
2393 \end{verbatim}
2394
2395
2396 \section{no debug channel}
2397 \subsection{Summary}
2398 \begin{verbatim}
2399 Disable debugging on channel(s)
2400 \end{verbatim}
2401 \subsection{Usage}
2402 \begin{verbatim}
2403 Usage: core set debug channel <all|channel> [off]
2404        Enables/disables debugging on all or on a specific channel.
2405
2406 \end{verbatim}
2407
2408
2409 \section{odbc show}
2410 \subsection{Summary}
2411 \begin{verbatim}
2412 List ODBC DSN(s)
2413 \end{verbatim}
2414 \subsection{Usage}
2415 \begin{verbatim}
2416 Usage: odbc show [<class>]
2417        List settings of a particular ODBC class.
2418        or, if not specified, all classes.
2419
2420 \end{verbatim}
2421
2422
2423 \section{originate}
2424 \subsection{Summary}
2425 \begin{verbatim}
2426 Originate a call
2427 \end{verbatim}
2428 \subsection{Usage}
2429 \begin{verbatim}
2430   There are two ways to use this command. A call can be originated between a
2431 channel and a specific application, or between a channel and an extension in
2432 the dialplan. This is similar to call files or the manager originate action.
2433 Calls originated with this command are given a timeout of 30 seconds.
2434
2435 Usage1: originate <tech/data> application <appname> [appdata]
2436   This will originate a call between the specified channel tech/data and the
2437 given application. Arguments to the application are optional. If the given
2438 arguments to the application include spaces, all of the arguments to the
2439 application need to be placed in quotation marks.
2440
2441 Usage2: originate <tech/data> extension [exten@][context]
2442   This will originate a call between the specified channel tech/data and the
2443 given extension. If no context is specified, the 'default' context will be
2444 used. If no extension is given, the 's' extension will be used.
2445
2446 \end{verbatim}
2447
2448
2449 \section{parkedcalls show}
2450 \subsection{Summary}
2451 \begin{verbatim}
2452 List currently parked calls
2453 \end{verbatim}
2454 \subsection{Usage}
2455 \begin{verbatim}
2456 Usage: parkedcalls show
2457        List currently parked calls
2458
2459 \end{verbatim}
2460
2461
2462 \section{queue add member}
2463 \subsection{Summary}
2464 \begin{verbatim}
2465 Add a channel to a specified queue
2466 \end{verbatim}
2467 \subsection{Usage}
2468 \begin{verbatim}
2469 Usage: queue add member <channel> to <queue> [penalty <penalty>]
2470
2471 \end{verbatim}
2472
2473
2474 \section{queue remove member}
2475 \subsection{Summary}
2476 \begin{verbatim}
2477 Removes a channel from a specified queue
2478 \end{verbatim}
2479 \subsection{Usage}
2480 \begin{verbatim}
2481 Usage: queue remove member <channel> from <queue>
2482
2483 \end{verbatim}
2484
2485
2486 \section{queue show}
2487 \subsection{Summary}
2488 \begin{verbatim}
2489 Show status of a specified queue
2490 \end{verbatim}
2491 \subsection{Usage}
2492 \begin{verbatim}
2493 Usage: queue show
2494        Provides summary information on a specified queue.
2495
2496 \end{verbatim}
2497
2498
2499 \section{realtime load}
2500 \subsection{Summary}
2501 \begin{verbatim}
2502 Used to print out RealTime variables.
2503 \end{verbatim}
2504 \subsection{Usage}
2505 \begin{verbatim}
2506 Usage: realtime load <family> <colmatch> <value>
2507        Prints out a list of variables using the RealTime driver.
2508
2509 \end{verbatim}
2510
2511
2512 \section{realtime update}
2513 \subsection{Summary}
2514 \begin{verbatim}
2515 Used to update RealTime variables.
2516 \end{verbatim}
2517 \subsection{Usage}
2518 \begin{verbatim}
2519 Usage: realtime update <family> <colmatch> <value>
2520        Update a single variable using the RealTime driver.
2521
2522 \end{verbatim}
2523
2524
2525 \section{restart gracefully}
2526 \subsection{Summary}
2527 \begin{verbatim}
2528 Restart Asterisk gracefully
2529 \end{verbatim}
2530 \subsection{Usage}
2531 \begin{verbatim}
2532 Usage: restart gracefully
2533        Causes Asterisk to stop accepting new calls and exec() itself performing a cold
2534        restart when all active calls have ended.
2535
2536 \end{verbatim}
2537
2538
2539 \section{restart now}
2540 \subsection{Summary}
2541 \begin{verbatim}
2542 Restart Asterisk immediately
2543 \end{verbatim}
2544 \subsection{Usage}
2545 \begin{verbatim}
2546 Usage: restart now
2547        Causes Asterisk to hangup all calls and exec() itself performing a cold
2548        restart.
2549
2550 \end{verbatim}
2551
2552
2553 \section{restart when convenient}
2554 \subsection{Summary}
2555 \begin{verbatim}
2556 Restart Asterisk at empty call volume
2557 \end{verbatim}
2558 \subsection{Usage}
2559 \begin{verbatim}
2560 Usage: restart when convenient
2561        Causes Asterisk to perform a cold restart when all active calls have ended.
2562
2563 \end{verbatim}
2564
2565
2566 \section{rpt debug level}
2567 \subsection{Summary}
2568 \begin{verbatim}
2569 Enable app_rpt debugging
2570 \end{verbatim}
2571 \subsection{Usage}
2572 \begin{verbatim}
2573 Usage: rpt debug level {0-7}
2574        Enables debug messages in app_rpt
2575
2576 \end{verbatim}
2577
2578
2579 \section{rpt dump}
2580 \subsection{Summary}
2581 \begin{verbatim}
2582 Dump app_rpt structs for debugging
2583 \end{verbatim}
2584 \subsection{Usage}
2585 \begin{verbatim}
2586 Usage: rpt dump <nodename>
2587        Dumps struct debug info to log
2588
2589 \end{verbatim}
2590
2591
2592 \section{rpt lstats}
2593 \subsection{Summary}
2594 \begin{verbatim}
2595 Dump link statistics
2596 \end{verbatim}
2597 \subsection{Usage}
2598 \begin{verbatim}
2599 Usage: rpt lstats <nodename>
2600        Dumps link statistics to console
2601
2602 \end{verbatim}
2603
2604
2605 \section{rpt reload}
2606 \subsection{Summary}
2607 \begin{verbatim}
2608 Reload app_rpt config
2609 \end{verbatim}
2610 \subsection{Usage}
2611 \begin{verbatim}
2612 Usage: rpt reload
2613        Reloads app_rpt running config parameters
2614
2615 \end{verbatim}
2616
2617
2618 \section{rpt restart}
2619 \subsection{Summary}
2620 \begin{verbatim}
2621 Restart app_rpt
2622 \end{verbatim}
2623 \subsection{Usage}
2624 \begin{verbatim}
2625 Usage: rpt restart
2626        Restarts app_rpt
2627
2628 \end{verbatim}
2629
2630
2631 \section{rpt stats}
2632 \subsection{Summary}
2633 \begin{verbatim}
2634 Dump node statistics
2635 \end{verbatim}
2636 \subsection{Usage}
2637 \begin{verbatim}
2638 Usage: rpt stats <nodename>
2639        Dumps node statistics to console
2640
2641 \end{verbatim}
2642
2643
2644 \section{rtcp debug ip}
2645 \subsection{Summary}
2646 \begin{verbatim}
2647 Enable RTCP debugging on IP
2648 \end{verbatim}
2649 \subsection{Usage}
2650 \begin{verbatim}
2651 Usage: rtcp debug [ip host[:port]]
2652        Enable dumping of all RTCP packets to and from host.
2653
2654 \end{verbatim}
2655
2656
2657 \section{rtcp debug}
2658 \subsection{Summary}
2659 \begin{verbatim}
2660 Enable RTCP debugging
2661 \end{verbatim}
2662 \subsection{Usage}
2663 \begin{verbatim}
2664 Usage: rtcp debug [ip host[:port]]
2665        Enable dumping of all RTCP packets to and from host.
2666
2667 \end{verbatim}
2668
2669
2670 \section{rtcp debug off}
2671 \subsection{Summary}
2672 \begin{verbatim}
2673 Disable RTCP debugging
2674 \end{verbatim}
2675 \subsection{Usage}
2676 \begin{verbatim}
2677 Usage: rtcp debug off
2678        Disable all RTCP debugging
2679
2680 \end{verbatim}
2681
2682
2683 \section{rtcp stats}
2684 \subsection{Summary}
2685 \begin{verbatim}
2686 Enable RTCP stats
2687 \end{verbatim}
2688 \subsection{Usage}
2689 \begin{verbatim}
2690 Usage: rtcp stats
2691        Enable dumping of RTCP stats.
2692
2693 \end{verbatim}
2694
2695
2696 \section{rtcp stats off}
2697 \subsection{Summary}
2698 \begin{verbatim}
2699 Disable RTCP stats
2700 \end{verbatim}
2701 \subsection{Usage}
2702 \begin{verbatim}
2703 Usage: rtcp stats off
2704        Disable all RTCP stats
2705
2706 \end{verbatim}
2707
2708
2709 \section{rtp debug ip}
2710 \subsection{Summary}
2711 \begin{verbatim}
2712 Enable RTP debugging on IP
2713 \end{verbatim}
2714 \subsection{Usage}
2715 \begin{verbatim}
2716 Usage: rtp debug [ip host[:port]]
2717        Enable dumping of all RTP packets to and from host.
2718
2719 \end{verbatim}
2720
2721
2722 \section{rtp debug}
2723 \subsection{Summary}
2724 \begin{verbatim}
2725 Enable RTP debugging
2726 \end{verbatim}
2727 \subsection{Usage}
2728 \begin{verbatim}
2729 Usage: rtp debug [ip host[:port]]
2730        Enable dumping of all RTP packets to and from host.
2731
2732 \end{verbatim}
2733
2734
2735 \section{rtp debug off}
2736 \subsection{Summary}
2737 \begin{verbatim}
2738 Disable RTP debugging
2739 \end{verbatim}
2740 \subsection{Usage}
2741 \begin{verbatim}
2742 Usage: rtp debug off
2743        Disable all RTP debugging
2744
2745 \end{verbatim}
2746
2747
2748 \section{say load}
2749 \subsection{Summary}
2750 \begin{verbatim}
2751 set/show the say mode
2752 \end{verbatim}
2753 \subsection{Usage}
2754 \begin{verbatim}
2755 say load new|old
2756 \end{verbatim}
2757
2758
2759 \section{sip history}
2760 \subsection{Summary}
2761 \begin{verbatim}
2762 Enable SIP history
2763 \end{verbatim}
2764 \subsection{Usage}
2765 \begin{verbatim}
2766 Usage: sip history
2767        Enables recording of SIP dialog history for debugging purposes.
2768 Use 'sip show history' to view the history of a call number.
2769
2770 \end{verbatim}
2771
2772
2773 \section{sip history off}
2774 \subsection{Summary}
2775 \begin{verbatim}
2776 Disable SIP history
2777 \end{verbatim}
2778 \subsection{Usage}
2779 \begin{verbatim}
2780 Usage: sip history off
2781        Disables recording of SIP dialog history for debugging purposes
2782
2783 \end{verbatim}
2784
2785
2786 \section{sip notify}
2787 \subsection{Summary}
2788 \begin{verbatim}
2789 Send a notify packet to a SIP peer
2790 \end{verbatim}
2791 \subsection{Usage}
2792 \begin{verbatim}
2793 Usage: sip notify <type> <peer> [<peer>...]
2794        Send a NOTIFY message to a SIP peer or peers
2795        Message types are defined in sip_notify.conf
2796
2797 \end{verbatim}
2798
2799
2800 \section{sip prune realtime}
2801 \subsection{Summary}
2802 \begin{verbatim}
2803 Prune cached Realtime object(s)
2804 \end{verbatim}
2805 \subsection{Usage}
2806 \begin{verbatim}
2807 Usage: sip prune realtime [peer|user] [<name>|all|like <pattern>]
2808        Prunes object(s) from the cache.
2809        Optional regular expression pattern is used to filter the objects.
2810
2811 \end{verbatim}
2812
2813
2814 \section{sip prune realtime peer}
2815 \subsection{Summary}
2816 \begin{verbatim}
2817 Prune cached Realtime peer(s)
2818 \end{verbatim}
2819 \subsection{Usage}
2820 \begin{verbatim}
2821 Usage: sip prune realtime [peer|user] [<name>|all|like <pattern>]
2822        Prunes object(s) from the cache.
2823        Optional regular expression pattern is used to filter the objects.
2824
2825 \end{verbatim}
2826
2827
2828 \section{sip prune realtime user}
2829 \subsection{Summary}
2830 \begin{verbatim}
2831 Prune cached Realtime user(s)
2832 \end{verbatim}
2833 \subsection{Usage}
2834 \begin{verbatim}
2835 Usage: sip prune realtime [peer|user] [<name>|all|like <pattern>]
2836        Prunes object(s) from the cache.
2837        Optional regular expression pattern is used to filter the objects.
2838
2839 \end{verbatim}
2840
2841
2842 \section{sip reload}
2843 \subsection{Summary}
2844 \begin{verbatim}
2845 Reload SIP configuration
2846 \end{verbatim}
2847 \subsection{Usage}
2848 \begin{verbatim}
2849 Usage: sip reload
2850        Reloads SIP configuration from sip.conf
2851
2852 \end{verbatim}
2853
2854
2855 \section{sip set debug}
2856 \subsection{Summary}
2857 \begin{verbatim}
2858 Enable SIP debugging
2859 \end{verbatim}
2860 \subsection{Usage}
2861 \begin{verbatim}
2862 Usage: sip set debug {on|off|ip <host[:PORT]>|peer <peername>}
2863        sip set debug on
2864           Enables dumping of all SIP messages for debugging purposes
2865
2866        sip set debug off
2867           Disables dumping of all SIP messages
2868
2869        sip set debug ip <host[:PORT]>
2870           Enables dumping of SIP messages to and from host.
2871
2872        sip set debug peer <peername>
2873           Enables dumping of SIP messages to and from peer's IP.
2874           Requires peer to be registered.
2875
2876 \end{verbatim}
2877
2878
2879 \section{sip set debug ip}
2880 \subsection{Summary}
2881 \begin{verbatim}
2882 Enable SIP debugging on IP
2883 \end{verbatim}
2884 \subsection{Usage}
2885 \begin{verbatim}
2886 Usage: sip set debug {on|off|ip <host[:PORT]>|peer <peername>}
2887        sip set debug on
2888           Enables dumping of all SIP messages for debugging purposes
2889
2890        sip set debug off
2891           Disables dumping of all SIP messages
2892
2893        sip set debug ip <host[:PORT]>
2894           Enables dumping of SIP messages to and from host.
2895
2896        sip set debug peer <peername>
2897           Enables dumping of SIP messages to and from peer's IP.
2898           Requires peer to be registered.
2899
2900 \end{verbatim}
2901
2902
2903 \section{sip set debug off}
2904 \subsection{Summary}
2905 \begin{verbatim}
2906 Disable SIP debugging
2907 \end{verbatim}
2908 \subsection{Usage}
2909 \begin{verbatim}
2910 Usage: sip set debug off
2911        Disables dumping of SIP packets for debugging purposes
2912
2913 \end{verbatim}
2914
2915
2916 \section{sip set debug on}
2917 \subsection{Summary}
2918 \begin{verbatim}
2919 Enable SIP debugging
2920 \end{verbatim}
2921 \subsection{Usage}
2922 \begin{verbatim}
2923 Usage: sip set debug {on|off|ip <host[:PORT]>|peer <peername>}
2924        sip set debug on
2925           Enables dumping of all SIP messages for debugging purposes
2926
2927        sip set debug off
2928           Disables dumping of all SIP messages
2929
2930        sip set debug ip <host[:PORT]>
2931           Enables dumping of SIP messages to and from host.
2932
2933        sip set debug peer <peername>
2934           Enables dumping of SIP messages to and from peer's IP.
2935           Requires peer to be registered.
2936
2937 \end{verbatim}
2938
2939
2940 \section{sip set debug peer}
2941 \subsection{Summary}
2942 \begin{verbatim}
2943 Enable SIP debugging on Peername
2944 \end{verbatim}
2945 \subsection{Usage}
2946 \begin{verbatim}
2947 Usage: sip set debug {on|off|ip <host[:PORT]>|peer <peername>}
2948        sip set debug on
2949           Enables dumping of all SIP messages for debugging purposes
2950
2951        sip set debug off
2952           Disables dumping of all SIP messages
2953
2954        sip set debug ip <host[:PORT]>
2955           Enables dumping of SIP messages to and from host.
2956
2957        sip set debug peer <peername>
2958           Enables dumping of SIP messages to and from peer's IP.
2959           Requires peer to be registered.
2960
2961 \end{verbatim}
2962
2963
2964 \section{sip show channels}
2965 \subsection{Summary}
2966 \begin{verbatim}
2967 List active SIP channels
2968 \end{verbatim}
2969 \subsection{Usage}
2970 \begin{verbatim}
2971 Usage: sip show channels
2972        Lists all currently active SIP channels.
2973
2974 \end{verbatim}
2975
2976
2977 \section{sip show channel}
2978 \subsection{Summary}
2979 \begin{verbatim}
2980 Show detailed SIP channel info
2981 \end{verbatim}
2982 \subsection{Usage}
2983 \begin{verbatim}
2984 Usage: sip show channel <channel>
2985        Provides detailed status on a given SIP channel.
2986
2987 \end{verbatim}
2988
2989
2990 \section{sip show domains}
2991 \subsection{Summary}
2992 \begin{verbatim}
2993 List our local SIP domains.
2994 \end{verbatim}
2995 \subsection{Usage}
2996 \begin{verbatim}
2997 Usage: sip show domains
2998        Lists all configured SIP local domains.
2999        Asterisk only responds to SIP messages to local domains.
3000
3001 \end{verbatim}
3002
3003
3004 \section{sip show history}
3005 \subsection{Summary}
3006 \begin{verbatim}
3007 Show SIP dialog history
3008 \end{verbatim}
3009 \subsection{Usage}
3010 \begin{verbatim}
3011 Usage: sip show history <channel>
3012        Provides detailed dialog history on a given SIP channel.
3013
3014 \end{verbatim}
3015
3016
3017 \section{sip show inuse}
3018 \subsection{Summary}
3019 \begin{verbatim}
3020 List all inuse/limits
3021 \end{verbatim}
3022 \subsection{Usage}
3023 \begin{verbatim}
3024 Usage: sip show inuse [all]
3025        List all SIP users and peers usage counters and limits.
3026        Add option "all" to show all devices, not only those with a limit.
3027
3028 \end{verbatim}
3029
3030
3031 \section{sip show objects}
3032 \subsection{Summary}
3033 \begin{verbatim}
3034 List all SIP object allocations
3035 \end{verbatim}
3036 \subsection{Usage}
3037 \begin{verbatim}
3038 Usage: sip show objects
3039        Lists status of known SIP objects
3040
3041 \end{verbatim}
3042
3043
3044 \section{sip show peers}
3045 \subsection{Summary}
3046 \begin{verbatim}
3047 List defined SIP peers
3048 \end{verbatim}
3049 \subsection{Usage}
3050 \begin{verbatim}
3051 Usage: sip show peers [like <pattern>]
3052        Lists all known SIP peers.
3053        Optional regular expression pattern is used to filter the peer list.
3054
3055 \end{verbatim}
3056
3057
3058 \section{sip show peer}
3059 \subsection{Summary}
3060 \begin{verbatim}
3061 Show details on specific SIP peer
3062 \end{verbatim}
3063 \subsection{Usage}
3064 \begin{verbatim}
3065 Usage: sip show peer <name> [load]
3066        Shows all details on one SIP peer and the current status.
3067        Option "load" forces lookup of peer in realtime storage.
3068
3069 \end{verbatim}
3070
3071
3072 \section{sip show registry}
3073 \subsection{Summary}
3074 \begin{verbatim}
3075 List SIP registration status
3076 \end{verbatim}
3077 \subsection{Usage}
3078 \begin{verbatim}
3079 Usage: sip show registry
3080        Lists all registration requests and status.
3081
3082 \end{verbatim}
3083
3084
3085 \section{sip show settings}
3086 \subsection{Summary}
3087 \begin{verbatim}
3088 Show SIP global settings
3089 \end{verbatim}
3090 \subsection{Usage}
3091 \begin{verbatim}
3092 Usage: sip show settings
3093        Provides detailed list of the configuration of the SIP channel.
3094
3095 \end{verbatim}
3096
3097
3098 \section{sip show subscriptions}
3099 \subsection{Summary}
3100 \begin{verbatim}
3101 List active SIP subscriptions
3102 \end{verbatim}
3103 \subsection{Usage}
3104 \begin{verbatim}
3105 Usage: sip show subscriptions
3106        Lists active SIP subscriptions for extension states
3107
3108 \end{verbatim}
3109
3110
3111 \section{sip show users}
3112 \subsection{Summary}
3113 \begin{verbatim}
3114 List defined SIP users
3115 \end{verbatim}
3116 \subsection{Usage}
3117 \begin{verbatim}
3118 Usage: sip show users [like <pattern>]
3119        Lists all known SIP users.
3120        Optional regular expression pattern is used to filter the user list.
3121
3122 \end{verbatim}
3123
3124
3125 \section{sip show user}
3126 \subsection{Summary}
3127 \begin{verbatim}
3128 Show details on specific SIP user
3129 \end{verbatim}
3130 \subsection{Usage}
3131 \begin{verbatim}
3132 Usage: sip show user <name> [load]
3133        Shows all details on one SIP user and the current status.
3134        Option "load" forces lookup of peer in realtime storage.
3135
3136 \end{verbatim}
3137
3138
3139 \section{sip unregister}
3140 \subsection{Summary}
3141 \begin{verbatim}
3142 Unregister (force expiration) a SIP peer from the registery
3143
3144 \end{verbatim}
3145 \subsection{Usage}
3146 \begin{verbatim}
3147 Usage: sip unregister <peer>
3148        Unregister (force expiration) a SIP peer from the registry
3149
3150 \end{verbatim}
3151
3152
3153 \section{skinny reset}
3154 \subsection{Summary}
3155 \begin{verbatim}
3156 Reset Skinny device(s)
3157 \end{verbatim}
3158 \subsection{Usage}
3159 \begin{verbatim}
3160 Usage: skinny reset <DeviceId|all> [restart]
3161        Causes a Skinny device to reset itself, optionally with a full restart
3162
3163 \end{verbatim}
3164
3165
3166 \section{skinny set debug}
3167 \subsection{Summary}
3168 \begin{verbatim}
3169 Enable Skinny debugging
3170 \end{verbatim}
3171 \subsection{Usage}
3172 \begin{verbatim}
3173 Usage: skinny set debug
3174        Enables dumping of Skinny packets for debugging purposes
3175
3176 \end{verbatim}
3177
3178
3179 \section{skinny set debug off}
3180 \subsection{Summary}
3181 \begin{verbatim}
3182 Disable Skinny debugging
3183 \end{verbatim}
3184 \subsection{Usage}
3185 \begin{verbatim}
3186 Usage: skinny set debug off
3187        Disables dumping of Skinny packets for debugging purposes
3188
3189 \end{verbatim}
3190
3191
3192 \section{skinny show devices}
3193 \subsection{Summary}
3194 \begin{verbatim}
3195 List defined Skinny devices
3196 \end{verbatim}
3197 \subsection{Usage}
3198 \begin{verbatim}
3199 Usage: skinny show devices
3200        Lists all devices known to the Skinny subsystem.
3201
3202 \end{verbatim}
3203
3204
3205 \section{skinny show lines}
3206 \subsection{Summary}
3207 \begin{verbatim}
3208 List defined Skinny lines per device
3209 \end{verbatim}
3210 \subsection{Usage}
3211 \begin{verbatim}
3212 Usage: skinny show lines
3213        Lists all lines known to the Skinny subsystem.
3214
3215 \end{verbatim}
3216
3217
3218 \section{sla show stations}
3219 \subsection{Summary}
3220 \begin{verbatim}
3221 Show SLA Stations
3222 \end{verbatim}
3223 \subsection{Usage}
3224 \begin{verbatim}
3225 Usage: sla show stations
3226        This will list all stations defined in sla.conf
3227
3228 \end{verbatim}
3229
3230
3231 \section{sla show trunks}
3232 \subsection{Summary}
3233 \begin{verbatim}
3234 Show SLA Trunks
3235 \end{verbatim}
3236 \subsection{Usage}
3237 \begin{verbatim}
3238 Usage: sla show trunks
3239        This will list all trunks defined in sla.conf
3240
3241 \end{verbatim}
3242
3243
3244 \section{soft hangup}
3245 \subsection{Summary}
3246 \begin{verbatim}
3247 Request a hangup on a given channel
3248 \end{verbatim}
3249 \subsection{Usage}
3250 \begin{verbatim}
3251 Usage: soft hangup <channel>
3252        Request that a channel be hung up. The hangup takes effect
3253        the next time the driver reads or writes from the channel
3254
3255 \end{verbatim}
3256
3257
3258 \section{stop gracefully}
3259 \subsection{Summary}
3260 \begin{verbatim}
3261 Gracefully shut down Asterisk
3262 \end{verbatim}
3263 \subsection{Usage}
3264 \begin{verbatim}
3265 Usage: stop gracefully
3266        Causes Asterisk to not accept new calls, and exit when all
3267        active calls have terminated normally.
3268
3269 \end{verbatim}
3270
3271
3272 \section{stop now}
3273 \subsection{Summary}
3274 \begin{verbatim}
3275 Shut down Asterisk immediately
3276 \end{verbatim}
3277 \subsection{Usage}
3278 \begin{verbatim}
3279 Usage: stop now
3280        Shuts down a running Asterisk immediately, hanging up all active calls .
3281
3282 \end{verbatim}
3283
3284
3285 \section{stop when convenient}
3286 \subsection{Summary}
3287 \begin{verbatim}
3288 Shut down Asterisk at empty call volume
3289 \end{verbatim}
3290 \subsection{Usage}
3291 \begin{verbatim}
3292 Usage: stop when convenient
3293        Causes Asterisk to perform a shutdown when all active calls have ended.
3294
3295 \end{verbatim}
3296
3297
3298 \section{stun debug}
3299 \subsection{Summary}
3300 \begin{verbatim}
3301 Enable STUN debugging
3302 \end{verbatim}
3303 \subsection{Usage}
3304 \begin{verbatim}
3305 Usage: stun debug
3306        Enable STUN (Simple Traversal of UDP through NATs) debugging
3307
3308 \end{verbatim}
3309
3310
3311 \section{stun debug off}
3312 \subsection{Summary}
3313 \begin{verbatim}
3314 Disable STUN debugging
3315 \end{verbatim}
3316 \subsection{Usage}
3317 \begin{verbatim}
3318 Usage: stun debug off
3319        Disable STUN debugging
3320
3321 \end{verbatim}
3322
3323
3324 \section{udptl debug}
3325 \subsection{Summary}
3326 \begin{verbatim}
3327 Enable UDPTL debugging
3328 \end{verbatim}
3329 \subsection{Usage}
3330 \begin{verbatim}
3331 Usage: udptl debug [ip host[:port]]
3332        Enable dumping of all UDPTL packets to and from host.
3333
3334 \end{verbatim}
3335
3336
3337 \section{udptl debug ip}
3338 \subsection{Summary}
3339 \begin{verbatim}
3340 Enable UDPTL debugging on IP
3341 \end{verbatim}
3342 \subsection{Usage}
3343 \begin{verbatim}
3344 Usage: udptl debug [ip host[:port]]
3345        Enable dumping of all UDPTL packets to and from host.
3346
3347 \end{verbatim}
3348
3349
3350 \section{udptl debug off}
3351 \subsection{Summary}
3352 \begin{verbatim}
3353 Disable UDPTL debugging
3354 \end{verbatim}
3355 \subsection{Usage}
3356 \begin{verbatim}
3357 Usage: udptl debug off
3358        Disable all UDPTL debugging
3359
3360 \end{verbatim}
3361
3362
3363 \section{ulimit}
3364 \subsection{Summary}
3365 \begin{verbatim}
3366 Set or show process resource limits
3367 \end{verbatim}
3368 \subsection{Usage}
3369 \begin{verbatim}
3370 Usage: ulimit {-d|-l|-f|-m|-s|-t|-u|-v|-c|-n} [<num>]
3371        Shows or sets the corresponding resource limit.
3372          -d  Process data segment [readonly]
3373          -l  Memory lock size [readonly]
3374          -f  File size
3375          -m  Process resident memory [readonly]
3376          -s  Process stack size [readonly]
3377          -t  CPU usage [readonly]
3378          -u  Child processes
3379          -v  Process virtual memory [readonly]
3380          -c  Core dump file size
3381          -n  Number of file descriptors
3382
3383 \end{verbatim}
3384
3385
3386 \section{voicemail show users}
3387 \subsection{Summary}
3388 \begin{verbatim}
3389 List defined voicemail boxes
3390 \end{verbatim}
3391 \subsection{Usage}
3392 \begin{verbatim}
3393 Usage: voicemail show users [for <context>]
3394        Lists all mailboxes currently set up
3395
3396 \end{verbatim}
3397
3398
3399 \section{voicemail show zones}
3400 \subsection{Summary}
3401 \begin{verbatim}
3402 List zone message formats
3403 \end{verbatim}
3404 \subsection{Usage}
3405 \begin{verbatim}
3406 Usage: voicemail show zones
3407        Lists zone message formats
3408
3409 \end{verbatim}
3410
3411
3412 \section{zap destroy channel}
3413 \subsection{Summary}
3414 \begin{verbatim}
3415 Destroy a channel
3416 \end{verbatim}
3417 \subsection{Usage}
3418 \begin{verbatim}
3419 Usage: zap destroy channel <chan num>
3420         DON'T USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.  Immediately removes a given channel, whether it is in use or not
3421
3422 \end{verbatim}
3423
3424
3425 \section{zap restart}
3426 \subsection{Summary}
3427 \begin{verbatim}
3428 Fully restart zaptel channels
3429 \end{verbatim}
3430 \subsection{Usage}
3431 \begin{verbatim}
3432 Usage: zap restart
3433         Restarts the zaptel channels: destroys them all and then
3434         re-reads them from zapata.conf.
3435         Note that this will STOP any running CALL on zaptel channels.
3436
3437 \end{verbatim}
3438
3439
3440 \section{zap show cadences}
3441 \subsection{Summary}
3442 \begin{verbatim}
3443 List cadences
3444 \end{verbatim}
3445 \subsection{Usage}
3446 \begin{verbatim}
3447 Usage: zap show cadences
3448        Shows all cadences currently defined
3449
3450 \end{verbatim}
3451
3452
3453 \section{zap show channels}
3454 \subsection{Summary}
3455 \begin{verbatim}
3456 Show active zapata channels
3457 \end{verbatim}
3458 \subsection{Usage}
3459 \begin{verbatim}
3460 Usage: zap show channels [ trunkgroup <trunkgroup> | group <group> | context <context> ]
3461         Shows a list of available channels with optional filtering
3462         <group> must be a number between 0 and 63
3463
3464 \end{verbatim}
3465
3466
3467 \section{zap show channel}
3468 \subsection{Summary}
3469 \begin{verbatim}
3470 Show information on a channel
3471 \end{verbatim}
3472 \subsection{Usage}
3473 \begin{verbatim}
3474 Usage: zap show channel <chan num>
3475         Detailed information about a given channel
3476
3477 \end{verbatim}
3478
3479
3480 \section{zap show status}
3481 \subsection{Summary}
3482 \begin{verbatim}
3483 Show all Zaptel cards status
3484 \end{verbatim}
3485 \subsection{Usage}
3486 \begin{verbatim}
3487 Usage: zap show status
3488        Shows a list of Zaptel cards with status
3489
3490 \end{verbatim}
3491
3492
3493 \section{zap show version}
3494 \subsection{Summary}
3495 \begin{verbatim}
3496 Show the Zaptel version in use
3497 \end{verbatim}
3498 \subsection{Usage}
3499 \begin{verbatim}
3500 Usage: zap show version
3501        Shows the Zaptel version in use
3502
3503 \end{verbatim}
3504
3505