PBX GUI - fwconsole commands (13+)

"fwconsole" is the Linux command that controls FreePBX 13+ from the Linux command prompt.  

To access the command prompt, log-in to the machine where you installed FreePBX/Asterisk using your "root" username and password.  You can do so by accessing the keyboard of the machine where you installed FreePBX, or remotely using an SSH client such as Putty.

Then type one of the following "fwconsole" commands below

Command List

Stop/Start/Restart

Open

This is how FreePBX starts asterisk and any other processes it need.  You should always start and restart asterisk with the amportal command not the service asterisk or /etc/init.d/asterisk commands

fwconsole stop

fwconsole start

fwconsole restart

Chown

Open

fwconsole chown - This will change ownership of all files and directories that FreePBX needs to be owned by the apache user.

• See verbose details about chown operations (ownership and permissions per file)

  [root@freepbxdev1 userman]# fwconsole chown --verbose Setting /var/lib/asterisk/ucp/out.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/err.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/ucp.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/config.json owner to: asterisk:asterisk, with permissions of: 644 

• Chown a specific module

  [root@Andrews15 framework]# fwconsole chown --module asteriskinfo --verbose Taking too long? Customize the chown command, See http://wiki.freepbx.org/display/FOP/FreePBX+Chown+Conf Setting Permissions... Setting specific permissions... Setting /var/www/html/admin/modules/asteriskinfo to permissions of: 755 Setting /var/www/html/admin/modules/asteriskinfo/i18n to permissions of: 755 Setting /var/www/html/admin/modules/asteriskinfo/i18n/bg_BG to permissions of: 755 Setting /var/www/html/admin/modules/asteriskinfo/i18n/bg_BG/LC_MESSAGES to permissions of: 755 Setting /var/www/html/admin/modules/asteriskinfo/i18n/bg_BG/LC_MESSAGES/asteriskinfo.mo to permissions of: 644 Setting /var/www/html/admin/modules/asteriskinfo/i18n/bg_BG/LC_MESSAGES/asteriskinfo.po to permissions of: 644 [...] Finished setting permissions

• Chown a specific file/directory

  [root@localhost ~]# fwconsole chown --verbose --file=/var/www/html/admin/modules/timeconditions/bin/schedtc.php Taking too long? Customize the chown command, See http://wiki.freepbx.org/display/FOP/FreePBX+Chown+Conf Setting Permissions...     Collecting Files...Done Setting /var/www/html/admin/modules/timeconditions/bin/schedtc.php owner to: asterisk:asterisk, with permissions of: 644 Setting /var/www/html/admin/modules/timeconditions/bin/schedtc.php owner to: asterisk:asterisk, with permissions of: 755 Finished setting permissions

   

Certificate Management

Doctrine

This command is used to export out table information to be used in FreePBX table creation for module installations

Two formats are supported. XML and PHP.

The XML should be used in the module.xml file

The PHP code should be used inside install.php or the module's class.

Reload

Open

fwconsole reload - This will perform a reload of all the dialplan in Asterisk and all the modules in asterisk.  This is the same as pressing the "Apply Changes" button in the GUI of FreePBX

Unlock

Open

fwconsole unlock xxxxxxxxxxxxxxxx- The fwconsole unlock command will unlock the GUI login of FreePBX to let you into the FreePBX GUI without the username and password.  This is handy if you lost or misplaced your FreePBX GUI username or password and need to get into the GUI to change or setup a new user.  You need to replace the xxxxxxx with your PHP session ID.  Follow the steps below.

• Bring up the main login page to FreePBX in your browser.  Such as http://192.168.0.2/admin

• Do a "ctrl a" to highlight the whole page and look to the left center of the screen for some text.  This is your unique php session ID.  Copy this into your clipboard.

• Go into the linux CLI and type the following command replacing the session ID below with your own.

  [root@localhost ~]# fwconsole unlock ppnr8l1vle32s3q8b79s4n1sp7 Please wait... session unlocked! [root@localhost ~]#

• Go refresh your browser page and it will log you in this one time automatically for you based on that php session ID. Now you can go add or change the FreePBX admin users.

Open

Userman

This command provides information about User Manager

• Run synchronization for external authentication engines

  [root@freepbxdev1 userman]# fwconsole userman sync Starting Sync...

• Get verbose details about synchronization status

  [root@freepbxdev1 userman]# fwconsole userman sync --verbose Starting Sync...

Util

General Utility functions for FreePBX

• Clean up playback cache. This is normally run through a cron job. It removes any cached media (browser playback, moh/recording temp files,) that is over 60 days old.

  [root@freepbxdev1 paging]# fwconsole util cleanplaybackcache Starting Cache cleanup Finished cleaning up cache

• Used to check all signatures on the system. Does not return any output

  [root@freepbxdev1 paging]# fwconsole util signaturecheck [root@freepbxdev1 paging]#

• Runs a repair against the SQL Databases

  [root@freepbxdev1 paging]# fwconsole util tablefix Attempting to repair MySQL Tables this may take a while MySQL Tables Repaired

• Repair Asterisk Database (AstDB)

  [root@58448910 modules]# fwconsole util resetastdb

   

• Clear Unused Devices :  This will clear all the unused devices created by Webrtc, Zulu modules.

  [root@58448910 modules]# fwconsole util clearunuseddevices

Database

fwconsole m This will connect you to the mysql database as the FreePBX user automatically based on the username and password for MySQL in /etc/freepbx.conf

Module Administration

Command line utility for controlling FreePBX Module installation.

Edge modules:

In Framework 13.0.69 we added the ability to install edge modules. To upgrade to a module in the edge track pass the --edge flag

• Check Module Dependencies

  [root@xxxxxx ~]# fwconsole ma checkdepends core All dependencies met for module core

• Disable a module

  [root@freepbxdev1 faxpro]# fwconsole ma disable asterisk-cli Module asterisk-cli successfully disabled Updating Hooks...Done

• Download a Module

  [root@xxxxxx ~]# fwconsole ma download core No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded
  [root@xxxxxx ~]# fwconsole ma download <url> No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded

• Download a specific module

  [root@xxxxxx ~]# fwconsole ma download core --tag 1.2.3 No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded

• Download and install a Module

  [root@xxxxxx ~]# fwconsole ma downloadinstall core No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded Checking if directdids need migrating..already done updating zap callgroup, pickupgroup..not needed checking for delay_answer field ..already exists checking for reversal field ..already exists checking for pricid field ..already exists Migrating pickup groups to named pickup groups Migrating call groups to named call groups Checking if trunk table migration required..not needed Checking if privacy manager options exists..already exists Checking for noanswer_cid field..already exists Checking for busy_cid field..already exists Checking for chanunavail_cid field..already exists Checking for noanswer_dest field..already exists Checking for busy_dest field..already exists Checking for chanunavail_dest field..already exists Unable to add index to extensions field in users Checking for General Setting migrations..not needed Deleting unused globals..done Converting IAX notransfer to transfer if needed..updated 0000 records deleting obsoleted record_in and record_out entries..ok checking for dest field in outbound_routes..already exists checking for continue field in trunks..already exists upgrading any zap trunks to dahdi if found..ok Checking for possibly invalid emergency caller id fields..none found Generating CSS...Done Module core successfully installed Updating Hooks...Done
  [root@xxxxxx ~]# fwconsole ma downloadinstall <url> No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded Checking if directdids need migrating..already done updating zap callgroup, pickupgroup..not needed checking for delay_answer field ..already exists checking for reversal field ..already exists checking for pricid field ..already exists Migrating pickup groups to named pickup groups Migrating call groups to named call groups Checking if trunk table migration required..not needed Checking if privacy manager options exists..already exists Checking for noanswer_cid field..already exists Checking for busy_cid field..already exists Checking for chanunavail_cid field..already exists Checking for noanswer_dest field..already exists Checking for busy_dest field..already exists Checking for chanunavail_dest field..already exists Unable to add index to extensions field in users Checking for General Setting migrations..not needed Deleting unused globals..done Converting IAX notransfer to transfer if needed..updated 0000 records deleting obsoleted record_in and record_out entries..ok checking for dest field in outbound_routes..already exists checking for continue field in trunks..already exists upgrading any zap trunks to dahdi if found..ok Checking for possibly invalid emergency caller id fields..none found Generating CSS...Done Module core successfully installed Updating Hooks...Done

Bulk Import

If the Bulk Handler module is installed, you can use the command line to import a csv file as follows:

You must specify the import type and the file name to a valid csv file for import.

CLI Examples:

EPM

• Add Mapping to Extension Mapping

  # fwconsole epm addmapping 4101 --brand=sangoma --mac=005058500002 --template=sangomatest --model=S700 --account=account1 Extension 4101 added successfully.

• List Extensions

  # fwconsole epm listextensions ALL +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+ | Extension | Brand       | MAC          | Template         | Model    | Account  | Expansion 1 | Rebuild | VPN                 | +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+ | 1012      | Grandstream | 000B82800001 | grandstream-test | GXP-2170 | account1 |             | 1       |                     | | 4101      | sangoma     | 005058500003 | sangomatest      |          | account1 |             |         |                     | | 4102      | Yealink     | 001565211111 | yealink-base     | SIP-T26P | account1 | EXP38-1     | 1       |                     | | 4103      | Sangoma     | 005058500001 | sangomatest      | S500     | account1 | EXP100-1    | 1       | 4103 - 4103 (ID: 4) | | 4104      | Sangoma     | 005058500002 | sangomatest      | S700     | account1 |             | 1       |                     | +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+    # fwconsole epm listextensions ALL --detail +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+ | Extension | Brand       | MAC          | Template         | Model    | Account  | Accessory | Expansion 1 | Expansion 2 | Expansion 3 | Expansion 4 | Expansion 5 | Expansion 6 | BLF Substitution | BLF Label | Rebuild | VPN                 | Repeater 1 | Repeater 2 | Repeater 3 | Multicell | +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+ | 1012      | Grandstream | 000B82800001 | grandstream-test | GXP-2170 | account1 |           |             |             |             |             |             |             |                  |           | 1       |                     |            |            |            |           | | 4101      | sangoma     | 005058500003 | sangomatest      |          | account1 |           |             |             |             |             |             |             |                  |           |         |                     |            |            |            |           | | 4102      | Yealink     | 001565211111 | yealink-base     | SIP-T26P | account1 |           | EXP38-1     |             |             |             |             |             | None             |           | 1       |                     |            |            |            |           | | 4103      | Sangoma     | 005058500001 | sangomatest      | S500     | account1 |           | EXP100-1    | EXP100-2    | EXP100-3    | EXP100-4    | EXP100-5    | EXP100-6    | None             |           | 1       | 4103 - 4103 (ID: 4) |            |            |            |           | | 4104      | Sangoma     | 005058500002 | sangomatest      | S700     | account1 |           |             |             |             |             |             |             |                  |           | 1       |                     |            |            |            |           | +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+

• List Templates

   # fwconsole epm listtemplates +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+ | Brand       | Template Name        | Destination | Time Zone | Provision Type | Provision Address | Background         | Firmware | Internal Default | External Default | +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+ | grandstream | grandstream-test     | 10.100.0.3  | -06:00    | TFTP           | 10.100.0.3        | digit-on-phone.png | 1.14     |                  |                  | | sangoma     | sangomatest          | 10.100.0.3  | -06:00    | HTTP           | 10.100.0.3        | digit-on-phone.png | 1.23     |                  |                  | | yealink     | yealink-base         | 10.100.0.3  | -06:00    | TFTP           | 10.100.0.3        | sangomapad.png     | 1.16     | Yes              | Yes              | +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+

• Reboot Devices

  # fwconsole epm reboot 4103 Only works for Sangoma phones Extension 4103 sent reboot command.    # fwconsole epm reboot sangomatest Only works for Sangoma phones Extension 4103 sent reboot command Extension 4104 sent reboot command Extension 4101 sent reboot command

• Rebuild Configuration Files

  # fwconsole epm rebuild 4103 Extension 4103 rebuilt       # fwconsole epm rebuild sangomatest Extension 4103 rebuilt Extension 4104 rebuilt Extension 4101 rebuilt

• Rebuild and Update Devices

  # fwconsole epm rebuildupdate 4103 Extension 4103 rebuilt Update command sent to 4103       # fwconsole epm rebuildupdate sangomatest Extension 4103 rebuilt Extension 4104 rebuilt Extension 4101 rebuilt Update command sent to 4103 Update command sent to 4104 Update command sent to 4101

• Remove Devices

  # fwconsole epm remove 4103 4103 removed succesfully

• Update Devices

  # fwconsole epm update 4103 Update command sent to 4103        # fwconsole epm update sangomatest Update command sent to 4103 Update command sent to 4104 Update command sent to 4101

• Logout device (hotdesking) - Endpoint ver. 15.0.27.39+

  # fwconsole endpoint logout 6013 success     << device reboots >>     # fwconsole epm logout 6013 Extension 6013-1 is already in logged out mode

Notification

• List Notifications

  [root@freepbxdev1 faxpro]# fwconsole notification --list +---------------+-------------------------+----------------------------------------------------------+ | Module        | ID                      | Text                                                     | +---------------+-------------------------+----------------------------------------------------------+ | freepbx       | FW_UNSIGNED             | You have 95 unsigned modules                             | | freepbx       | NEWUPDATES              | There are 3 modules available for online upgrades        | | cron_manager  | EXECFAIL                | Cronmanager encountered 1 Errors                         | | dahdiconfig   | etcdahdimodules         | File /etc/dahdi/modules is not owned by asterisk         | | dahdiconfig   | etcdahdisystem.conf     | File /etc/dahdi/system.conf is not owned by asterisk     | | dahdiconfig   | etcmodprobe.ddahdi.conf | File /etc/modprobe.d/dahdi.conf is not owned by asterisk | | freepbx       | modules_disabled        | You have 10 disabled modules                             | | cidlookup     | noauth                  | OpenCNAM Requires Authentication                         | | fax           | invalid_email           | Invalid Email for Inbound Fax                            | | freepbx       | NEWMODS                 | 1 New modules are available                              | | retrieve_conf | SYMLINKNOTICE           | Symlink Conflict Resolved                                | | sipstationdid | ss7149223196            | SIPSTATION DID routed                                    | +---------------+-------------------------+----------------------------------------------------------+
  [root@freepbxdev1 faxpro]# fwconsole notification --list --json [["freepbx","FW_UNSIGNED","You have 95 unsigned modules"],["freepbx","NEWUPDATES","There are 3 modules available for online upgrades"],["cron_manager","EXECFAIL","Cronmanager encountered 1 Errors"],["dahdiconfig","etcdahdimodules","File \/etc\/dahdi\/modules is not owned by asterisk"],["dahdiconfig","etcdahdisystem.conf","File \/etc\/dahdi\/system.conf is not owned by asterisk"],["dahdiconfig","etcmodprobe.ddahdi.conf","File \/etc\/modprobe.d\/dahdi.conf is not owned by asterisk"],["freepbx","modules_disabled","You have 10 disabled modules"],["cidlookup","noauth","OpenCNAM Requires Authentication"],["fax","invalid_email","Invalid Email for Inbound Fax"],["freepbx","NEWMODS","1 New modules are available"],["retrieve_conf","SYMLINKNOTICE","Symlink Conflict Resolved"],["sipstationdid","ss7149223196","SIPSTATION DID routed"]]

• Delete notification (by ID)

  [root@freepbxdev1 faxpro]# fwconsole notification --delete dahdiconfig etcdahdimodules Deleting notification Notification Deleted [root@freepbxdev1 faxpro]# fwconsole notification --list +---------------+-------------------------+----------------------------------------------------------+ | Module        | ID                      | Text                                                     | +---------------+-------------------------+----------------------------------------------------------+ | freepbx       | FW_UNSIGNED             | You have 95 unsigned modules                             | | freepbx       | NEWUPDATES              | There are 3 modules available for online upgrades        | | cron_manager  | EXECFAIL                | Cronmanager encountered 1 Errors                         | | dahdiconfig   | etcdahdisystem.conf     | File /etc/dahdi/system.conf is not owned by asterisk     | | dahdiconfig   | etcmodprobe.ddahdi.conf | File /etc/modprobe.d/dahdi.conf is not owned by asterisk | | freepbx       | modules_disabled        | You have 10 disabled modules                             | | cidlookup     | noauth                  | OpenCNAM Requires Authentication                         | | fax           | invalid_email           | Invalid Email for Inbound Fax                            | | freepbx       | NEWMODS                 | 1 New modules are available                              | | retrieve_conf | SYMLINKNOTICE           | Symlink Conflict Resolved                                | | sipstationdid | ss7149223196            | SIPSTATION DID routed                                    | +---------------+-------------------------+----------------------------------------------------------+

Module System Manager

List Settings

Change a setting

Qxact Reports

Running fwconsole qxact will display help text:

To re-import all the existing rotated queue_log files run:

Paging Pro

