Workaround for database failures when restoring or migrating from PCoIP Management Console 2.4 or older to versions 2.5.1 or newer.

Rate this Article
Average: 1 (1 vote)

Customers on Management Console (MC) 2.4 or older, restoring databases, or migrating to 2.5.1 or newer are required to run this mandatory database clean-up script prior to the restore or migration. These steps reduce the size of the database which is required when restoring or migrating.

These instructions perform changes to the database directly. Always create a backup or snapshot of the virtual machine prior to attempting these instructions.

These first steps are recommended prior to performing any database backup on MC 2.4 or older.

  1. Download database_cleanup.sh to an accessible location on your PC.
  2. From your older MC, ensure SSH is enabled. (see your version of the Management Console Administrators' Guide for procedure)
  3. Use WinSCP and upload database_cleanup.sh to your old MC and note the location you placed the script file.
  4. From the vSphere Virtual Machine Console, browse to the location where you uploaded the database_cleanup.sh script.
  5. Run the following command to make this script an executable:
    chmod +x database_cleanup.sh
  6. Run the following command to clean up the database:
    ./database_cleanup.sh
    Do not interrupt this job and let the job run until complete.
    After 4 DELETE <number> entries are displayed, the process will be complete. You may have to wait longer for larger databases to be cleaned.
  7. Perform a database backup. (see your version of the Management Console Administrators' Guide for procedure)
  8. Make a note of the database size, if it is greater than 1GB you should delete the older log files contained in /opt/teradici/log as these log files are contained in the database backup. By reducing the total file size you will decrease the size of the database backup. If these files are required you can copy them from the management console to a shared location. 
  9. Select your backup and download it to an accessible location on your PC. (note the backup name)
  10. Login to your new MC.
  11. Select Settings and then Database.
  12. Select Upload and upload the database archive file you downloaded from step 8.
  13. Highlight your restored database and select Restore.

These instructions will clear the endpoint properties from the database. These properties are automatically reloaded when the MC communicates with each endpoint. In the meantime, the Endpoint Details pages will show empty values until the update has occurred. This is performed to reduce the size of the database to prevent restore failures.

Note: Users migrating to MC 2.5.1 are also required to perform additional steps which are included below.

Users Migrating to Management Console 2.5.1 (this is not required for migrations to 3.0.0 or newer) must complete the following additional steps.

  1. Download restore_endpoint_properties.sh to an accessible location on your PC.
  2. Ensure SSH is enabled on your MC 2.5.1 VM Console. (see your version of the Management Console Administrators' Guide for procedure)
  3. Use WinSCP and upload restore_endpoint_properties.sh to your new Management Console. (note the location you placed the sh file)
  4. From the vSphere VM Console, browse to the location where you uploaded the restore_endpoint_properties.sh script.
  5. Run the following command:
    sudo service mcdaemon stop
  6. Run the following command to make this script an executable:
    chmod +x restore_endpoint_properties.sh
  7. Run the following command:
    ./restore_endpoint_properties.sh
    The command completes after DELETE <number> and INSERT <number> <number> are displayed. You may have to wait longer for larger databases to be cleaned.
  8. Run the following command:
    sudo service mcdaemon start

These instructions will ensure the database is ready to load the endpoint properties from the endpoints without needing to perform any additional work. This prevents the MC from needing to perform a large number of data conversions.