Yeastar Cloud PBX Maintenance

You are here:
Estimated reading time: 6 min

Maintenance

Maintenance gives you access to upgrade PBX firmware, check logs and troubleshooting.

Upgrade Firmware

Note:

  • Back up the PBX configurations before you start to update the PBX firmware.
  • If “Reset configuration to Factory Defaults” is enabled, the system will reset to factory default settings after upgrading.
  • When update the firmware, please don’t turn off the power. Or the system will get damaged.

Upgrade Firmware

You can check for new version immediately or schedule automatic firmware check, if the PBX has a new released version, upgrade the PBX firmware with just one click.

Note: Make sure that the PBX can access the Internet, or the upgrade will fail.

Check firmware and upgrade immediately

  1. Go to Maintenance > Upgrade.
  2. Click Check for new version to check for new firmware immediately.

    If a new version is detected, you can click New check the release notes and decide whether to upgrade or not.

Schedule automatic update

  1. Go to Maintenance > Upgrade.
  2. Select one of the following options:
    • Never check for updates

      This option disables Automatic Updates.

    • Check for updates and let me choose whether to upgrade

      This option notifies you that there are updates available. It requires user interaction to download them and install them.

  3. Click Save and Apply.

    If a new version is detected, you can click New check the release notes and decide whether to upgrade or not.

 

Backup and Restore

Go to Maintenance > Backup and restore, then you can back up all configurations of PBX. Once backed up, back up file will be displayed in the list. You can upload backup file from local client to PBX, or you can choose from backup list and restore.

Create a Backup File

You can create a backup file of the PBX settings on the PBX web interface.

Note:

  • For PBX version before 81.5.0.7, you can not back up one-touch recording files and voicemail files.
  • For PBX version 81.5.0.7 or later, you can back up one-touch recording files and voicemail files.
  1. Go to Maintenance > Backup and Restore, click Backup.
  2. Set the File Name.
    The default file name contains the PBX model, firmware version, and backup date.
  3. In the Memo field, enter notes for the backup file.
  4. Select which configurations and files to back up.
  5. Click Save.
    The created backup file will appear on the Backup and Restore page.

Upload a Backup File

You can select a backup file from your local PC, and upload the file to the PBX.

Note: The file format is .bak and the file name should not contain special characters.
  1. Go to Maintenance > Backup and Restore, click Backup.
  2. Click Browse, and select your backup file to upload.
  3. In the Memo field, enter notes for the backup file.
  4. Click Upload.
    The uploaded backup file will appear on the Backup and Restore page.

Restore a Backup File

After restore a backup file, the current configurations on your PBX will be OVERWRITTEN with the backup data.

Note:

  • You cannot restore a backup file that is downloaded from a different PBX model.
  • If a backup file is created from a newer version of PBX, you cannot restore this backup file. For example, restore a backup file (v30.7.0.35) to PBX (v30.6.0.16) would not work.
  • You can restore a backup file that is created from a older version of PBX. For example, restore a backup file (v30.6.0.16) to PBX(v30.7.0.35) would work.
  1. Go to Maintenance > Backup and Restore.
  2. Choose a backup file, click .
    A pop-up window will appear at the bottom-right of the web page.
  3. Click Yes to reboot the PBX.
    The PBX starts to restore data from the backup file.

 

Reboot the PBX

Reboot the PBX immediately on the PBX web interface or schedule auto reboot to keep the system running smoothly.

Note: When the PBX is rebooting, all the on-going calls will be terminated.

Reboot the PBX Immediately

  1. Go to Maintenance > Reboot, click Reboot.

Schedule Auto Reboot

  1. Go to Maintenance > Reboot, check the option Enable Auto Reboot.

  2. Set the frequency and time of auto reboot.
  3. Click Save.

Reset the PBX

If you want to erase all the configurations on your PBX, you can reset the PBX to the factory defaults.

  1. Go to Maintenance > Reset, click Reset.
  2. Note down the new activation code.
    You need to use the new activation code to activate the PBX after reset.
  3. Enter the verification code.
  4. Click Reset.

 

System Log

The PBX automatically trace the PBX information, notices, warnings, errors, debug logs, and web logs, then generate log files. You can download the system logs on the PBX web interface, and check the logs.

Go to Maintenance > System Log to trace real-time logs or download the generated system logs.

System Log Settings

The PBX traces different levels of log.

  • Information: Basic information.
  • Notice: NOTICE information.
  • Warning: WARNING information.
  • Error: ERROR information.
  • DTMF: DTMF information.
  • Time Log: Add time stamp of system logs.
  • Debug: Select the following checkboxes to decide which type of debug logs to trace:
    • Enable SIP Debug
    • Enable RTP Debug

System Log

The PBX generates system logs everyday. The system logs are compressed into a tar file. You can check the system logs on the System Log page.

Click  to download the log file and open the log file by Notepad++ or other editor software to check the logs.

The PBX provides the following kinds of system logs:

  • PBX firmware version
  • AMI logs
  • API logs
  • Asterisk guard logs
  • App logs
  • Module update logs
  • Linkus Cloud Service logs
  • SSH connection logs
  • PnP logs
  • Web logs

Operation Log

The PBX records all the users’ operations, and keep the logs in Operation Log.

Go to Maintenance > Operation Log to search and check the operation logs.

 

Access the PBX via SSH

