Phones - DPMA and the Asterisk CLI

By Kelli Higdon
6 min

 

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

DPMA supports only a flat-file storage mechanism; 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

Sangoma 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.

If, after running a reconfigure, you receive the message:

Phone '<phone identifier>' will reconfigure shortly.

then your phone has received a reconfigure notice and will reconfigure itself.

If, after running a reconfigure, you receive the message:

Phone '<phone identifier>' has not contacted the server. The server is unaware of the location of this device and can not reconfigure it at this time.

then there is no active session between the phone and the DPMA. Thus, the DPMA cannot send a reconfigure notification to the phone since the DPMA does not know how to contact the phone.

Show Available Alerts

The DPMA can show all available alerts, as defined by type=alert, by performing:

digium_phones show alerts

Output of this command resembles:

pbx*CLI> digium_phones show alerts --- Alerts --- fancy-alert other-alert ---- 2 Alerts found ----

Show Specific Alert

The DPMA can show information about a specific alert, as defined by type=alert, by performing:

digium_phones show <alert identifier>

Output of this command resembles:

malcolm*CLI> digium_phones show alert fancy-alert Name: fancy-alert Alert Info: ai-potato Ring Type: normal Ring Tone: Office

Show Available Applications

The DPMA can show all available applications, as defined by type=application, by performing:

digium_phones show applications

Output of this command resembles:

pbx*CLI> digium_phones show applications --- Applications --- Queue : 205-sales-queue Status : 221-status-dnd ---- 2 Applications found ----

Show Specific Application

The DPMA can show information about a specific application, as defined by type=application, by performing:

digium_phones show application <application identifier>

Output of this command resembles:

pbx*CLI> digium_phones show application 205-sales-queue 205-sales-queue Queue Application ----------------- Queue: sales-queue Member Name: Charles King Location: SIP/205 Member: yes Permission: Details Login Extension: Logout Extension:

or:

pbx*CLI> digium_phones show application 221-status-dnd 221-status-dnd Status Application ------------------- Status: dnd Send486: Yes

Show Available Firmwares

The DPMA can show all available firmwares, as defined by type=firmware, by performing:

digium_phones show firmwares

Output of this command resembles:

pbx*CLI> digium_phones show firmwares --- Configured Firmware Options --- d40-1.1 d40-1.1.1 d70-1.1.1

Show Specific Firmware

The DPMA can show information about a specific firmware, as defined by type=firmware, by performing:

digium_phones show firmware <firmware identifier>

Output of this command resembles:

pbx*CLI> digium_phones show firmware d40-1.1.1 Name: d40-1.1.1 Model: D40 Version: 1_1_1_0_49993 File: 1_1_1_0_49993_D40_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 ----

Show Specific Line

The DPMA can show information about a specific line, as defined by type=line, 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 PLAR Number: Voicemail URI: Re-registration: 300 Registration Retry Interval: 25 Registration Max Retries: 5 First Name: Last Name: Location: Title:

Show Available Multicastpages

The DPMA can show all available multicast pages, as defined by type=multicastpage, by performing:

digium_phones show multicastpages

Output of this command resembles:

pbx*CLI> digium_phones show multicastpages --- Multicastpages --- allpage emergencypage ---- 2 Multicastpages found ----

Show Specific Multicastpage

The DPMA can show information about a specific multicastpage, as defined by type=multicastpage, by performing:

digium_phones show multicastpage <multicastpage identifier>

Output of this command resembles:

pbx*CLI> digium_phones show multicsatpage allpage Name: allpage Alias: Page All Address: 239.0.0.101 Port: 33000 Priority: 10 Interrupt: 0

Show Available Networks

The DPMA can show all available networks, as defined by type=network, by performing:

digium_phones show networks

Output of this command resembles:

pbx*CLI> digium_phones show networks --- Networks --- all-networks default-network network1 ---- 3 Networks found ----

Show Specific Network

The DPMA can show information about a specific network, as defined by type=network, by performing:

digium_phones show network <network identifier>

Output of this command resembles:

