Fortinet white logo
Fortinet white logo

FortiVoice Phone System Administration Guide

Maintaining the system

Maintaining the system

The System > Maintenance submenu allows you to perform the scheduled maintenance of FortiVoice and the phone firmware.

This topic includes:

Maintaining the system configuration

The System > Maintenance > Configuration tab contains features for use during scheduled system maintenance: updates, backups, restoration, and centralized administration.

Backing up the configuration

Before installing FortiVoice firmware or making significant configuration changes, back up your FortiVoice configuration. Backups let you revert to your previous configuration if the new configuration does not function correctly.

System configuration includes the configurations that make the FortiVoice phone system work. User data includes user-configured settings, such as voicemail greetings and reminders.

You can back up the system configuration and user data.

In addition to backing up your configuration manually, you can also configure a schedule to back up the configuration automatically to the FortiVoice local hard drive or a remote FTP/SFTP server.

In a system configuration backup, FortiVoice includes the following data:

  • Configuration (configuration file only)

In a user data backup, FortiVoice includes the following data:

  • Contacts: Includes business and directory contacts, not personal contacts.
  • Prompts: Includes all prompts, auto attendant greetings, and music on hold.
  • Reminders: Includes system and user reminders.
  • Voicemail greetings: Includes the voicemail greeting(s) for each user.

In a user data backup, FortiVoice excludes the following data:

To back up the configuration file

  1. Go to System > Maintenance > Configuration.
  2. In the Backup area, select System configuration or User data.

    If you choose to back up user data and the user data files are not updated, select the files to be updated and click Prepare first before proceeding to the next step.

  3. Click Backup.

    Your management computer downloads the configuration file. Time required varies by the size of the file and the speed of your network connection. You can restore the backup configuration later when required. For details, see Restoring the configuration.

To schedule a configuration backup

  1. Go to System > Maintenance > Configuration.
  2. Under Scheduled Backup, configure the schedule time and the maximum backup number. When the maximum number is reached, the oldest version will be overwritten.
  3. Enable Local backup if you want to back up locally. You can select a backup type to view, restore, download, or delete a configuration file.
  4. Enable Remote backup and configure the FTP/SFTP server credentials if you want to back up remotely.
  5. Click Apply.

Restoring the configuration

In the Restore Configuration under the System > Maintenance > Configuration > Trace Log, you can restore the backup FortiVoice configuration from your local computer. For details, see Restoring the configuration.

Restoring the firmware

In the Restore Firmware area under System > Maintenance > Configuration > Trace Log, you can install a FortiVoice firmware from your local computer. For details, see Upgrading the firmware.

Downloading a trace file

If Fortinet Technical Support requests a trace log for system analysis purposes, you can download one using the GUI.

Trace logs contain information that is supplementary to debug-level log files.

To download a trace file

  1. Go to System > Maintenance > Configuration > Trace Log.
  2. Configure Trace Log settings.
  3. Click Prepare to make the trace log file ready before downloading it.
  4. Click Download trace log.
  5. Find the downloaded file and send the file to Fortinet Technical Support.

Maintaining phones

The System > Maintenance > Phone Maintenance Job tab lets you update phone configurations and upgrade the phone firmware.

Click the Phone Configuration button to view the phone configuration files you have updated. For more information, seeViewing log messages.

Click the Phone Firmware button to view the phone firmware you have upgraded. For more information, see Managing the firmware.

To update phone configurations
  1. After changing the phone configuration, you have two choices to access the Phone Maintenance Job:
    • Click in the top banner, or
    • Go to System > Maintenance > Phone Maintenance Job, click New and select Configuration update.
  2. Configure the following:

    GUI field

    Description

    Name

    Enter a name for the operation.

    This option is available when you use System > Maintenance > Phone Maintenance Job only, not when you click .

    Extension Selection

    Select the extensions of which you want to perform the operation.

    All related devices (enabled)

    You want to update phone configurations or upgrade phone firmware for all devices.

    All related devices (disabled)

    You want to update phone configurations or upgrade phone firmware for selected devices.

    • Phone model: Select the phone model of the extensions of which you want to perform the operation.
    • Extensions: Click in the plus sign to select the extensions for the selected phone model.

    Schedule

    Schedule the time to update phone configurations or upgrade phone firmware.

  3. Click Create.