To debug the system, you can establish a temporary SSH connection on the PBX, and access the PBX via SSH to check the logs.

  1. Establish SSH connection.
    1. Go to Maintenance > SSH Connection, click Establish Connection.
    2. On the Time Settings dialog box, select the time period in the Timeout drop-down menu, click OK.
      Note: When the connection times out, the SSH tunnel will be closed, you will not be able to access PBX via SSH.
      The SSH connection information is displayed on the SSH Connection page.
  2. Use PuTTY to access the PBX via SSH.
    • Host Name (or IP address): Enter the PBX domain.
    • Port: Enter the SSH port.
    • Connection Type: Choose SSH.
  3. To get more logs in the window, set the Lines of scrollback to a larger value, click Apply.
  4. Enter the username and password to access the PBX.
    • login as: Enter support.
    • password: Enter the SSH password.

     

Capture Ethernet Packets

When there is a problem on the VoIP extensions or trunks, you can use the Ethernet Capture Tool to capture Ethernet packet, and download the packet to analyze it.

  1. Go to Maintenance > Troubleshooting > Ethernet Capture Tool.
  2. Click Start.
    The PBX will start to capture the Ethernet packet. During this time, you should duplicate the problem of your VoIP trunks or extensions.
  3. Click Stop to stop capturing packets.
  4. Click Download to download the captured packet.

    Decompress the .tarfile and use Wireshark software to open the packet file.

     

Ping IP Address

A ping utility sends test messages from the local client to a remote target over the TCP/IP network connection. You can use IP Ping tool to test if the PBX can access the target IP address.

  1. Go to Maintenance > Troubleshooting > IP Ping.
  2. In the Host field, enter the target domain name or IP address.
  3. Click Start and check the result.
  4. Click Stop to stop ping.

 

Traceroute

Traceroute is a common diagnostic tool for displaying the route (path) and measuring transit delays of packets across a network.

  1. Go to Maintenance > Troubleshooting > Traceroute.
  2. In the Host field, enter the target domain name or IP address.
  3. Click Start and check the result.
  4. Click Stop to stop traceroute.

 

PBX Monitor

The PBX monitors the status of Trunks, Extensions, Concurrent Call, Conference.

You can log in the PBX web interface, go to PBX Monitor to check the real-time status of your trunks, extensions, and conferences.

VoIP Trunk Status

Status Description
Registered
Registering
  • Unreachable
  • Registration failed, caused by:
    • wrong password
    • wrong authentication name
    • wrong user name
    • transport type inconsistent

Concurrent Call

Check the maximum supported concurrent calls and the real-time concurrent calls on the PBX.

Monitor Conference

Check how many conferences are created on the PBX, and monitor the status of the conferences.

 

Resource Monitor

Monitor the CPU usage, memory usage, disk utilization and network flow.

You can go to Resource Monitor to check the information or click the shortcut icon at the right-top corner.

Information

Check the basic information of the PBX.

  • Product
  • Serial Number
  • Hardware Version
  • Software Version
  • System Time: The current time on the PBX.
  • Uptime: The system up time since the last reboot.
  • Extensions/Max Extensions: The number of added extensions/Maximum number of extensions allowed to be added

Network

Check the status of local network, cellular network, and VPN network.

Storage Usage

Check the usage of local storage in the PBX.

Recording Usage

 

CDR and Recordings

You can check CDR and auto recordings on the PBX web interface. CDR (Call Detail Record) is a data record that contains various attributes of the call, such as time, duration, call status, source number, and destination number, etc.

Searching Criteria

You can search CDR and recordings by the following criteria:

  • Time: Set the start date and the end date to filter the call logs that are in the date duration.
  • Call From: The number or the name of the caller.
  • Call To: The number or the name of the callee.
  • Call Duration: The time between the call started and the call ended. Enter a value to filter the call logs that have call duration equal or greater than this value.
  • Talk Duration: The time between the call answered and the call ended. Enter a value to filter the call logs that have talk duration equal or greater than this value.
  • Status: Call status, including “answered”, “no answered”, “busy”, “failed”, and “has voicemail”.
  • Communication Type: Communication type, including “internal”, “inbound”, “outbound”, “callback”, “PBX warning call”, “transfer”, and “multisite interconnect”.
  • Include Recording Files: Check the option if you want to filter the calls that had been recorded.

Search CDR and Recordings

  1. Log in the PBX web interface, go to CDR & One Touch Recording.
  2. Set the Time to filter the call logs during the date duration.
  3. If you want to search recording files, check the option Include Recording Files.
  4. Set other searching criteria.
  5. Click Search.
    The filtered call logs will display.

Fuzzy Search CDR and Recordings

By default, you need to enter an exact and complete phone number in the relevant searching criteria, or you cannot get the search result. If you cannot remember the exact number or the name, you can use Fuzzy Search feature.

  1. Go to CDR & One Touch Recording.
  2. Set the Time to filter the call logs during the date duration.
  3. Enter a desired number or letters in Call From field or Call To field.
  4. Check Number Fuzzy Search.
  5. Set other searching criteria.
  6. Click Search.
    The call logs that match the fuzzy searching will display.

 

Download CDR and Recordings

You can download the searched CDR or recording files to your local PC.

  1. Go to CDR & One Touch Recording.
  2. Search the CDR and Recordings.
  3. To download the searched CDR, click Download CDR.
  4. To download the searched recording files, click Download Recordings.

 

 

 

 

Previous: Yeastar Cloud PBX System Management
Next: Yeastar Cloud PBX Auto Provisioning

Install linkus on mobile & desktop, next make some calls!

Don't worry, a free trial is a free trial

Book an online demo appointment with our sales specialists.

Don't worry, it's a free consultation and no-obligation to purchase.