Software: Download a Backup, Upgrade Software



Backup Settings

It is an important disaster recovery best practice to save a backup copy of your software settings regularly. BeyondTrust recommends backing up your B Series Appliance configuration each time you change its settings. In the event of a hardware failure, a backup file speeds time-to-recovery and, if necessary, allow BeyondTrust to provide you access to temporary hosted services while retaining the settings from your most recent backup.

Backup Password

To password protect your software backup file, create a password. If you do choose to set a password, you cannot revert to the backup without providing the password.

Include Logged History Reporting Data

If this option is checked, your backup file includes session logs. If unchecked, session reporting data is excluded from the backup.

Download Backup

Save a secure copy of your software configuration. Save this file in a secure location.

Backup Vault Encryption Key

The Vault encryption key is used to encrypt and decrypt all the Vault credentials stored on the B Series Appliance. If you are ever required to restore configuration data from a backup onto a new B Series Appliance, you must also restore the Vault encryption key from a backup to be able to use the encrypted Vault credentials contained in the configuration backup.

Restore Settings

Configuration and Vault Encryption Key Backup File

Should you need to revert to a backup, browse to the latest backup file that you saved.

Configuration and Vault Encryption Key Backup Password

If you created a password for your backup file, enter it here.

Upload Backup

Upload the backup file to your B Series Appliance and restore your site's settings to those saved on the backup.

For more information, please see Back Up Procedures.

Upload Update

Select a software update file to manually upload new software packages from BeyondTrust. You must confirm that you wish to upload the software package. The Uploaded Update section displays additional information to verify your uploaded package. Click Install if you wish to complete the installation process, or Delete Update if you wish to clear the update staging area. If your update package only contains additional licenses, you can install the update without restarting the B Series Appliance. After confirmation that you wish to install, the page displays a progress bar to notify you of the overall installation progress. Updates made here automatically update all sites and licenses on your B Series Appliance.

Your B Series Appliance administrator can also use the Check for Updates feature of the B Series Appliance interface to automatically search for and install new software packages.

Site Migration

Site migration allows you to migrate configuration settings and data from another BeyondTrust Privileged Remote Access site. For example, migration can be used to move from an on-premises installation to a cloud installation. Migration uses an API account to automatically download and restore a backup.

Preparation for Migration

Before migrating the data, please observe these prerequisites and conditions:

  • The API account needs read-only or higher access to the command API, and access to the backup and Vault encryption key APIs.
  • The administrator needs access to the local admin account to log in, in case security providers do not reconnect properly after the migration.
  • If the source site version is earlier than 21.2, the Vault encryption key must be migrated manually.
  • Recordings are not included as part of migration. To retain access to existing recordings, keep the source online with a different host name or use the integration client to back up the recordings before migration.
  • After the data has been migrated, additional steps are required to make the new instance fully functional. These steps are listed on the Site Migration panel, and are summarized below:
    • Create a new DNS entry for the host name to access the old site.
    • Add the new host name to the old site public portal.
    • Confirm access to the old site.
    • Allow time for DNS entries to propagate across networks.
    • Click the Restart Software button on the old site to upgrade clients to use the new site.

Data Migration

  1. Enter the following information about the source site to start a migration:
    • Hostname
    • OAuth Client ID
    • OAuth Client Secret
  2. Once the information is entered, click Verify Connection.
    • A pop-up notification verifies the connection and that the site version is supported.
    • Reset can be clicked at any time before starting the migration, if changes are required.
  3. If applicable, click +Choose Certificate to select the SSL Certificate for a self-signed SSL certificate.

Certificates must be in PEM, DER, or CRT format.

An option to Automatically begin site migration is available once the connection is verified. Check this option to bypass some of the steps and notifications that follow. If checked, click Retrieve Backup and respond to the notifications to complete the migration.

  1. Review displayed information, and if correct, click Retrieve Backup. If not correct, click Reset.
  2. Pop-up confirmation messages appear for the backup file and, if applicable for your version, the Vault encryption key. The file names display on the panel, as well as a Migrate Site button.
  3. Click Migrate Site.
  4. A pop-up notification warns that a local account is required, and a second pop-up warns that the migration overwrites data on the current site. Then a Migration in Process message displays.
  5. When the migration completes, click Yes in the pop-up notification to reset the site. Log in again to view the migrated data.
  6. Complete the post-migration steps listed on the Site Migration panel.