To update the phone firmware

For the complete sequence to upgrade the phone firmware, see the FortiFone firmware upgrades section in the FortiVoice Cookbook.

To view a phone maintenance job
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Select a row in the main table.
  3. To view details, you have four options:
  • Click the View button. The Phone Maintenance Job dialog box opens.
  • Double-click the selected row. The Phone Maintenance Job dialog box opens.
  • Go to the Progress column and hover over the percentage link. The popup window opens.
  • Go to the Progress column and click the percentage link. The Progress Detail dialog box opens.
To view the phone configuration files

You can view the phone configuration files you have updated.

  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Click the Phone Configuration button.
To view details of the phone firmware upgrade

You can view the following details about the phone firmware file:

  • File name
  • Firmware version
  • Size of the firmware file
  • File date
  • Status
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Click the Phone Firmware button.
To view log details of the phone upgrade
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Go to the Log column and click View.
To reboot phones
  1. Go to System > Maintenance > Phone Maintenance.
  2. Click New > Phone Force Reboot.
  3. Configure the following:
  4. GUI field

    Description

    Name

    Enter a name for the phone reboot operation.

    Extension Selection

    Select the extensions of which you want to perform the operation.

    All devices

    You want to reboot all of the phones registered with the FortiVoice unit.

    Selected devices

    You want to reboot some phones registered with the FortiVoice unit.

    • Phone Model: Select the phone model of the extensions of which you want to perform the operation.
    • Extension: Click the plus sign to select the extensions for the selected phone model.

    Schedule

    Schedule the time to reboot the phones.

  5. Click Create.

Viewing configuration jobs of managed devices

The System > Maintenance > Managed Device Configuration Job tab lets you view details about the jobs that you initiated on your managed devices from Managed System > Gateway or Managed System > Survivability.

For more information about updating the configuration on multiple gateways or branches at the same time, see the Actions > Start Config Job option in the following sections:

Maintaining the system

Maintaining the system

The System > Maintenance submenu allows you to perform the scheduled maintenance of FortiVoice and the phone firmware.

This topic includes:

Maintaining the system configuration

The System > Maintenance > Configuration tab contains features for use during scheduled system maintenance: updates, backups, restoration, and centralized administration.

Backing up the configuration

Before installing FortiVoice firmware or making significant configuration changes, back up your FortiVoice configuration. Backups let you revert to your previous configuration if the new configuration does not function correctly.

System configuration includes the configurations that make the FortiVoice phone system work. User data includes user-configured settings, such as voicemail greetings and reminders.

You can back up the system configuration and user data.

In addition to backing up your configuration manually, you can also configure a schedule to back up the configuration automatically to the FortiVoice local hard drive or a remote FTP/SFTP server.

In a system configuration backup, FortiVoice includes the following data:

  • Configuration (configuration file only)

In a user data backup, FortiVoice includes the following data:

  • Contacts: Includes business and directory contacts, not personal contacts.
  • Prompts: Includes all prompts, auto attendant greetings, and music on hold.
  • Reminders: Includes system and user reminders.
  • Voicemail greetings: Includes the voicemail greeting(s) for each user.

In a user data backup, FortiVoice excludes the following data:

To back up the configuration file

  1. Go to System > Maintenance > Configuration.
  2. In the Backup area, select System configuration or User data.

    If you choose to back up user data and the user data files are not updated, select the files to be updated and click Prepare first before proceeding to the next step.

  3. Click Backup.

    Your management computer downloads the configuration file. Time required varies by the size of the file and the speed of your network connection. You can restore the backup configuration later when required. For details, see Restoring the configuration.

To schedule a configuration backup

  1. Go to System > Maintenance > Configuration.
  2. Under Scheduled Backup, configure the schedule time and the maximum backup number. When the maximum number is reached, the oldest version will be overwritten.
  3. Enable Local backup if you want to back up locally. You can select a backup type to view, restore, download, or delete a configuration file.
  4. Enable Remote backup and configure the FTP/SFTP server credentials if you want to back up remotely.
  5. Click Apply.

