Child pages
  • The backups_create_metadata Script
For cPanel & WHM version 74

Skip to end of metadata
Go to start of metadata

Overview

The /usr/local/cpanel/scripts/backups_create_metadata script allows a user to create metadata files for all account backup types.

Note:

The script will generate metadata for all directories under the /home/username directory, except for the /mail and /.cpanel directories.

The backups_create_metadata script

To use the /usr/local/cpanel/scripts/backups_create_metadata script, run the following command as the root user:

/usr/local/cpanel/scripts/backups_create_metadata [arguments] [inputs]

Arguments and inputs

Note:

You must provide at least one option to execute this script.

Use the following arguments for the /usr/local/cpanel/scripts/backups_create_metadata script:

ArgumentsDescriptionInput valuesExample
--all

Creates metadata files for all backups.

Note:

You cannot combine the --all argument with other arguments.

None./scripts/backups_create_metadata --all
--backup=[backup filename]

Creates metadata files for the specified backup file.

Use this argument with the --user argument to create metadata for the specified user.

The backup file's name./scripts/backups_create_metadata --backup=monthly/YYYY-DD-MM
--user=[user]

Creates metadata files for the specified user.

The cPanel account's username./scripts/backups_create_metadata --user=abc1
--vacuum

Defragments the metadata SQL database and frees unused space.

Notes:

  • The –vacuum argument will only free space if the database has unused space. If you have already used the --vacuum argument to free database space, you cannot use it again to clear additional space.
  • You cannot combine the --vacuum argument with other arguments.
None./scripts/backups_create_metadata --vacuum
--schedule_rebuildSame as the --all argument, but runs the script in the background.None./scripts/backups_create_metadata --schedule_rebuild

Additional documentation