• Cleanup stale pages and add needed pages (This is also run as a cron in crontab every minute. There it's called: */1 * * * * /var/lib/asterisk/bin/pagepro-scheduler.php 2>&1 >/dev/null)
  Run command with --verbose to get detailed data

  [root@freepbxdev1 framework]# fwconsole pagingpro --clean --verbose Found scheduled page for ID 500 occuring at 1466527800

• List active scheduled pages

  [root@freepbxdev1 framework]# fwconsole pagingpro --list +---------+------------+-------------+ | Page ID | Time       | Cron Exists | +---------+------------+-------------+ | 500     | 1466527800 | Yes         | +---------+------------+-------------+

• List specific scheduled page by id

  [root@freepbxdev1 framework]# fwconsole pagingpro --list 500 +---------+------------+-------------+ | Page ID | Time       | Cron Exists | +---------+------------+-------------+ | 500     | 1466527800 | Yes         | +---------+------------+-------------+

• Execute a scheduled page immediately (for testing) using the paging pro page scheduler processes

  [root@freepbxdev1 framework]# fwconsole pagingpro --execute 500 [root@freepbxdev1 framework]# <phones should be ringing>

Phone Apps

• Get statuses of BLF lights for extension

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 +-----------------+------------+ | ID              | BLF Status | +-----------------+------------+ | Call Forward    | Inactive   | | Conference      | Inactive   | | DND             | Inactive   | | Follow Me       | Active     | | Parking         | Inactive   | | Queues          | Inactive   | | Queue Agent     | Active     | | Time Conditions | Inactive   | | Voicemail       | Active     | | Call Flow       | Inactive   | +-----------------+------------+

• Get status of BLF lights for single Application

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 "Parking" +---------+------------+ | ID      | BLF Status | +---------+------------+ | Parking | Inactive   | +---------+------------+

• Get more information about said hint by adding "--verbose"

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 "Call Flow" --verbose +-----------+------------+------------------+ | ID        | BLF Status | Hint             | +-----------+------------+------------------+ | Call Flow | Inactive   | Custom:DAYNIGHT0 | +-----------+------------+------------------+

pm2

Used to manage background/long running processes

• List Processes

  [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+-----+----------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU | Mem      | +--------------+-------+--------+----------+---------------------+-----+----------+ | xmpp         | 8495  | online | 0        | 6 hours, 29 minutes | 0%  | 218.13MB | | restapps     | 8665  | online | 0        | 6 hours, 29 minutes | 0%  | 47.63MB  | | zulu         | 8825  | online | 0        | 6 hours, 29 minutes | 0%  | 94.29MB  | | ucpnode      | 10048 | online | 0        | 6 hours, 28 minutes | 0%  | 73.53MB  | | qcallback    | 16218 | online | 30       | 5 hours, 54 minutes | 0%  | 29.59MB  | +--------------+-------+--------+----------+---------------------+-----+----------+

• Stop Process

  [root@freepbxdev1 ~]# fwconsole pm2 --stop xmpp Process Stopped [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+---------+----------+---------------------+-----+---------+ | Process Name | PID   | Status  | Restarts | Uptime              | CPU | Mem     | +--------------+-------+---------+----------+---------------------+-----+---------+ | xmpp         | 0     | stopped | 0        | 0                   | 0%  | 0.00B   | | restapps     | 8665  | online  | 0        | 6 hours, 30 minutes | 0%  | 47.63MB | | zulu         | 8825  | online  | 0        | 6 hours, 30 minutes | 0%  | 94.29MB | | ucpnode      | 10048 | online  | 0        | 6 hours, 29 minutes | 0%  | 73.54MB | | qcallback    | 16218 | online  | 30       | 5 hours, 55 minutes | 0%  | 29.59MB | +--------------+-------+---------+----------+---------------------+-----+---------+

• Restart Process

  [root@freepbxdev1 ~]# fwconsole pm2 --restart xmpp Process Restarted [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+------+----------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU  | Mem      | +--------------+-------+--------+----------+---------------------+------+----------+ | xmpp         | 8299  | online | 0        | 4 seconds           | 102% | 117.13MB | | restapps     | 8665  | online | 0        | 6 hours, 30 minutes | 0%   | 47.63MB  | | zulu         | 8825  | online | 0        | 6 hours, 30 minutes | 0%   | 94.29MB  | | ucpnode      | 10048 | online | 0        | 6 hours, 29 minutes | 0%   | 73.54MB  | | qcallback    | 16218 | online | 30       | 5 hours, 56 minutes | 0%   | 29.59MB  | +--------------+-------+--------+----------+---------------------+------+----------+

• Delete Process (Only removes and stops it from the Process Management Module, does not remove the module itself)

  [root@freepbxdev1 ~]# fwconsole pm2 --delete xmpp Process Stopped and Deleted [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+-----+---------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU | Mem     | +--------------+-------+--------+----------+---------------------+-----+---------+ | restapps     | 8665  | online | 0        | 6 hours, 31 minutes | 0%  | 47.63MB | | zulu         | 8825  | online | 0        | 6 hours, 31 minutes | 0%  | 94.29MB | | ucpnode      | 10048 | online | 0        | 6 hours, 30 minutes | 0%  | 73.55MB | | qcallback    | 16218 | online | 30       | 5 hours, 56 minutes | 0%  | 29.59MB | +--------------+-------+--------+----------+---------------------+-----+---------+

• Tail log (Used to tail logs for an application/process)

  [root@freepbxdev1 ~]# fwconsole pm2 --log restapps --lines 20 OUT > ==> /var/log/asterisk/restapps_err.log <== ==> /var/log/asterisk/restapps_out.log <== 2017-04-12 01:34 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 01:34 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 01:48 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 02:02 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 02:17 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE

• Update PM2 (Used to update the PM2 binary in memory, this will stop all applications to update the PM2 library!)

  [root@freepbxdev1 ~]# fwconsole pm2 --update Be sure to have the latest version by doing `npm install pm2@latest -g` before doing this procedure. [PM2] Saving current process list... [PM2] Stopping PM2... [PM2] Applying action deleteProcessId on app [all](ids: 1,2,3,4) [PM2] [ucpnode](3) ✓ [PM2] [restapps](1) ✓ [PM2] [qcallback](4) ✓ [PM2] [zulu](2) ✓ [PM2] All processes have been stopped and deleted [PM2] PM2 stopped [PM2] Spawning PM2 daemon with pm2_home=/home/asterisk/.pm2 [PM2] Restoring processes located in /home/asterisk/.pm2/dump.pm2 [PM2] Process /usr/src/freepbx/restapps/restapps.php restored [PM2] Process /usr/src/freepbx/zulu/node/index.js restored [PM2] Process /usr/src/freepbx/ucpnode/node/index.js restored [PM2] Process /usr/src/freepbx/vqplus/queue-callback.php restored >>>>>>>>>> PM2 updated ┌───────────┬────┬──────┬──────┬────────┬─────────┬────────┬──────┬───────────┬──────────┐ │ App name  │ id │ mode │ pid  │ status │ restart │ uptime │ cpu  │ mem       │ watching │ ├───────────┼────┼──────┼──────┼────────┼─────────┼────────┼──────┼───────────┼──────────┤ │ qcallback │ 3  │ fork │ 9316 │ online │ 0       │ 0s     │ 46%  │ 18.5 MB   │ disabled │ │ restapps  │ 0  │ fork │ 9289 │ online │ 0       │ 0s     │ 168% │ 33.4 MB   │ disabled │ │ ucpnode   │ 2  │ fork │ 9305 │ online │ 0       │ 0s     │ 59%  │ 15.1 MB   │ disabled │ │ zulu      │ 1  │ fork │ 9295 │ online │ 0       │ 0s     │ 71%  │ 17.8 MB   │ disabled │ └───────────┴────┴──────┴──────┴────────┴─────────┴────────┴──────┴───────────┴──────────┘  Use `pm2 show <id|name>` to get more details about an app Update PM2 Process

• Reload Log file pointers (used during logrotates)

  [root@uc-85436011 ~]# fwconsole pm2 --reload-logs All logs reloaded

Setting

Used to alter Advanced Settings from the bash prompt:

Sound Languages

• List Available Packages

  [root@Andrew14 soundlang]# fwconsole sound --list +-------+----------------------------------+----------------------------+-----------+ | ID    | Language                         | Author                     | Installed | +-------+----------------------------------+----------------------------+-----------+ | cs    | Czech (cs)                       | Westany Ltd.               |           | | en    | English (en)                     | Allison Smith              | X         | | en_AU | English - Australia (en_AU)      | CAMSOWN                    |           | | en_GB | English - United Kingdom (en_GB) | Jay Benham                 |           | | en_NZ | English - New Zealand (en_NZ)    | Rover Voice Services       |           | | es    | Spanish (es)                     | Allison Smith              |           | | fa    | Persian (fa)                     | SENA                       |           | | fr    | French (fr)                      | June Wallack               |           | | he    | Hebrew (he)                      | Westany Ltd.               |           | | it    | Italian (it)                     | Carlo Flora                |           | | ja    | Japanese (ja)                    | Ryoko SONODA (QLOOG, Inc.) |           | | nl    | Dutch (nl)                       | Westany Ltd.               |           | | no    | Norwegian (no)                   | Westany Ltd.               |           | | pl    | Polish (pl)                      | Westany Ltd.               |           | | ru    | Russian (ru)                     | http://www.ivrvoice.ru/    |           | | sv    | Swedish (sv)                     | Tove Hjelm                 |           | | tr    | Turkish (tr)                     | Westany Ltd.               |           | +-------+----------------------------------+----------------------------+-----------+

• Install

  [root@Andrew14 soundlang]# fwconsole sound --install cs <snip> Accept License Agreement? [y/n]y Installing cs...Done

• Uninstall

  [root@Andrew14 soundlang]# fwconsole sound --uninstall cs Uninstalling cs...Done

• List Global

  [root@Andrew14 soundlang]# fwconsole sound --listglobal +----+---------+---------+ | ID | Name    | Default | +----+---------+---------+ | en | English | X       | +----+---------+---------+

• Set Global

  [root@Andrew14 soundlang]# fwconsole sound --global en Successfully set default language to en, you will need to reload

System Admin

• Get Activation Information

  [root@freepbxdev1 faxpro]# fwconsole sysadmin info Activation Status: Zend ID:    M:XXXXX-XXXXX-XXXXX-XXXXX Lic File:   Present Deployment: freepbxdev1

• Update the license file on your installation

  [root@freepbxdev1 faxpro]# fwconsole sysadmin update Updating license for freepbxdev1 Done! No changes from original Licence.

• Activate system using your deploymentid

  [root@freepbxdev1 faxpro]# fwconsole sysadmin activate <deploymentid>

• Clear https force - if an https force misconfiguration renders the Admin GUI inaccessible, you can clear it with
  
  

  # fwconsole sysadmin clearforce Disabling HTTPS forced redirection for the administration interface. Done.

Trunks

Interactive toggle

List Trunks

Specifying a trunk to enable or disable 

"fwconsole" is the Linux command that controls FreePBX 13+ from the Linux command prompt.  

To access the command prompt, log-in to the machine where you installed FreePBX/Asterisk using your "root" username and password.  You can do so by accessing the keyboard of the machine where you installed FreePBX, or remotely using an SSH client such as Putty.

Then type one of the following "fwconsole" commands below

Command List

Stop/Start/Restart

Open

This is how FreePBX starts asterisk and any other processes it need.  You should always start and restart asterisk with the amportal command not the service asterisk or /etc/init.d/asterisk commands

fwconsole stop

fwconsole start

fwconsole restart

Chown

Open

fwconsole chown - This will change ownership of all files and directories that FreePBX needs to be owned by the apache user.

• See verbose details about chown operations (ownership and permissions per file)

  [root@freepbxdev1 userman]# fwconsole chown --verbose Setting /var/lib/asterisk/ucp/out.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/err.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/ucp.log owner to: asterisk:asterisk, with permissions of: 644 Setting /var/lib/asterisk/ucp/config.json owner to: asterisk:asterisk, with permissions of: 644 

• Chown a specific file (or see details about only ONE file/directory)

  [root@localhost ~]# fwconsole chown --verbose --file=/var/www/html/admin/modules/timeconditions/bin/schedtc.php Taking too long? Customize the chown command, See http://wiki.freepbx.org/display/FOP/FreePBX+Chown+Conf Setting Permissions...     Collecting Files...Done Setting /var/www/html/admin/modules/timeconditions/bin/schedtc.php owner to: asterisk:asterisk, with permissions of: 644 Setting /var/www/html/admin/modules/timeconditions/bin/schedtc.php owner to: asterisk:asterisk, with permissions of: 755 Finished setting permissions

   

Doctrine

This command is used to export out table information to be used in FreePBX table creation for module installations

Two formats are supported. XML and PHP.

The XML should be used in the module.xml file

The PHP code should be used inside install.php or the module's class.

Reload

Open

fwconsole reload - This will perform a reload of all the dialplan in Asterisk and all the modules in asterisk.  This is the same as pressing the "Apply Changes" button in the GUI of FreePBX

Unlock

Open

fwconsole unlock xxxxxxxxxxxxxxxx- The fwconsole unlock command will unlock the GUI login of FreePBX to let you into the FreePBX GUI without the username and password.  This is handy if you lost or misplaced your FreePBX GUI username or password and need to get into the GUI to change or setup a new user.  You need to replace the xxxxxxx with your PHP session ID.  Follow the steps below.

• Bring up the main login page to FreePBX in your browser.  Such as http://192.168.0.2/admin

• Do a "ctrl a" to highlight the whole page and look to the left center of the screen for some text.  This is your unique php session ID.  Copy this into your clipboard.

• Go into the linux CLI and type the following command replacing the session ID below with your own.

  [root@localhost ~]# fwconsole unlock ppnr8l1vle32s3q8b79s4n1sp7 Please wait... session unlocked! [root@localhost ~]#

• Go refresh your browser page and it will log you in this one time automatically for you based on that php session ID. Now you can go add or change the FreePBX admin users.

Open

Userman

This command provides information about User Manager

• Run synchronization for external authentication engines

  [root@freepbxdev1 userman]# fwconsole userman sync Starting Sync...

• Get verbose details about synchronization status

  [root@freepbxdev1 userman]# fwconsole userman sync --verbose Starting Sync...

Util

General Utility functions for FreePBX

• Clean up playback cache. This is normally run through a cron job. It removes any cached media (browser playback, moh/recording temp files,) that is over 60 days old.

  [root@freepbxdev1 paging]# fwconsole util cleanplaybackcache Starting Cache cleanup Finished cleaning up cache

• Used to check all signatures on the system. Does not return any output

  [root@freepbxdev1 paging]# fwconsole util signaturecheck [root@freepbxdev1 paging]#

• Runs a repair against the SQL Databases

  [root@freepbxdev1 paging]# fwconsole util tablefix Attempting to repair MySQL Tables this may take a while MySQL Tables Repaired

Database

fwconsole m This will connect you to the mysql database as the FreePBX user automatically based on the username and password for MySQL in /etc/freepbx.conf

Module Administration

Command line utility for controlling FreePBX Module installation.

Edge modules:

In Framework 13.0.69 we added the ability to install edge modules. To upgrade to a module in the edge track pass the --edge flag

• Check Module Dependencies

  [root@xxxxxx ~]# fwconsole ma checkdepends core All dependencies met for module core

• Disable a module

  [root@freepbxdev1 faxpro]# fwconsole ma disable asterisk-cli Module asterisk-cli successfully disabled Updating Hooks...Done

• Download a Module

  [root@xxxxxx ~]# fwconsole ma download core No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded
  [root@xxxxxx ~]# fwconsole ma download <url> No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded

• Download a specific module

  [root@xxxxxx ~]# fwconsole ma download core --tag 1.2.3 No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded

• Download and install a Module

  [root@xxxxxx ~]# fwconsole ma downloadinstall core No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded Checking if directdids need migrating..already done updating zap callgroup, pickupgroup..not needed checking for delay_answer field ..already exists checking for reversal field ..already exists checking for pricid field ..already exists Migrating pickup groups to named pickup groups Migrating call groups to named call groups Checking if trunk table migration required..not needed Checking if privacy manager options exists..already exists Checking for noanswer_cid field..already exists Checking for busy_cid field..already exists Checking for chanunavail_cid field..already exists Checking for noanswer_dest field..already exists Checking for busy_dest field..already exists Checking for chanunavail_dest field..already exists Unable to add index to extensions field in users Checking for General Setting migrations..not needed Deleting unused globals..done Converting IAX notransfer to transfer if needed..updated 0000 records deleting obsoleted record_in and record_out entries..ok checking for dest field in outbound_routes..already exists checking for continue field in trunks..already exists upgrading any zap trunks to dahdi if found..ok Checking for possibly invalid emergency caller id fields..none found Generating CSS...Done Module core successfully installed Updating Hooks...Done
  [root@xxxxxx ~]# fwconsole ma downloadinstall <url> No repos specified, using: [standard,commercial] from last GUI settings Starting core download.. Processing core Downloading...  3076094/3076094 [============================] 100% Finished downloading Extracting...Done Module core successfully downloaded Checking if directdids need migrating..already done updating zap callgroup, pickupgroup..not needed checking for delay_answer field ..already exists checking for reversal field ..already exists checking for pricid field ..already exists Migrating pickup groups to named pickup groups Migrating call groups to named call groups Checking if trunk table migration required..not needed Checking if privacy manager options exists..already exists Checking for noanswer_cid field..already exists Checking for busy_cid field..already exists Checking for chanunavail_cid field..already exists Checking for noanswer_dest field..already exists Checking for busy_dest field..already exists Checking for chanunavail_dest field..already exists Unable to add index to extensions field in users Checking for General Setting migrations..not needed Deleting unused globals..done Converting IAX notransfer to transfer if needed..updated 0000 records deleting obsoleted record_in and record_out entries..ok checking for dest field in outbound_routes..already exists checking for continue field in trunks..already exists upgrading any zap trunks to dahdi if found..ok Checking for possibly invalid emergency caller id fields..none found Generating CSS...Done Module core successfully installed Updating Hooks...Done

Bulk Import

If the Bulk Handler module is installed, you can use the command line to import a csv file as follows:

You must specify the import type and the file name to a valid csv file for import.

CLI Examples:

EPM

• Add Mapping to Extension Mapping

  # fwconsole epm addmapping 4101 --brand=sangoma --mac=005058500002 --template=sangomatest --model=S700 --account=account1 Extension 4101 added successfully.

• List Extensions

  # fwconsole epm listextensions ALL +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+ | Extension | Brand       | MAC          | Template         | Model    | Account  | Expansion 1 | Rebuild | VPN                 | +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+ | 1012      | Grandstream | 000B82800001 | grandstream-test | GXP-2170 | account1 |             | 1       |                     | | 4101      | sangoma     | 005058500003 | sangomatest      |          | account1 |             |         |                     | | 4102      | Yealink     | 001565211111 | yealink-base     | SIP-T26P | account1 | EXP38-1     | 1       |                     | | 4103      | Sangoma     | 005058500001 | sangomatest      | S500     | account1 | EXP100-1    | 1       | 4103 - 4103 (ID: 4) | | 4104      | Sangoma     | 005058500002 | sangomatest      | S700     | account1 |             | 1       |                     | +-----------+-------------+--------------+------------------+----------+----------+-------------+---------+---------------------+    # fwconsole epm listextensions ALL --detail +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+ | Extension | Brand       | MAC          | Template         | Model    | Account  | Accessory | Expansion 1 | Expansion 2 | Expansion 3 | Expansion 4 | Expansion 5 | Expansion 6 | BLF Substitution | BLF Label | Rebuild | VPN                 | Repeater 1 | Repeater 2 | Repeater 3 | Multicell | +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+ | 1012      | Grandstream | 000B82800001 | grandstream-test | GXP-2170 | account1 |           |             |             |             |             |             |             |                  |           | 1       |                     |            |            |            |           | | 4101      | sangoma     | 005058500003 | sangomatest      |          | account1 |           |             |             |             |             |             |             |                  |           |         |                     |            |            |            |           | | 4102      | Yealink     | 001565211111 | yealink-base     | SIP-T26P | account1 |           | EXP38-1     |             |             |             |             |             | None             |           | 1       |                     |            |            |            |           | | 4103      | Sangoma     | 005058500001 | sangomatest      | S500     | account1 |           | EXP100-1    | EXP100-2    | EXP100-3    | EXP100-4    | EXP100-5    | EXP100-6    | None             |           | 1       | 4103 - 4103 (ID: 4) |            |            |            |           | | 4104      | Sangoma     | 005058500002 | sangomatest      | S700     | account1 |           |             |             |             |             |             |             |                  |           | 1       |                     |            |            |            |           | +-----------+-------------+--------------+------------------+----------+----------+-----------+-------------+-------------+-------------+-------------+-------------+-------------+------------------+-----------+---------+---------------------+------------+------------+------------+-----------+

• List Templates

   # fwconsole epm listtemplates +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+ | Brand       | Template Name        | Destination | Time Zone | Provision Type | Provision Address | Background         | Firmware | Internal Default | External Default | +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+ | grandstream | grandstream-test     | 10.100.0.3  | -06:00    | TFTP           | 10.100.0.3        | digit-on-phone.png | 1.14     |                  |                  | | sangoma     | sangomatest          | 10.100.0.3  | -06:00    | HTTP           | 10.100.0.3        | digit-on-phone.png | 1.23     |                  |                  | | yealink     | yealink-base         | 10.100.0.3  | -06:00    | TFTP           | 10.100.0.3        | sangomapad.png     | 1.16     | Yes              | Yes              | +-------------+----------------------+-------------+-----------+----------------+-------------------+--------------------+----------+------------------+------------------+

• Reboot Devices

  # fwconsole epm reboot 4103 Only works for Sangoma phones Extension 4103 sent reboot command.    # fwconsole epm reboot sangomatest Only works for Sangoma phones Extension 4103 sent reboot command Extension 4104 sent reboot command Extension 4101 sent reboot command

• Rebuild Configuration Files

  # fwconsole epm rebuild 4103 Extension 4103 rebuilt       # fwconsole epm rebuild sangomatest Extension 4103 rebuilt Extension 4104 rebuilt Extension 4101 rebuilt

• Rebuild and Update Devices

  # fwconsole epm rebuildupdate 4103 Extension 4103 rebuilt Update command sent to 4103       # fwconsole epm rebuildupdate sangomatest Extension 4103 rebuilt Extension 4104 rebuilt Extension 4101 rebuilt Update command sent to 4103 Update command sent to 4104 Update command sent to 4101

• Remove Devices

  # fwconsole epm remove 4103 4103 removed succesfully

• Update Devices

  # fwconsole epm update 4103 Update command sent to 4103        # fwconsole epm update sangomatest Update command sent to 4103 Update command sent to 4104 Update command sent to 4101

Notification

• List Notifications

  [root@freepbxdev1 faxpro]# fwconsole notification --list +---------------+-------------------------+----------------------------------------------------------+ | Module        | ID                      | Text                                                     | +---------------+-------------------------+----------------------------------------------------------+ | freepbx       | FW_UNSIGNED             | You have 95 unsigned modules                             | | freepbx       | NEWUPDATES              | There are 3 modules available for online upgrades        | | cron_manager  | EXECFAIL                | Cronmanager encountered 1 Errors                         | | dahdiconfig   | etcdahdimodules         | File /etc/dahdi/modules is not owned by asterisk         | | dahdiconfig   | etcdahdisystem.conf     | File /etc/dahdi/system.conf is not owned by asterisk     | | dahdiconfig   | etcmodprobe.ddahdi.conf | File /etc/modprobe.d/dahdi.conf is not owned by asterisk | | freepbx       | modules_disabled        | You have 10 disabled modules                             | | cidlookup     | noauth                  | OpenCNAM Requires Authentication                         | | fax           | invalid_email           | Invalid Email for Inbound Fax                            | | freepbx       | NEWMODS                 | 1 New modules are available                              | | retrieve_conf | SYMLINKNOTICE           | Symlink Conflict Resolved                                | | sipstationdid | ss7149223196            | SIPSTATION DID routed                                    | +---------------+-------------------------+----------------------------------------------------------+
  [root@freepbxdev1 faxpro]# fwconsole notification --list --json [["freepbx","FW_UNSIGNED","You have 95 unsigned modules"],["freepbx","NEWUPDATES","There are 3 modules available for online upgrades"],["cron_manager","EXECFAIL","Cronmanager encountered 1 Errors"],["dahdiconfig","etcdahdimodules","File \/etc\/dahdi\/modules is not owned by asterisk"],["dahdiconfig","etcdahdisystem.conf","File \/etc\/dahdi\/system.conf is not owned by asterisk"],["dahdiconfig","etcmodprobe.ddahdi.conf","File \/etc\/modprobe.d\/dahdi.conf is not owned by asterisk"],["freepbx","modules_disabled","You have 10 disabled modules"],["cidlookup","noauth","OpenCNAM Requires Authentication"],["fax","invalid_email","Invalid Email for Inbound Fax"],["freepbx","NEWMODS","1 New modules are available"],["retrieve_conf","SYMLINKNOTICE","Symlink Conflict Resolved"],["sipstationdid","ss7149223196","SIPSTATION DID routed"]]

• Delete notification (by ID)

  [root@freepbxdev1 faxpro]# fwconsole notification --delete dahdiconfig etcdahdimodules Deleting notification Notification Deleted [root@freepbxdev1 faxpro]# fwconsole notification --list +---------------+-------------------------+----------------------------------------------------------+ | Module        | ID                      | Text                                                     | +---------------+-------------------------+----------------------------------------------------------+ | freepbx       | FW_UNSIGNED             | You have 95 unsigned modules                             | | freepbx       | NEWUPDATES              | There are 3 modules available for online upgrades        | | cron_manager  | EXECFAIL                | Cronmanager encountered 1 Errors                         | | dahdiconfig   | etcdahdisystem.conf     | File /etc/dahdi/system.conf is not owned by asterisk     | | dahdiconfig   | etcmodprobe.ddahdi.conf | File /etc/modprobe.d/dahdi.conf is not owned by asterisk | | freepbx       | modules_disabled        | You have 10 disabled modules                             | | cidlookup     | noauth                  | OpenCNAM Requires Authentication                         | | fax           | invalid_email           | Invalid Email for Inbound Fax                            | | freepbx       | NEWMODS                 | 1 New modules are available                              | | retrieve_conf | SYMLINKNOTICE           | Symlink Conflict Resolved                                | | sipstationdid | ss7149223196            | SIPSTATION DID routed                                    | +---------------+-------------------------+----------------------------------------------------------+

Paging Pro

• Cleanup stale pages and add needed pages (This is also run as a cron in crontab every minute. There it's called: */1 * * * * /var/lib/asterisk/bin/pagepro-scheduler.php 2>&1 >/dev/null)
  Run command with --verbose to get detailed data

  [root@freepbxdev1 framework]# fwconsole pagingpro --clean --verbose Found scheduled page for ID 500 occuring at 1466527800

• List active scheduled pages

  [root@freepbxdev1 framework]# fwconsole pagingpro --list +---------+------------+-------------+ | Page ID | Time       | Cron Exists | +---------+------------+-------------+ | 500     | 1466527800 | Yes         | +---------+------------+-------------+

• List specific scheduled page by id

  [root@freepbxdev1 framework]# fwconsole pagingpro --list 500 +---------+------------+-------------+ | Page ID | Time       | Cron Exists | +---------+------------+-------------+ | 500     | 1466527800 | Yes         | +---------+------------+-------------+

• Execute a scheduled page immediately (for testing) using the paging pro page scheduler processes

  [root@freepbxdev1 framework]# fwconsole pagingpro --execute 500 [root@freepbxdev1 framework]# <phones should be ringing>

Phone Apps

• Get statuses of BLF lights for extension

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 +-----------------+------------+ | ID              | BLF Status | +-----------------+------------+ | Call Forward    | Inactive   | | Conference      | Inactive   | | DND             | Inactive   | | Follow Me       | Active     | | Parking         | Inactive   | | Queues          | Inactive   | | Queue Agent     | Active     | | Time Conditions | Inactive   | | Voicemail       | Active     | | Call Flow       | Inactive   | +-----------------+------------+

• Get status of BLF lights for single Application

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 "Parking" +---------+------------+ | ID      | BLF Status | +---------+------------+ | Parking | Inactive   | +---------+------------+

• Get more information about said hint by adding "--verbose"

  [root@freepbxdev1 restapps]# fwconsole phoneapps blf 12000 "Call Flow" --verbose +-----------+------------+------------------+ | ID        | BLF Status | Hint             | +-----------+------------+------------------+ | Call Flow | Inactive   | Custom:DAYNIGHT0 | +-----------+------------+------------------+

pm2

Used to manage background/long running processes

• List Processes

  [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+-----+----------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU | Mem      | +--------------+-------+--------+----------+---------------------+-----+----------+ | xmpp         | 8495  | online | 0        | 6 hours, 29 minutes | 0%  | 218.13MB | | restapps     | 8665  | online | 0        | 6 hours, 29 minutes | 0%  | 47.63MB  | | zulu         | 8825  | online | 0        | 6 hours, 29 minutes | 0%  | 94.29MB  | | ucpnode      | 10048 | online | 0        | 6 hours, 28 minutes | 0%  | 73.53MB  | | qcallback    | 16218 | online | 30       | 5 hours, 54 minutes | 0%  | 29.59MB  | +--------------+-------+--------+----------+---------------------+-----+----------+

• Stop Process

  [root@freepbxdev1 ~]# fwconsole pm2 --stop xmpp Process Stopped [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+---------+----------+---------------------+-----+---------+ | Process Name | PID   | Status  | Restarts | Uptime              | CPU | Mem     | +--------------+-------+---------+----------+---------------------+-----+---------+ | xmpp         | 0     | stopped | 0        | 0                   | 0%  | 0.00B   | | restapps     | 8665  | online  | 0        | 6 hours, 30 minutes | 0%  | 47.63MB | | zulu         | 8825  | online  | 0        | 6 hours, 30 minutes | 0%  | 94.29MB | | ucpnode      | 10048 | online  | 0        | 6 hours, 29 minutes | 0%  | 73.54MB | | qcallback    | 16218 | online  | 30       | 5 hours, 55 minutes | 0%  | 29.59MB | +--------------+-------+---------+----------+---------------------+-----+---------+

• Restart Process

  [root@freepbxdev1 ~]# fwconsole pm2 --restart xmpp Process Restarted [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+------+----------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU  | Mem      | +--------------+-------+--------+----------+---------------------+------+----------+ | xmpp         | 8299  | online | 0        | 4 seconds           | 102% | 117.13MB | | restapps     | 8665  | online | 0        | 6 hours, 30 minutes | 0%   | 47.63MB  | | zulu         | 8825  | online | 0        | 6 hours, 30 minutes | 0%   | 94.29MB  | | ucpnode      | 10048 | online | 0        | 6 hours, 29 minutes | 0%   | 73.54MB  | | qcallback    | 16218 | online | 30       | 5 hours, 56 minutes | 0%   | 29.59MB  | +--------------+-------+--------+----------+---------------------+------+----------+

• Delete Process (Only removes and stops it from the Process Management Module, does not remove the module itself)

  [root@freepbxdev1 ~]# fwconsole pm2 --delete xmpp Process Stopped and Deleted [root@freepbxdev1 ~]# fwconsole pm2 --list +--------------+-------+--------+----------+---------------------+-----+---------+ | Process Name | PID   | Status | Restarts | Uptime              | CPU | Mem     | +--------------+-------+--------+----------+---------------------+-----+---------+ | restapps     | 8665  | online | 0        | 6 hours, 31 minutes | 0%  | 47.63MB | | zulu         | 8825  | online | 0        | 6 hours, 31 minutes | 0%  | 94.29MB | | ucpnode      | 10048 | online | 0        | 6 hours, 30 minutes | 0%  | 73.55MB | | qcallback    | 16218 | online | 30       | 5 hours, 56 minutes | 0%  | 29.59MB | +--------------+-------+--------+----------+---------------------+-----+---------+

• Tail log (Used to tail logs for an application/process)

  [root@freepbxdev1 ~]# fwconsole pm2 --log restapps --lines 20 OUT > ==> /var/log/asterisk/restapps_err.log <== ==> /var/log/asterisk/restapps_out.log <== 2017-04-12 01:34 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 01:34 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 01:48 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 01:48 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 02:02 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 02:02 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-presencestate] Setting button linekeys:14 to IN_USE 2017-04-12 02:17 -04:00: [8665][1001-parking] Setting button linekeys:13 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-findmefollow] Setting button linekeys:11 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-donotdisturb] Setting button linekeys:10 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-conferences] Setting button linekeys:8 to NOT_INUSE 2017-04-12 02:17 -04:00: [8665][1001-callforward] Setting button linekeys:7 to NOT_INUSE

• Update PM2 (Used to update the PM2 binary in memory, this will stop all applications to update the PM2 library!)

  [root@freepbxdev1 ~]# fwconsole pm2 --update Be sure to have the latest version by doing `npm install pm2@latest -g` before doing this procedure. [PM2] Saving current process list... [PM2] Stopping PM2... [PM2] Applying action deleteProcessId on app [all](ids: 1,2,3,4) [PM2] [ucpnode](3) ✓ [PM2] [restapps](1) ✓ [PM2] [qcallback](4) ✓ [PM2] [zulu](2) ✓ [PM2] All processes have been stopped and deleted [PM2] PM2 stopped [PM2] Spawning PM2 daemon with pm2_home=/home/asterisk/.pm2 [PM2] Restoring processes located in /home/asterisk/.pm2/dump.pm2 [PM2] Process /usr/src/freepbx/restapps/restapps.php restored [PM2] Process /usr/src/freepbx/zulu/node/index.js restored [PM2] Process /usr/src/freepbx/ucpnode/node/index.js restored [PM2] Process /usr/src/freepbx/vqplus/queue-callback.php restored >>>>>>>>>> PM2 updated ┌───────────┬────┬──────┬──────┬────────┬─────────┬────────┬──────┬───────────┬──────────┐ │ App name  │ id │ mode │ pid  │ status │ restart │ uptime │ cpu  │ mem       │ watching │ ├───────────┼────┼──────┼──────┼────────┼─────────┼────────┼──────┼───────────┼──────────┤ │ qcallback │ 3  │ fork │ 9316 │ online │ 0       │ 0s     │ 46%  │ 18.5 MB   │ disabled │ │ restapps  │ 0  │ fork │ 9289 │ online │ 0       │ 0s     │ 168% │ 33.4 MB   │ disabled │ │ ucpnode   │ 2  │ fork │ 9305 │ online │ 0       │ 0s     │ 59%  │ 15.1 MB   │ disabled │ │ zulu      │ 1  │ fork │ 9295 │ online │ 0       │ 0s     │ 71%  │ 17.8 MB   │ disabled │ └───────────┴────┴──────┴──────┴────────┴─────────┴────────┴──────┴───────────┴──────────┘  Use `pm2 show <id|name>` to get more details about an app Update PM2 Process

• Reload Log file pointers (used during logrotates)

  [root@uc-85436011 ~]# fwconsole pm2 --reload-logs All logs reloaded

Setting

Used to alter Advanced Settings from the bash prompt:

System Admin

• Get Activation Information

  [root@freepbxdev1 faxpro]# fwconsole sysadmin info Activation Status: Zend ID:    M:XXXXX-XXXXX-XXXXX-XXXXX Lic File:   Present Deployment: freepbxdev1

• Update the license file on your installation

  [root@freepbxdev1 faxpro]# fwconsole sysadmin update Updating license for freepbxdev1 Done! No changes from original Licence.

• Activate system using your deploymentid

  [root@freepbxdev1 faxpro]# fwconsole sysadmin activate <deploymentid>