pbx*CLI> digium_phones show network all-networks Name: all-networks Alias: All Networks CIDR: 0.0.0.0/0 Registration Address: pbx.example.com Registration Port: 5060 File URL Prefix: http://pbx.example.com/firmware/ NTP Server: 0.digium.pool.ntp.org syslog Server: <Not Set> syslog Port: <Not Set> Network VLAN Discovery Mode: <Not Set> Network VLAN ID: 0 Network VLAN Quality of Service Level: 0 SIP DSCP: -1 RTP DSCP: -1

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 230 Name: 230 Group Pin: <Not Set> Pin: <Not Set> MAC: <none> Active Ringtone: Digium Timezone: Australia/Sydney NTP Resync: 86400 Web UI enabled: Yes BLF on unused Line keys: Yes Recording enabled: Yes Use Local Contact Storage: No Parking Extension: 700 D40 Logo File: None D45 Logo File: None D50 Logo File: None D60 Logo File: None D62 Logo File: None D65 Logo File: None D70 Logo File: None Login Password: <Set> Accept Local Calls From: any Electronic Hook Switch: auto Name Format: last_first Preferences Locked: No Logout enabled: No Parking Transfer Type: Blind ConfigFile: AUTO_GENERATED Line: 230 Contacts Display Items: None Contact: 230.xml BLF Items: 230-blf-items.xml Contacts Max Subscriptions: 40 Multicast Page: allpage Preferred Firmware: d40-1.1.1 Preferred Firmware: d50-1.1.1 Preferred Firmware: d70-1.1.1 LCD Brightness: 5 LCD Contrast: 5 LCD Backlight Dimming: Off LCD Backlight Timeout: <timeout disabled> LCD Backlight Dimming Brightness: 0 Default Font Size: <Use Default> Active Locale: en_US Ringer Volume: 5 Speaker Volume: 5 Handset Volume: 5 Headset Volume: 5 Reset Volume levels between calls: Yes Headset Answer: No Ring Headset Only: No Call Waiting Tone: Yes LAN Port Mode: Auto PC Port Mode: Auto Application: Queue, 230-sales-queue Application: Status, 230-status-available Enable Check Sync: Yes Transport TLS Allowed: <Use Default>

Show Presence Status

The presence status of a Sangoma phone can be shown by performing:

digium_phone show status <phone identifier>

where output resembles:

PBX*CLI> digium_phones show status 101 (*) 1: available 2: available - Home Office 3: dnd 4: dnd - Office Closed 5: away 6: away - With Customer 7: away - Lunch 8: xa 9: xa - Vacation 10: chat PBX*CLI>

here, one will see all presence options for the phone as well as the currently active presence, as indicated by the Asterisk.

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:0019159BBA2C SessionID:7971808731750310104 SecondsAlive:881 SecondsLastActivity:874 Contact:sip:10.24.19.181:5060;ob Auth:Yes Inactive:No MAC:0019159BBA9D SessionID:513313315897094751 SecondsAlive:881 SecondsLastActivity:881 Contact:sip:10.24.19.105:5060;ob Auth:Yes Inactive:No MAC:0019159BD025 --- Total active sessions:3 ---

Tokens

A listing of phones with valid tokens can be retrieved by performing:

digium_phones show tokens

where output resembles:

malcolm2*CLI> digium_phones show tokens ---- Valid Tokens ---- 104 MAC:000AA0000001 URI:pjsip:10.1.2.1:5060 SessionID:12312312312312312311 105 MAC:000AA0000002 URI:pjsip:10.1.2.2:5060 SessionID:12312312312312312312 101 MAC:000AA0000003 URI:pjsip:10.1.2.3:5060 SessionID:12312312312312312313 102 MAC:000AA0000004 URI:pjsip:10.1.2.4:5060 SessionID:12312312312312312314 103 MAC:000AA0000005 URI:pjsip:10.1.2.5:5060 SessionID:12312312312312312315 ---- 5 Tokens Found ----

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 ---- Server UUID: myserver GlobalPin: <Not Set> Service Discovery: Enabled Service Disc. Name: Go 4 Phones Service Disc. Addr: 10.1.2.3 Service Disc. Port: 5060 Userlist Authentication: disabled Config Authentication: disabled File Directory: /etc/asterisk/digium_phones PJSIP message context: dpma_pjsip_message_context

Show Available Translations

A listing of available translations is returned by performing:

digium_phones show translations

where output resembles:

pbx*CLI> digium_phones show translations --- Translation tables --- de_DE pt_PT_and_pt_BR es_ES_and_es_MX fr_FR_and_fr_CA_and_fr_BE nl_NL_and_nl_BE it_IT

Show Specific Translation

A detail for a specific translation is returned by performing:

digium_phones show translation de_DE

where output resembles:

--- de_DE --- INBOX ==> INBOX Work ==> Arbeit Family ==> Familie Friends ==> Freunde Recordings ==> Aufnahmen

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 2.0.0 malcolm*CLI>

 

Related content

Return to Documentation Home I Return to Sangoma's Help Center