Asterisk CLI

2024年8月19日 (月) 06:19時点におけるTakahashi (トーク | 投稿記録)による版 (ヘルプ)

Asterisk Command Line Interface
Asteriskの基本となる管理インタフェース。

目次

CLIの起動と終了

Asteriskをバックグラウンドで起動している場合には

asterisk -vvvcr

のようにして接続する。
終了するにはCLIプロンプトで

*CLI> quit

ヘルプ

? で、その階層で使用できるコマンドの一覧が、helpでコマンドとその説明が表示される。
例えばpjsipコマンドなら

*CLI> pjsip show ?
aor                    aors                   auth                   auths
channel                channels               channelstats           contact
contacts               endpoint               endpoints              history
identifiers            identifies             identify               qualify
registration           registrations          scheduled_tasks        settings
subscription           subscriptions          transport              transport-monitors
transports             unidentified_requests  version

上記のように表示される。?それ自体はエコーバックされない。

コマンドの概念

Asterisk 1.4系でトップのコマンドは以下の例のようになっている。

*CLI> ?
!           abort       add         ael         agent       agi
cdr         clear       convert     core        dahdi       database
debug       dialplan    dnsmgr      dont        dump        extensions
feature     file        group       help        http        iax2
include     indication  load        local       logger      manager
meetme      mixmonitor  module      moh         no          originate
queue       realtime    reload      remove      restart     rtcp
rtp         say         set         show        sip         sla
soft        stop        stun        transcoder  udptl       unload
voicemail   zap

基本的に、トップのコマンドは「モジュール」の名称(機能)である。ただし、一部のコマンドに関してはモジュールに依存しておらず、Asterisk本体に組み込み。PBXコア部分の機能はcoreで始まるコマンドになる。
このコマンドはAsterisk 1.2まではきれいにモジュールに分けられていなかったのだが、1.4系から整理が始まり、1.6系ではモジュール単位に分割がかなり進んでいる。つまり、コマンドはモジュールに依存しているので、トップで使えるコマンドの数は読み込んでいるモジュールの数に依存する。例えばSIPチャネルを使用していない場合(chan_sipを読み込んでいない場合)には、sip コマンドは現れない。

コマンド解説

  • Asterisk 1.6系CLI
Asterisk_1.6_CLI
現在、整備中です。協力していただける方はぜひ執筆を。