Skip to content

Migration from legacy tools

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

The backup and restore CLI tools underwent a major architectural change with the launch of Aerospike Backup Control (absctl). It provides the backup and restore subcommands.

This page explains the breaking changes and how to migrate from the legacy asbackup and asrestore tools.

For more information and downloads, see the following GitHub repositories:

Prerequisites

The absctl CLI supports Aerospike Database 5.7.0 and later. For Aerospike Database versions before 5.7.0, you must use a legacy tools package with asbackup and asrestore.

Aerospike publishes absctl packages for the following operating systems:

  • macOS (arm64) - a .pkg installer is provided.
  • Linux (arm64/amd64) - .deb and .rpm packages are provided.

Upgrade from legacy tools

To upgrade, remove the legacy backup tools or the legacy tools package, then download and use the new tools.

Linux

  1. Download the Debian package for your distribution and CPU architecture from Install Aerospike Backup Control.
  2. Remove the legacy tools package by running dpkg -r aerospike-tools. Removing the legacy tools package also removes asbench, aql, and asadm.
  3. Install the package with dpkg -i ABSCTL_DEB, replacing ABSCTL_DEB with the name of the downloaded file.
  4. Verify the installation by running absctl --help.

Windows

Aerospike publishes no Windows package for absctl 1.2.0 and later. For other ways to run absctl, see Install Aerospike Backup Control.

macOS

The absctl installer package supports Apple silicon (arm64) only. For other ways to run absctl on an Intel Mac, see the macOS x86_64 tab in Install Aerospike Backup Control.

  1. Download the macOS installer package from Install Aerospike Backup Control.

  2. Remove the legacy backup tools.

    Terminal window
    rm -rf /usr/local/bin/asbackup
    rm -rf /usr/local/bin/asrestore
  3. Install absctl. In the following example, replace ABSCTL_PKG with the name of the downloaded file. The installer places absctl in /usr/local/bin.

    Terminal window
    sudo installer -pkg ABSCTL_PKG -target /
  4. Verify the installation by running absctl --help.