Restoring the configuration

In the Restore Configuration under the System > Maintenance > Configuration > Trace Log, you can restore the backup FortiVoice configuration from your local computer. For details, see Restoring the configuration.

Restoring the firmware

In the Restore Firmware area under System > Maintenance > Configuration > Trace Log, you can install a FortiVoice firmware from your local computer. For details, see Upgrading the firmware.

Downloading a trace file

If Fortinet Technical Support requests a trace log for system analysis purposes, you can download one using the GUI.

Trace logs contain information that is supplementary to debug-level log files.

To download a trace file

  1. Go to System > Maintenance > Configuration > Trace Log.
  2. Configure Trace Log settings.
  3. Click Prepare to make the trace log file ready before downloading it.
  4. Click Download trace log.
  5. Find the downloaded file and send the file to Fortinet Technical Support.

Maintaining phones

The System > Maintenance > Phone Maintenance Job tab lets you update phone configurations and upgrade the phone firmware.

Click the Phone Configuration button to view the phone configuration files you have updated. For more information, seeViewing log messages.

Click the Phone Firmware button to view the phone firmware you have upgraded. For more information, see Managing the firmware.

To update phone configurations
  1. After changing the phone configuration, you have two choices to access the Phone Maintenance Job:
    • Click in the top banner, or
    • Go to System > Maintenance > Phone Maintenance Job, click New and select Configuration update.
  2. Configure the following:

    GUI field

    Description

    Name

    Enter a name for the operation.

    This option is available when you use System > Maintenance > Phone Maintenance Job only, not when you click .

    Extension Selection

    Select the extensions of which you want to perform the operation.

    All related devices (enabled)

    You want to update phone configurations or upgrade phone firmware for all devices.

    All related devices (disabled)

    You want to update phone configurations or upgrade phone firmware for selected devices.

    • Phone model: Select the phone model of the extensions of which you want to perform the operation.
    • Extensions: Click in the plus sign to select the extensions for the selected phone model.

    Schedule

    Schedule the time to update phone configurations or upgrade phone firmware.

  3. Click Create.

To update the phone firmware

For the complete sequence to upgrade the phone firmware, see the FortiFone firmware upgrades section in the FortiVoice Cookbook.

To view a phone maintenance job
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Select a row in the main table.
  3. To view details, you have four options:
  • Click the View button. The Phone Maintenance Job dialog box opens.
  • Double-click the selected row. The Phone Maintenance Job dialog box opens.
  • Go to the Progress column and hover over the percentage link. The popup window opens.
  • Go to the Progress column and click the percentage link. The Progress Detail dialog box opens.
To view the phone configuration files

You can view the phone configuration files you have updated.

  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Click the Phone Configuration button.
To view details of the phone firmware upgrade

You can view the following details about the phone firmware file:

  • File name
  • Firmware version
  • Size of the firmware file
  • File date
  • Status
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Click the Phone Firmware button.
To view log details of the phone upgrade
  1. Go to System > Maintenance > Phone Maintenance Job.
  2. Go to the Log column and click View.
To reboot phones
  1. Go to System > Maintenance > Phone Maintenance.
  2. Click New > Phone Force Reboot.
  3. Configure the following:
  4. GUI field

    Description

    Name

    Enter a name for the phone reboot operation.

    Extension Selection

    Select the extensions of which you want to perform the operation.

    All devices

    You want to reboot all of the phones registered with the FortiVoice unit.

    Selected devices

    You want to reboot some phones registered with the FortiVoice unit.

    • Phone Model: Select the phone model of the extensions of which you want to perform the operation.
    • Extension: Click the plus sign to select the extensions for the selected phone model.

    Schedule

    Schedule the time to reboot the phones.

  5. Click Create.

Viewing configuration jobs of managed devices

The System > Maintenance > Managed Device Configuration Job tab lets you view details about the jobs that you initiated on your managed devices from Managed System > Gateway or Managed System > Survivability.

For more information about updating the configuration on multiple gateways or branches at the same time, see the Actions > Start Config Job option in the following sections: