Archive Files to FTP Server

Yeastar Central Management supports archiving the backup files of P-Series Cloud PBXs generated by backup tasks on the platform to FTP server, either on a regular interval or at any time you want. This topic describes how to add FTP server as an archive server and schedule tasks to archive the desired files.

Requirements and restrictions

Requirements
  • The firmware version of Yeastar Central Management is 87.14.0.31 or later.
  • Only backup files generated by backup tasks on Yeastar Central Management and are accessible in Repository > Backup Files can be archived.
    Note: The following backup files will NOT be archived:
    • Backup files created on the PBX systems
    • Backup files that are manually uploaded to Yeastar Central Management
Restrictions
  • Archive server: 10
  • Archive task: 100

Prerequisites

Before you begin, you need to prepare the following resources and collect the required information:
  • Prepare an FTP server, and note down its Domain/IP Address, Port, and File Transfer Protocol.
  • Prepare an FTP account with both Read and Write permissions, and note down its Username and Password.
    Note: If you want old files to be automatically deleted from your FTP server, make sure the FTP account also has file deletion permission.

Step 1. Add FTP server as archive server

  1. Log in to Yeastar Central Management, go to Task > Scheduled Task.
  2. At the top of the page, click Archive Server.

  3. Set up FTP server as the archive server.
    1. Click Add.
    2. In the pop-up window, complete the following settings.

      Setting Description
      Name Enter a name to help you identify the server.
      Server Type Select FTP.
      FTP Server Domain/IP Enter the address of your FTP server.
      Port Enter the port on which your FTP server is running. The default port is 21.
      File Transfer Protocol Select the transfer protocol supported by the FTP server.
      • FTP: Standard File Transfer Protocol.
      • FTPES: FTP over Explicit TLS/SSL.
        Note:
        • The TLS feature on the FTP server must be enabled, and the encryption policy must be well-configured for security reason.
        • The supported TLS protocol version is TLS V1.2.
      Username Enter the username for the FTP account.
      Password Enter the password associated with the username.
    3. Click Save.

      The FTP server is added as an archive server and displayed on the archive server list.

  4. Click to close the window.

Step 2. Create a task to archive files to FTP server

  1. On Yeastar Central Management, go to Task > Scheduled Task, then click Add.
  2. Create a one-time or recurring archive task.

    Setting Description
    Name Enter a name to help you identify the task.
    Object Type Select P-Series Cloud Edition.
    Task Select Archive.
    Backup File Range Specify a time range of the backup files to be archived.
    Note: You can archive files for up to 31 days at a time.
    Archive Server Select the FTP server that you have added.
    File Storage Path Set the path to the folder in which you want to store archived files.
    For example:
    • Enter / to store the files under the root directory.
    • Enter /PCE-Backup-Files to store the files in a PCE-Backup-Files folder under the root directory.
    Tip: To avoid path errors, it is recommended to SSH into your server, navigate to your desired directory, and run the pwd command to obtain the absolute path. Then, use this absolute path as your storage path.
    Delete the Backup Files After Archiving Optional. If enabled, the backup files will be automatically deleted from Yeastar Central Management after being successfully archived.
    Note:
    • If a backup file is failed to be archived, it will not be deleted.
    • If you have permission to manage backup files of subordinate users, archiving operations will also delete the backup files of these subordinate users.
    Repeat Set how often to archive files to FTP server.
    • One-time: If you choose the option, the system will archive files immediately after you save the task.
    • Daily: If you choose the option, select a time from the Execution Time drop-down list. The system will archive files at this time of the day.
    • Weekly: If you choose the option, choose a day of week and select a time from the Execution Time drop-down list. The system will archive files at this time of the week.

    • Monthly: If you choose the option, choose a day and select a time from the Execution Time drop-down list. The system will archive files on this day and time of the month.
    Task File Storage Limit Optional. Set the maximum number of files generated by this archive task to be retained in the FTP server.

    When it reaches the limit, the system will retain the latest files and delete the earlier ones.

    For example, an archive task is set to execute daily at 11:00 PM with a storage limit of 3 files, which generates one archive file per day. On the 4th day, the system will delete the archived file from the 1st day and archive the new backup files from the 4th day.

    Note:

    • Each archiving task will generate one file, which may contains multiple backup files.

    • This option is available only when you schedule to archive backup files on a recurring basis. If left blank, there will be no limit on the number of files, and therefore files will not be automatically deleted.

    Timezone Select a time zone of the task execution time.
    Tip: You can enable or disable Daylight Saving Time (DST) as needed.
    Creator Your name is automatically filled in, and the field can not be edited.
    Remark Optional. Add a note to the task.
  3. Click Save.

Result

The specified files will be archived to the designated folder in your FTP server immediately or at the scheduled time.

Note: The system executes only one task at a time to avoid affecting system performance. If there are multiple tasks, they will be queued up one after another.

You can check the archive result in the following ways.

Check the archive result on Yeastar Central Management
On Yeastar Central Management, go to Task > Execution Logs. If the Result column of the task shows Succeeded, it indicates that the specified files have been successfully archived to the FTP server.

Note: If the task is not successful, you can check the details and retry it.

Check the archive result on FTP server
Go to the designated folder in FTP server. If the specified files appear in the list, it indicates that the archive is successful.