Skip to content

serviced backup

The serviced backup command saves a snapshot of the current state of the system, the state of all services, and application data to a compressed tar archive file (.tgz).

You can back up the entire system or exclude certain directories, such as the directory that contains application performance data.

Before starting a backup, Control Center estimates the size of the backup file and compares it to the amount of free space. If storage space is insufficient, Control Center does not start a backup. Exit code 1 indicates insufficient space. If storage space is insufficient, take action to increase available space, and then try the backup again.

USAGE

serviced backup [arguments...] Backup-Path

OPTIONS

--exclude Item [–exclude Item] ...

One or more tenant volume items to exclude from the backup. The following list identifies valid values for Item:

  • etl-analytics
  • hbase-*
  • mariadb-events
  • rabbitmq
  • zeneventserver
  • var-zenpacks
  • zenjobs
  • zencatalogservice

--check

Estimate the backup file size and check available storage space, but do not start the backup.

--force

Attempt to perform a backup even if the check for sufficient storage space failed. Use this override option with caution. If the backup exhausts storage space on the device, you must restart serviced.

[--help|–h]

Show the help message.

EXAMPLE

Create a backup without HBase or the Solr index:

serviced backup --exclude hbase-* \
  --exclude zencatalogservice /opt/serviced/var/backups/