• VitalPBX Wiki – https://wiki.vitalpbx.com/
• VoIP Info – https://voip-info.org
• Asterisk – https://asterisk.org
• Asterisk AMI – https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/
• LINBIT creators of DRBD – linbit.com/en/
• Pacemaker – clusterlabs.org/pacemaker
• VitalPBX Github – https://github.com/VitalPBX
• strftime documentation – https://man7.org/linux/man-pages/man3/strftime.3.html
• VitalPBX Commercial FAQ – https://wiki.vitalpbx.com/wiki-category/commercial-faq/

VitalPBX Technical FAQ –https://wiki.vitalpbx.com/wiki-category/faq/

If you ever have any comments or questions, send us an email to sales@vitalpbx.com and we will gladly guide you to the right place.

To see the list of available commands, run the following command.

root@debian:~# vitalpbx --help

To reset the password for any Web UI user, run the following command.

root@debian:~# vitalpbx reset-pwd [username]

Where [username] is the user you wish to change the password.

To rebuild the VitalPBX database, run the following command.

root@debian:~# vitalpbx build-db

This will execute a series of scripts to build the VitalPBX database.

To generate the Asterisk configurations and rebuild the Asterisk database for the main tenant only, we run the following command.

root@debian:~# vitalpbx gen-conf

To generate the Asterisk configurations and rebuild the Asterisk database for all tenants, we run the following command.

root@debian:~# vitalpbx fully-gen-conf

To check for any issues regarding directories/files and their permissions and owners, we run the following command.

root@debian:~# vitalpbx check-integrity

To apply the changes made on the Firewall module on VitalPBX, we run the following command.

root@debian:~# vitalpbx apply-firewall

You can manually restore from a backup file you have uploaded manually by running the following command.

root@debian:~# vitalpbx restore-backup path/to/file.tar

This is especially useful when the backup file is too big to upload from the web interface. You can upload it manually using an SCP or SFTP application to your VitalPBX, then run the command and specify the path to the backup file to restore the system from it.

To reset the SSL certificates and disable the force HTTPS option, run the following command.

root@debian:~# vitalpbx reset-apache-conf

This will help you in case your SSL certificate expires or you don’t have access to your server via HTTPS.

To optimize the performance of MariaDB/MySQL, you can run the following command.

root@debian:~# vitalpbx optimize-mariadb

Keep in mind that this will restart MariaDB.

To optimize the Apache configurations on your VitalPBX, run the following command.

root@debian:~# vitalpbx optimize-apache

To disable 2FA for a user, run the following command.

root@debian:~# vitalpbx disable-2FA [username or email address]

With this, you can disable 2FA for a specific user in case they lose access to their 2FA application. You can use either their username or email address.

To update VitalPBX and all its dependencies, run the following command.

root@debian:~# vitalpbx update

With this, you can control your VitalPBX installation from the command line and troubleshoot any issues you may have.

root@debian:~# sngrep --help

To run SNGrep simply enter the following command.

root@debian:~# sngrep

This will show you the SNGrep interface.

Here, you will see a list of events occurring on your VitalPBX. You can navigate the list of events using the arrow keys. You can enter an event by pressing the Enter key on your keyboard. This will show you all the details of the event. You can navigate the stages using the keyboard. This will show you all the details of the event. You can navigate the stages using the arrow keys.

This will help you get direct information on the current status of your devices, calls, and registration.

You will see that we will have a lot of information that is constantly being sent on the main list of events. For this, we can filter our list to see only the events we are interested in. So, on the main page for SNGrep, press the F7 key on your keyboard. This will show you a prompt where you can filter the events by the SIP From and To, Source and Destination, and Payload. You can also apply a filter by the type of event you want to monitor.

With your filters set, navigate with the arrow keys to Filter and press Enter on your keyboard.

You will see that the list of events will now show the events related to your filter.

