Asterisk CLI — интерфейс командной строки
Командная строка является мощным инструментом для мониторинга и управления работой Asterisk PBX . При запуске asterisk с флагом -r или -c, появиться следующие приглашение:
Количество 'v' в параметрах задает порог отображаемой информации в консоли для данного подключения. Комбинация -vvvr задаст verbose level 8. Интерфейс командной строки Asterisk имеет свой конфиг — cli.conf
Введите core show help и нажмите enter для получения полного списка команд:
Командная строка поддерживает вывод доступных команд по неполному вводу нажатием 'Tab':
Для получения дополнительной информации о конкретной команде, вы можете ввести core show help <command>. Например:
Вот некоторые полезные команды:
PJSIP
DAHDI
Кодеки
core show translation recalc
core show translation recalc
Тестовый звонок через консоль
Иногда в процессе настройки возникает вопрос «как позвонить из консоли», для того что бы проверить внесенные изменения. С этим может помочь следующая команда:
В результате выполнения которой будет вызван указанный НОМЕР (замените номером на который хотите позвонить) и после его ответа вызовется приложение echo возвращающее все сказанное.
Простые CLI приемы
Есть несколько трюков, которые помогут вам в интерфейсе командной строки Asterisk. Очень удобно завершение неполного ввода клавишей TAB. Если вы введете начало команды и нажмите клавишу Tab, Asterisk попытается завершить имя команды, или покажет возможные команды, которые начинаются с буквы, которые Вы ввели. Например, введите 'co', а затем нажмите клавишу Tab.
Теперь наберите 'cor', и нажмите TAB снова. На этот раз Asterisk завершит слово, т.к. 'core' является единственной командой, которая начинается с 'cor'. Этот трюк также работает с под-командами. Например, наберите 'core show' и нажмите TAB. (Возможно, вам придется дважды нажать вкладку, если вы не поставили пробел после слова 'show'.) Asterisk покажет вам все под-команды.
Повторение предыдущих команд.
Для просмотра ранее введенных команд, нажмите стрелочку вверх, таким образом можно пролистать всю историю назад и вперед.
Run Linux Shell Commands from The Asterisk CLI
Восклицательный знак перед командой позволяет предавать команды оболочке Linux.
Asterisk -rx
Иногда удобно дать команду, или получить информацию, не подключаясь непосредственно к консоли. Для этого используется ключ '-x'.
Например, получить список sip пиров:
Command Syntax and Availability
Commands follow a general syntax of <module name> <action type> <parameters>.
- sip show peers — returns a list of chan_sip loaded peers
- voicemail show users — returns a list of app_voicemail loaded users
- core set debug 5 — sets the core debug to level 5 verbosity.
Commands are provided by the core, or by Asterisk modules. If the component that provides the commands is not loaded, then the commands it provides won’t be available.
Asterisk does support command aliases. You can find information in the Asterisk CLI Configuration section.
Finding Help at the CLI
Command-line Completion
The Asterisk CLI supports command-line completion on all commands, including many arguments. To use it, simply press the <Tab> key at any time while entering the beginning of any command. If the command can be completed unambiguously, it will do so, otherwise it will complete as much of the command as possible. Additionally, Asterisk will print a list of all possible matches, if possible.
Listing commands and showing usage
Once on the console, the ‘help’ alias (for ‘core show help’) may be used to see a large list of commands available for use.
The ‘help’ alias may also be used to obtain more detailed information on how to use a particular command and listing sub-commands. For example, if you type ‘help core show’, Asterisk will respond with a list of all commands that start with that string. If you type ‘help core show version’, specifying a complete command, Asterisk will respond with a usage message which describes how to use that command. As with other commands on the Asterisk console, the help command also responds to tab command line completion.
Help for functions, applications and more
A big part of working with Asterisk involves making use of Asterisk applications and functions. Often you’ll want to know usage details for these, including their overall behavior or allowed arguments and parameters.
The command core show application <application name> or similarly core show function <function name> will show you the usage and arguments.
Module Configuration Help
A very useful addition to Asterisk’s help and documentation features is the command config show help . This command provides detailed information about configuration files, option sections in those files, and options within the sections.