Installing BOSH Backup and Restore

Page last updated:

Warning: VMware Enterprise PKS v1.7 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.

This topic describes how to install BOSH Backup and Restore (BBR).


To install BBR, first validate that your jumpbox VM is a valid BOSH backup host, then copy the BBR executable to the jumpbox.

After installing BBR, you can run bbr commands to back up and restore your Enterprise PKS deployment.

For more information about using BOSH Backup and Restore, see:


Using BBR requires the following:

  • A jumpbox. You must have a jumpbox before you can install BBR to the jumpbox.
  • A bbr executable file. You must have the correct BBR executable version for your PKS installation.

A jumpbox is a separate, hardened server on your network that provides a controlled means of accessing the other VMs on your network. See the jumpbox-deployment GitHub repository for an example jumpbox deployment.

To determine the correct version of BBR for your deployment, see the Enterprise PKS Release Notes. To download a BBR installation file, see BOSH Backup and Restore on the VMware Tanzu Network.

Configure Your Jumpbox

Configure your jumpbox to meet the following requirements:

  • Your jumpbox must be able to communicate with the network that contains your Enterprise PKS deployment. You can use the Ops Manager VM as your jumpbox.
  • Your jumpbox must have sufficient space for the backup.
  • Your jumpbox must be in the same network as the deployed VMs because BBR connects to the VMs at their private IP addresses. BBR does not support SSH gateways.
  • Your jumpbox should be a host with minimal network latency to the source VMs you are configuring BBR to backup.

Note: BBR uses SSH to orchestrate the backup of your Enterprise PKS instances using port 22 by default.

Transfer BBR to Your Jumpbox

Copy the bbr executable to a local disk then upload the executable to the jumpbox:

  1. Download the latest BOSH Backup and Restore release from VMware Tanzu Network.
  2. To add executable permissions to the bbr binary file, run the following command:

    chmod a+x bbr
  3. To securely copy the bbr binary file to your jumpbox, run the following command:



    • LOCAL-PATH-TO-BBR is the path to the bbr binary you downloaded from VMware Tanzu Network.
    • JUMPBOX-USER is the ssh username for connecting to the jumpbox.
    • JUMPBOX-ADDRESS is the IP address, or hostname, of the jumpbox.

Please send any feedback you have to