This is a great tool for you to troubleshoot the SIP/PJSIP events on your VitalPBX. To quit the SNGrep interface press the Escape key on your keyboard and then select Exit by pressing the Enter key on your keyboard.

root@debian:~# asterisk -rvvvvvvvvv

Or simply

root@debian:~# a

However, monitoring the Asterisk CLI with high verbosity while the system is under production can show us a lot of information at a very fast pace. For this, we can filter out the Full log for Asterisk to trace actions that affect a particular call only.

We start by running the following command.

root@debian:~# tail -f /var/log/asterisk/full | grep {PHONE_NUMBER}

Where {PHONE_NUMBER} is a particular phone number you want to trace within the full log. Remember that you don’t have to include the curly braces. For example, you will enter something like this.

root@debian:~# tail -f /var/log/asterisk/full | grep 15554846868

In the beginning, you may see nothing if information including this number has not been set. Once any activity starts that includes this phone number you will start to see anything related to it.

This phone number you monitor can be an external number calling into your VitalPBX and you want to see the route it uses. Or it can be a DID on your system and you want to see that it is used appropriately for your inbound routes. This can help you monitor how your VoIP provider sends your DID information so you can enter it correctly on your Inbound Routes. It can also be a specific Extension Number you want to monitor their current call. Use this option to make your call troubleshooting easier during active hours on your VitalPBX.

To see the possible Fail2Ban commands, run the following command from the Linux Command Line.

root@debian:~# man fail2ban-client

To see the clients that have been banned due to too many failed attempts through SSH, run the following command.

root@debian:~# fail2ban-client status sshd

To see the clients that have been banned due to too many failed attempts to register through Asterisk, run the following command.

root@debian:~# fail2ban-client status asterisk

To unban an IP Address, run the following command.

root@debian:~# fail2ban-client set sshd unbanip {IP_ADDRESS}

Where {IP_ADDRESS} is the exact IP address to unban. Do not include the curly braces.

To ban an IP address, run the following command.

root@debian:~# fail2ban-client set sshd banip {IP_ADDRESS}

Where {IP_ADDRESS} is the exact IP address to ban. Do not include the curly braces.

To block an IP address using IPTables, run the following command.

root@debian:~# iptables -I INPUT 1 -s IPAddress -j DROP

To unblock an IP address using IPTables, run the following command.

root@debian:~# iptables -D INPUT -s IPAddress -j DROP

Using these commands you can manage the Intrusion Detection system directly through the Linux Command Line.

You can see the full AMI documentation on the following link.

https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/ To create an AMI user in VitalPBX, go to Settings > PBX Settings > AMI Users. Here, you will create the AMI users that will connect directly with Asterisk.

You will need to define an AMI User and Secret. We generate a random password, and we recommend you use this randomly generated password for the best security. You will also need to enter a description to identify this user.

We also require you to use the Deny and Permit options for this user. With these fields, you specify the IP address or Network segment that can access Asterisk using this AMI user. It is important that you only allow the specific IP addresses that can connect to Asterisk using this AMI user as this is an extremely permissive user. An AMI user can affect your Asterisk directly, so we need to take all the precautions necessary.

You can also limit the read and write permissions, so the AMI users are only able to perform the tasks you need for your third-party application integration.

With everything set, you can Save and then Apply Changes.

With this, you are now able to connect directly with Asterisk and monitor and manage the Asterisk layer for VitalPBX from a third-party application.

https://documenter.getpostman.com/view/5481262/2s935hQmgP To create your API Key to use with third-party applications, go to Admin > Admin > Application Keys.

Here, you just need to enter a description to identify the key and select which tenant you wish to have the API connection with. You can choose a specific tenant, or select Any Tenant to be able to get API calls from any tenant.

You can enable or disable the API Key at any moment. Once done, click on Save. This will generate the API Key. If you go back to the Key you created, in the list button in the upper right-hand corner, you will see the API key you can copy and use with your third-party application.