Skip to content

Managing PCoIP Management Console Databases

The PCoIP Management Console maintains a database containing its configuration data, information about the PCoIP endpoints it has discovered, console and daemon log files. You can archive multiple snapshots of these PCoIP Management Console database settings and store them on your PCoIP Management Console virtual machine. You can also download a stored archive to a location external to your PCoIP Management Console virtual machine, for instance, the host PC you use to access the PCoIP Management Console web browser.

Management Console requires at minimum, 1.5 times the size of the database to successfully perform a database restore, backup or upload. This calculation happens automatically and if the requirement is not met, a warning banner is displayed advising the Management Console VM is running out of disk space.

Database log file size

Database can become very large. If your backup is failing due limited disk space, you can try excluding the log files from the backup.

You can manage PCoIP Management Console database archives by clicking SETTINGS from the PCoIP Management Console’s top menu, then clicking the DATABASE menu in the left pane.

Note: Applying Profiles Created in Versions Earlier than 23.12.2

If a profile is created in version earlier than 23.12.2 for Zero Clients running firmware 23.12.x and with Enable Audio disabled, while applying this profile in version 23.12.2, ensure that Enable Analog Audio Input is disabled.

Displaying Database Information

The DATABASE MANAGEMENT page enables you to back up, upload, download, restore, and delete PCoIP Management Console database archives.

Click the gear icon Gear Icon to the right of the table to change the information you want to display in the table columns. Your customized settings are saved in your browser and will be used for any user who subsequently logs in from that browser.

Enterprise database Mgmt Page
The DATABASE MANAGEMENT page

Backing Up PCoIP Management Console Database

To take a snapshot of your current PCoIP Management Console and store it in a database archive within the PCoIP Management Console virtual machine:

  1. From the PCoIP Management Console’s top menu, click SETTINGS.

  2. Click DATABASE in the left pane.

  3. Click BACK UP.

  4. Enter a description, check the EXCLUDE LOGS option if you want to exclude the log files, and click BACK UP. Log files can become large and take up additional disk space, so you may wish to check this option if disk space is a concern.

    DB Backup Dialog
    Backup Dialog

The database log files can be found in the Management Console VM /opt/teradici/backups/<database_folder>/logs folder. For more information on database log files see Managing Management Console Logs

The archive will appear in the database table when the backup has completed.

Uploading a Database Archive from an External Location

To upload a database archive from an external location:

  1. From the PCoIP Management Console’s top menu, click SETTINGS.

  2. Click DATABASE in the left pane.

  3. Click UPLOAD.

  4. Click Select File, locate the archive file (.archive) and then click Open.

  5. Click UPLOAD to transfer the archive file to the PCoIP Management Console virtual machine. The archive file will appear in the database table when you are finished.

Downloading a Database Archive to an External Location

To download a database archive to an external location:

  1. From the PCoIP Management Console’s top menu, click SETTINGS.

  2. Click DATABASE in the left pane.

  3. From the database table, select the archive file you wish to transfer to a location external to your PCoIP Management Console virtual machine.

  4. Click DOWNLOAD.

5.Save the file to the desired location.
Typically, this is a directory on the host PC that is running the PCoIP Management Console web browser.

Restoring PCoIP Management Console Database

Caution: Take a snapshot of your current virtual machine database before restoring a database archive

Restoring a database archive will permanently delete all current data from the database. Please ensure you have taken a snapshot of your current PCoIP Management Console virtual machine database before proceeding.

To restore a database archive from the PCoIP Management Console virtual machine:

  1. From the PCoIP Management Console’s top menu, click SETTINGS.

  2. Click DATABASE in the left pane.

  3. From the database table, select the archive file you wish to restore.

  4. Click RESTORE.

  5. Enable the message prompt and then click RESTORE.

Deleting PCoIP Management Console Database

To delete a database archive from the PCoIP Management Console virtual machine:

  1. From the PCoIP Management Console’s top menu, click SETTINGS.

  2. Click DATABASE in the left pane.

  3. From the database table, select the archive file you wish to delete.

  4. Click DELETE.

  5. Enable the message prompt and then click DELETE.

Expanding the PCoIP Management Console Virtual Machine Database and Disk Size

This section provides information on expanding your PCoIP Management Console Virtual Machine database size and the related disk sizing guidelines.

The basic PCoIP Management Console OVA will create a default configuration as follows:

  • Virtual Machine Hardware Version: 14

  • CPU: 4 vCPU

  • Memory: 12 GB

  • Provisioned Storage: 62 GB

Caution: Modifying virtual machine settings should only be considered by qualified individuals

Only qualified individuals should modify any virtual machine settings. Support strongly recommends you perform a database backup of the PCoIP Management Console and download the archive file to a safe location. You should also take a snapshot of the virtual machine prior to modifying any settings.