Kurgan-Telecom Ru | Информационные технологии

В этой статье мы расскажем как пользоваться Asterisk CLI (Command Line Interface), или проще говоря командной строкой Asterisk. CLI необходима для дебага ошибок и управления самим Asterisk.

1) Для входа в Asterisk CLI необходимо ввести следующие команды:

# rasterisk
или

# asterisk -rvvvvv
Ключ -rvvvvv отвечает за уровень отображения дебага.

Для выполнения команд из консоли Linux можно воспользоваться следующим синтексом:

asterisk -rx "sip show peers"
В кавычках вы указываете какую команду хотите применить.

Для выхода из консоли необходимо ввести "quit" или "exit".

Приведем список существующих команд Asterisk CLI:

logger show channels - выводит список лог файлов
logger set level {DEBUG|NOTICE|WARNING|ERROR|VERBOSE|DTMF} {on|off} - включение/отключение определенного уровня логирования
logger rotate - ротация и новое открытие файлов логирования
logger remove channel - удаляет канал из логирования
logger reload - перезагружает логирование
logger mute - установка паузы на вывод информации в CLI Asterisk (т.е. в консоль не будет сыпаться никакая информация). Отключается это повторным вводом команды.
logger add channel - добавление нового канала для логирования
local show channels - выводит список локальных каналов АТС (внутренние вызовы)
keys show - выводит список ключей RSA
keys init - установка пароля для ключа RSA
indication show - выводит список индикаторов и стран
indication remove - удаление индикатора страны
indication add - установка индикатора для страны
iax2 unregister - снять регистрацию (принудительно) с IAX2 пира
iax2 test losspct - устанавливает % потерянных пакетов для тестирования работоспособности IAX2
iax2 show users [like] - выводит список пользователей IAX
iax2 show threads - выводит список вспомогательных потоков IAX
iax2 show stats - выводит статистику IAX пиров
iax2 show registry - выводит статус регистраций IAX пиров
iax2 show provisioning - выводит список шаблонов IAX для автонастройки
iax2 show peers - выводит информацию об IAX пирах
iax2 show peer - выводит информацию о IAX пире
iax2 show netstats - выводит сетевую статистику о IAX каналах
iax2 show firmware - выводит список доступных прошивок под IAX пользователей
iax2 show channels - выводит активные каналы IAX
iax2 show callnumber usage - выводит текущие записи в таблице IP
iax2 show cache - выводит кэш диалплана IAX
iax2 set mtu - устанавливает размер MTU IAX сообщений
iax2 set debug trunk {on|off} - включение/отключение дебага IAX каналов
iax2 set debug jb {on|off} - включение/отключение дебага джиттер-буфера IAX
iax2 set debug {on|off|peer} - включение/отключение дебага IAX
iax2 reload - перечитать конфигурационные файлы IAX
iax2 prune realtime - очищает кэш realtime
iax2 provision - производит автонастройку IAX пира
http show status - вывести статус HTTP сервера
group show channels - выводит список активных каналов с указанием групп
file convert - конвертация формата аудиофайла
features show - выводит список настроенных коротких кодов
fax show version - показываем версию факсового модуля
fax show stats - выводит историю передачи факсов
fax show settings - показывать глобальные настройки факсов
fax show sessions - показывает статус всех существующих факсовых сессий
fax show session - показывает статус конкретной факсовой сессии
fax show capabilities - показывает информацию о используемых факсовых модулях
fax set debug {on|off} - включение/отключения дебага факсов
dnsmgr status - показывает статус DNS Manager
dnsmgr reload - перезагружает конфигурацию DNS Manager
dnsmgr refresh - выполняет немедленное обновление DNS
dialplan show - выводит подробный список диалпланов
dialplan show globals - показывает глобальные переменные диалплана
dialplan show chanvar - показывает используемые переменные на канале
dialplan set global - установить глобальную переменную в диалплан
dialplan set extenpatternmatchnew true - использовать новый алгоритм набора номеров
dialplan set extenpatternmatchnew false - использовать старый алгоритм набора номеров
dialplan set chanvar -установить переменную на канал
dialplan save - сохранить диалплан в файл
dialplan remove include - удалить "include" из контекста
dialplan remove ignorepat - удалить указанный черный список из контекста
dialplan remove extension - удалить указанный внутренний номер
dialplan remove context - удалить указанный контекст
dialplan reload - перечитать extensions.conf
dialplan debug - включение дебага диалплана
dialplan add include - включить один контекст в другой контекст
dialplan add ignorepat - добавить новый шаблон в черный список
dialplan add extension - добавление внутреннего номера в контекст
devstate list - выводит список состояний устройств
devstate change - изменить состояние внутреннего номера (доступные значения: UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING | RINGINUSE | ONHOLD)
database showkey - выводит данные из БД Asterisk по определенному ключу
database show - выводит данные из БД Asterisk
database query - запустить специальный запрос к astdb
database put - добавить/обновить значение в базе данных
database get - получить из базы данных данные
database deltree - удаление из базы данных дерева ключей/значений
database del - удаление из базы данных ключа/значения
data show providers - выводит доступную для получения, по запросу data get, информацию
data get - запрос на получение данных API
dahdi show version - выводит версию модуля Dahdi
dahdi show status - выводит статус интерфейсных плат Dahdi
dahdi show channel - выводит информацию о конкретном канале
dahdi show channels [group|context] - выводит список активных DAHDI каналов
dahdi show cadences - выводит список каденций
dahdi set swgain {rx|tx} - установить коэффициент усиления звука на канале софтверно
dahdi set hwgain {rx|tx} - установить коэффициент усиления звука на канале хардварно
dahdi set dnd - установить/снять статус DND (Do Not Disturb) на канале
dahdi restart - полный рестарт каналов Dahdi
dahdi destroy channels - разрушить канал Dahdi
dahdi create channels - создать канал Dahdi
core waitfullybooted - ждать полной загрузки Asterisk
core stop when convenient - выключение Asterisk, после того когда закончатся текущие вызовы
core stop now - немедленное выключение Asterisk
core stop gracefully - "теплое" выключение Asterisk
core show warranty - выводит информацию о гарантии на Asterisk
core show version - выводит версию Asterisk
core show uptime [seconds] - выводит информацию о продолжительности работы Asterisk и ОС
core show translation - выводит информацию (матрицу) о перекодировании аудиокодеков
core show threads - выводит информацию о запущенных приложениях Asterisk
core show taskprocessors - выводит информацию о запущенных процессах Asterisk
core show sysinfo - выводит информацию об операционной системе
core show switches - выводит альтернативные маршруты
core show sound - выводит информацию по конкретным звуковым файлам
core show sounds - выводит доступные звуки
core show settings - выводит некоторые настройки ядра Asterisk
core show profile - выводит информацию о профилях
core show license - выводит информацию о версии Asterisk
core show image formats - выводит информацию о поддерживаемых форматах изображений
core show hint - выводит информацию о зарегистрированных кодах (feature code) в Asterisk, по конкретному внутреннему номеру
core show hints - выводит информацию о зарегистрированных кодах (feature code) в Asterisk
core show help - выводит список команд CLI Asterisk
core show hanguphandlers - выводит информацию о разрывах вызовов на конкретном канале
core show hanguphandlers all - выводит информацию о разрывах вызовов на всех каналах
core show function - выводит описание специальных функций диалплана
core show file version [like] - выводит список версий файлов используемых в Asterisk
core show file formats - выводит имена доступных форматов файлов
core show config mappings - выводит информацию о доступных к использованию базах данных
core show codec - выводит информацию о конкретном кодеке
core show codecs - выводит список поддерживаемых аудиокодеков
core show channeltypes - выводит список доступных технологий и протоколов для канала
core show channel - выводит информацию о конкретном канале
core show channels [concise|verbose|count] - выводит информацию о текущих каналах
core show calls [uptime] - выводит информацию о количестве текущих вызовов
core show application - выводит информацию о конкретном приложении диалплана
core show applications [like|describing] - показывает доступные приложения диалплана
core set verbose - установка уровня дебага
core set debug channel - Включение/отключение дебага на канале
core restart when convenient - перезагрузка Asterisk после завершения текущих вызовов
core restart now - немедленная перезагрузка Asterisk
core restart gracefully - мягкий перезапуск Asterisk
core reload - перечитать все конфигурационные файлы
core ping taskprocessor - показывает информацию об отклике приложений Asterisk
core clear profile - чистит информацию о профиле
core abort shutdown - прерывает отключение
config show help - выводит список модулей, которые имеют информацию о настройке
config reload - принудительная перезагрузка модулей с перечиткой конфигурационных файлов
config list - показывает файлы настройки относящиеся к конкретным приложениям Asterisk
confbridge unmute - включить голосовой канал у участников конференции
confbridge unlock - разблокировать конференцию
confbridge show profile users - выводит информацию о доступных профилях пользователей конференций
confbridge show profile user - выводит информацию о конкретном пользовательском профиле конференций
confbridge show profile bridges - выводит информацию о доступных профилях конференций
confbridge show profile bridge - выводит информацию о конкретном профиле конференций
confbridge show menus - показывает доступные меню для разных учетных данных
confbridge show menu - показывает какие команды доступны для управления конференцией
confbridge record stop - остановить запись разговоров в конференции
confbridge record start - начать запись разговоров в конференции
confbridge mute - отключить голосовой канал у участников конференции
confbridge lock - заблокировать конференцию
confbridge list - выводит список существующих конференций и их участников
confbridge kick - удалить участников из конференций
cli show permissions - показывает возможности настройки CLI
cli show aliases - показывает алиасы команд CLI
cli reload permissions - перезагрузка CLI прав пользователей
cli check permissions - показывает какими возможностями для настройки Asterisk обладает пользователь
channel request hangup - запрос завершения вызова на данном канале
channel redirect - перевод вызова в канале
channel originate - инициировать вызов. Пример команды "channel originate SIP/1000 extension 2000@from-internal". После ввода данной команды, Asterisk произведет набор номера 1000 и когда он поднимет трубку, Asterisk наберет номер 2000. Необходимо указывать контекст.
cel show status - выводит статус настроек CEL
cdr submit - запись ожидаемых сообщения в CDR
cdr show status - выводит статус настроек CDR
cdr show active - показывает какие каналы пишутся в CDR
cdr set debug [on|off] - запуск дебага в CDR
cc report status - выводит статус всех Call Completion т.е. функций обратного вызова
cc cancel - снять все Call Completion т.е. функцию обратного вызова, подробнее можно почитать в примере
bridge technology {suspend|unsuspend} - приостановить/возобновить использование технологий установки вызовов (bridge)
bridge technology show - выводит статус возможных технологий установки вызовов
bridge show - выводит информацию о конкретном голосовом канале (bridge)
bridge show all - выводит список всех двухсторонних голосовых каналов (bridgeй)
bridge kick - удалить один из каналов из bridge, т.е. разрушить один голосовой канал
ari show user - выводит информацию по конкретному пользователю ARI
ari show users - выводит список пользователей ARI
ari show status - выводит настройки ARI
ari mkpasswd - шифрование пароля, который используется в ari.conf
aoc set debug - включение дебага для сообщений AOC
agi show commands [topic] - выводит список команд AGI
agi set debug [on|off] - включение/отключение дебага AGI
agi exec - добавить команду AGI в канал Async AGI
agi dump html - показывает список AGI команд в формате HTML
ael set debug {read|tokens|macros|contexts|off} - использование дебага AEL
ael reload - перечитать конфигурационные файлы AEL
acl show - показать используемые ACL (Access Control List)
manager reload - перечитывает конфигурационный файлы, связанные с AMI
manager set debug [on|off] - включение/отключение дебага AMI
manager show command - выводит информацию об определенной команде AMI
manager show commands - выводит список команд AMI
manager show connected - выводит список подключенных пользователей AMI
manager show eventq - выводит список очередей событий
manager show events - выводит список событий AMI
manager show event - выводит информацию о событии AMI
manager show settings - выводит глобальные настройки AMI
manager show users - выводит список настроенных пользователей AMI
manager show user - выводит информацию об указанном пользователе
mfcr2 show version - выводит версию библиотеки OpenR2
mfcr2 show variants - выводит список поддерживаемых вариантов использования каналов MFC/R2
mfcr2 show channels [group|context] - выводит список каналов MFC/R2
mfcr2 set idle - перезагружает канал MFC/R2 и устанавливает его в статус IDLE
mfcr2 set debug - устанавливает канал MFC/R2 в режим дебага
mfcr2 set blocked - перезагружает канал MFC/R2 и устанавливает его в статус BLOCKED
mfcr2 call files [on|off] - включение/отключение MFC/R2 файлов
meetme {mute|unmute} - включает/отключает микрофон для конференций
meetme {lock|unlock} - блокирует/разблокирует конференцию для новых пользователей
meetme list - выводит список активных конференц-комнат
meetme kick - сбросить конференцию или пользователя конференции
mgcp audit endpoint - аудит указанного пира MGCP
mgcp reload - перечитать конфигурационные файлы MGCP
mgcp set debug {on|off} - включение/отключение MGCP дебага
mgcp show endpoints - выводит список MGCP пиров
minivm list accounts - выводит список пользователей, использующих Mini-voicemail
minivm list templates - выводит список шаблонов Mini-voicemail
minivm list zones - выводит список часовых поясов, настроенных в Mini-voicemail
minivm reload - перезагрузка конфигурации Mini-voicemail
minivm show settings - выводит глобальные настройки Mini-voicemail
minivm show stats - выводит статистику Mini-voicemail
mixmonitor {start|stop|list} - выполнить команду MixMonitor
module load - загрузить модуль
module reload - перезагрузить конфигурацию указанного модуля
module show [like] -выводит информацию об указанном модуле
module unload - отключить указанный модуль
moh reload - перезагрузка модуля MusicOnHold
moh show classes - выводит список классов и соответствующих каталогов
moh show files - выводит список звуковых файлов и каталогов, используемых для MusicOnHold
sip show sched - выводит состояние очереди планировщика
sip show registry -выводит список зарегистрированных SIP пиров
sip show peer - выводит информацию об указанном SIP пире
sip show peers - выводит список существующих SIP пиров
sip show objects - выводит список объектов SIP
sip show mwi - выводит список подписок MWI (Message-waiting indicator)
sip show inuse - выводит информацию о статусе пользователей
sip show history - выводит историю запросов SIP по конкретному вызову
sip show domains - выводит список SIP доменов
sip show channel - выводит подробную информацию о SIP канале
sip show channelstats - выводит статистику активных SIP каналов
sip show {channels|subscriptions} - выводит список SIP каналов или подписок
sip set history {on|off} - включение/отключение истории SIP
sip set debug {on|off|ip|peer} - включение/отключение SIP дебага
sip reload - перечитать конфигурационные файлы SIP
sip qualify peer - отправляет пакет OPTIONS в сторону указанного пира
sip prune realtime [peer|all] - удалить кэш базы данных Realtime для пользователя/устройства
sip notify - отправка пакета NOTIFY SIP пользователю
say load [new|old] - перечитать файл say.conf
rtp set debug {on|off|ip} - включение/отключение дебага RTP
rtcp set stats {on|off} - включение/отключение статистики RTCP
rtcp set debug {on|off|ip} - включение/отключение дебага RTCP
realtime update2 - используется для теста переменных RealTime
realtime update - обновляет переменные RealTime
realtime store - создание новой строки в базе RealTime
realtime mysql status - выводит информацию о драйвере MySQL RealTime
realtime mysql cache - выводит кэш таблиц драйвера MySQL RealTime
realtime load - используется для вывода переменных RealTime
realtime destroy - удаляет строку из базы данных RealTime
queue {pause|unpause} member - отключить/подключить пользователя от очереди
queue show rules - выводит настройки из файла queuerules.conf
queue show - выводит информацию об очередях
queue set ringinuse - установка параметра ringinuse для определенной очереди
queue set penalty - установка параметра penalty для определенной очереди
queue reset stats - перезагрузить статистику по очередям
queue remove member - удалить пользователя через из указанной очереди
queue reload {parameters|members|rules|all} - перезагрузить очередь, пользователей, правил обработки вызовов или все сразу
queue add member - добавить пользователя в очередь
pri show version - выводит информацию о версии модуля libpri
pri show span - выводит информацию о конкретной PRI линии
pri show spans - выводит информацию о PRI линиях
pri show debug - выводит информацию о настройках PRI дебага
pri show channels - выводит информацию о канале PRI
pri set debug file - включение дебага PRI и запись его в файл
pri set debug {on|off|hex|intense|0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15} span - включение дебага PRI
pri service enable channel - включение канала PRI
pri service disable channel - отключение канала PRI
pri destroy span - разрушить канал PRI
presencestate list - выводит список пользовательских состояний присутствия
presencestate change - изменить пользовательский статус состояния присутствия
parking show - выводит информацию о парковочных слотах и конкретном слоте
odbc show - выводит список ODBC DSN
no debug channel - отключение дебага на канале (каналах)
sip show settings - выводит глобальные настройки SIP
sip show tcp - выводит список TCP соединений
sip show users - выводит информацию о SIP пользователях
sip show user- выводит информацию о конкретном SIP пользователе
sip unregister - удаление регистрации SIP пира с АТС
sla show stations - выводит список SLA
sla show trunks - выводит список SLA транков
stun set debug {on|off} - включение/отключение STUN дебага
timing test - запуск проверки синхронизации времени
transcoder show - выводит загрузку транскодинга канала DAHDI
udptl set debug {on|off|ip} - включение/отключение дебага UDPTL
udptl show config - выводит настройки UDPTL
ulimit - выводит или устанавливает ограничение на использование ресурсов процессами
voicemail reload - перечитать конфигурационные файлы VoiceMail
voicemail show users - список пользователей, которые используют голосовую почту
voicemail show zones - выводит список часовых поясов, настроенных в голосовой почте
xmldoc dump - собрать XML файлы в указанный файл

Данный список актуален для версии Asterisk 13.3.2