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

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:

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

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:

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

to issue a reconfigure command to a specific phone.

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

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

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

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:

Output of this command resembles:

Show Specific Alert

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

Output of this command resembles:

Show Available Applications

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

Output of this command resembles:

Show Specific Application

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

Output of this command resembles:

or:

Show Available Firmwares

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

Output of this command resembles:

Show Specific Firmware

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

Output of this command resembles:

Displaying Lines

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

where output resembles:

Show Specific Line

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

where output resembles:

Show Available Multicastpages

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

Output of this command resembles:

Show Specific Multicastpage

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

Output of this command resembles:

Show Available Networks

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

Output of this command resembles:

Show Specific Network

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

Output of this command resembles:

Displaying Phones

The DPMA can report phones by performing:

where output resembles:

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

where output resembles:

Show Presence Status

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

where output resembles:

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:

where output resembles:

Tokens

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

where output resembles:

Global Settings

Global settings may be returned by performing:

where output resembles:

Show Available Translations

A listing of available translations is returned by performing:

where output resembles:

Show Specific Translation

A detail for a specific translation is returned by performing:

where output resembles:

Version

The DPMA version may be returned by performing:

where output resembles:

 

Return to Documentation Home I Return to Sangoma Support