Skip to end of metadata
Go to start of metadata

DPMA and the Asterisk CLI

Loading

The DPMA can be loaded into a running Asterisk from the CLI by performing:

module load res_digium_phone.so

Unloading

The DPMA can be unloaded from a running Asterisk from the CLI by performing:

module unload res_digium_phone.so

Reloading

The DPMA's configuration can be reloaded in a running Asterisk from the CLI by performing:

module reload res_digium_phone.so

Reloading

Icon

The DPMA does not store its data in the Asterisk Realtime Architecture (ARA). Therefore, changes made to its configuration file, res_digium_phone.conf, or any files that it might #include, are only loaded into Asterisk when the DPMA is first loaded by Asterisk (on boot, or when module load is performed) or when the module is *reload*ed from the Asterisk CLI

Checking License Status

License status for the DPMA - validation of the license key from /var/lib/asterisk/licenses/DPMA-<keys>.lic - can be check from the Asterisk CLI by performing:

digium_phones license status

If a valid license is found, the Asterisk CLI will return:

OK, Valid product license found

Reconfiguring Phones

Digium phones that have established a session with the DPMA can be ordered to retrieve new configuration information (credentials, contacts, firmware, etc.) from the Asterisk CLI by performing either:

digium_phones reconfigure all

to issue a reconfigure command to all known phones. Or, by performing:

digium_phones reconfigure phone <phone identifier>

to issue a reconfigure command to a specific phone.

Checking Firmware version

The DPMA can report the firmware version that it is configuring phones to retrieve by performing:

digium_phones show firmware

Output of this command resembles:

pbx*CLI> digium_phones show firmware
--- Firmware Package Settings ---

Phone Model:D40
Firmware Version:1_1_0_12345
URL:http://pbx.example.com/firmware/1_1_0_12345_D40_firmware.eff
File:/var/www/firmware/1_1_0_12345_D40_firmware.eff

Phone Model:D50
Firmware Version:1_1_0_12345
URL:http://pbx.example.com/firmware/1_1_0_12345_D50_firmware.eff
File:/var/www/firmware/1_1_0_12345_D50_firmware.eff

Phone Model:D70
Firmware Version:1_1_0_12345
URL:http://pbx.example.com/firmware/1_1_0_12345_D70_firmware.eff
File:/var/www/firmware/1_1_0_12345_D70_firmware.eff

Displaying Lines

The DPMA can report lines mapped to all phones by performing:

digium_phones show lines

where output resembles:

pbx*CLI> digium_phones show lines
--- Lines Mapped to Phones ---
    302  Internal
    303  Internal
    3011  Internal
--- Lines Un-Mapped to Phones ---
---- 3 SIP Lines Found ----

or the line, and its configuration, for a specific phone by performing:

digium_phones show line <phone identifier>

where output resembles:

pbx*CLI> digium_phones show line 3011
Name: 3011
Type: Internal Line
Dialable Extension: 3011
Transport: udp
Digitmap:
Line Label: Malcolm 3011
Mailbox: malcolm@default
Voicemail URI:
First Name:
Last Name:
Location:
Title:
Language:

Displaying Phones

The DPMA can report phones by performing:

digium_phones show phones

where output resembles:

pbx*CLI> digium_phones show phones
---- Digium Phones ----
302
303
3011
----  3 Phones Found    ----

or for a specific phone, and its configuration, by performing:

digium_phones show phone <phone identifier>

where output resembles:

pbx*CLI> digium_phones show phone malcolm2
Name: 302
Pin:  <Not Set>
MAC: <none>
Ringtone: Digium
Timezone:
NTP Server: default
NTP Resync: default
Web UI enabled: Yes
BLF on unused Line keys: No
Recording enabled: Yes
Logging via syslog: Disabled
Parking Extension: 700
Parking Transfer Type: Blind
ConfigFile: AUTO_GENERATED
Line:  302
Contact: 302.xml

Sessions

Phone sessions, which include useful information like Contact address and MAC, can be displayed by performing:

digium_phones show sessions

where output resembles:

pbx*CLI> digium_phones show sessions
---- Digium Phone Module Active Sessions ----
SessionID:20226687411312545993 SecondsAlive:881     SecondsLastActivity:874     Contact:sip:10.24.19.6:5060;ob       Auth:Yes Inactive:No  MAC:000000000000
SessionID:7971808731750310104  SecondsAlive:881     SecondsLastActivity:874     Contact:sip:10.24.19.181:5060;ob     Auth:Yes Inactive:No  MAC:000000000001
SessionID:513313315897094751   SecondsAlive:881     SecondsLastActivity:881     Contact:sip:10.24.19.105:5060;ob     Auth:Yes Inactive:No  MAC:000000000002
--- Total active sessions:3 ---

Global Settings

Global settings may be returned by performing:

digium_phones show settings

where output resembles:

pbx*CLI> digium_phones show settings
---- Digium Phone Module Global Settings ----
GlobalPin: <Not Set>
Registration Addr: 10.24.13.224
Registration Port: 5060
Service Name: Go 4 Phones
Service Discovery: Enabled
Userlist Authentication: disabled
Config Authentication: disabled
File Directory: /etc/asterisk/digium_phones

Version

The DPMA version may be returned by performing:

digium_phones show version

where output resembles:

malcolm*CLI> digium_phones show version
Digium Phone Module for Asterisk Version 1.1.0
malcolm*CLI>
  • No labels