Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 8. Backing Up and Restoring Data Grid Clusters

Create archives of Data Grid resources that include cached entries, cache configurations, Protobuf schemas, and server scripts. You can then use the backup archives to restore Data Grid Server clusters after a restart or migration.

Prerequisites

  • Start the Data Grid CLI.
  • Connect to a running Data Grid cluster.

8.1. Backing Up Data Grid Clusters
Copy link

Create backup archives in .zip format that you can download or store on Data Grid Server.

Prerequisites

Backup archives should reflect the most recent cluster state. For this reason you should ensure the cluster is no longer accepting write requests before you create backup archives.

Procedure

  1. Create a CLI connection to Data Grid.

  2. Run the backup create command with the appropriate options, for example:

    • Back up all resources with an automatically generated name. 

      [//containers/default]> backup create
      Copy to Clipboard Toggle word wrap

    • Back up all resources in a backup archive named example-backup. 

      [//containers/default]> backup create -n example-backup
      Copy to Clipboard Toggle word wrap

    • Back up all resources to the /some/server/dir path on the server. 

      [//containers/default]> backup create -d /some/server/dir
      Copy to Clipboard Toggle word wrap

    • Back up only caches and cache templates. 

      [//containers/default]> backup create --caches=* --templates=*
      Copy to Clipboard Toggle word wrap

    • Back up named Protobuf schemas only. 

      [//containers/default]> backup create --proto-schemas=schema1,schema2
      Copy to Clipboard Toggle word wrap

  3. List available backup archives on the server. 

    [//containers/default]> backup ls
    Copy to Clipboard Toggle word wrap

  4. Download the example-backup archive from the server.

    If the backup operation is still in progress, the command waits for it to complete. 

    [//containers/default]> backup get example-backup
    Copy to Clipboard Toggle word wrap

  5. Optionally delete the example-backup archive from the server. 

    [//containers/default]> backup delete example-backup
    Copy to Clipboard Toggle word wrap

Apply the content of backup archives to Data Grid clusters to restore them to the backed up state.

Prerequisites

  • Create a backup archive that is either local to the Data Grid CLI or stored on Data Grid Server.
  • Ensure that the target container matches the container name in the backup archive. You cannot restore backups if the container names do not match.

Procedure

  1. Create a CLI connection to Data Grid.

  2. Run the backup restore command with the appropriate options.

    • Restore all content from a backup archive accessible on the server. 

      [//containers/default]> backup restore /some/path/on/the/server
      Copy to Clipboard Toggle word wrap

    • Restore all content from a local backup archive. 

      [//containers/default]> backup restore -u /some/local/path
      Copy to Clipboard Toggle word wrap

    • Restore only cache content from a backup archive on the server. 

      [//containers/default]> backup restore /some/path/on/the/server --caches=*
      Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat