Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2
stylenone

Overview

System administrators can manage whether to create metadata for backups. Every time that cPanel & WHM creates a backup, it creates metadata for that backup. You can also manually generate backup metadata with the backups_create_metadata script. There are several settings that disable metadata creation. You may want to disable metadata creation for testing, before an upgrade, or if your server experiences performance issues.

Note
titleNote:

When you disable metadata creation, the system disables the File and Directory Restoration interfaces in cPanel & WHM version 72 and later. WHM's File and Directory Restoration interface (Home >> WHM >> Backups >> File and Directory Restoration) will indicate whether it is disabled. cPanel will hide the File and Directory Restoration interface (Home >> cPanel >> Files >> File and Directory Restoration) from the Files section of the Home interface.

In version 70, the system disables the File Restoration interfaces in cPanel & WHM, with the same behaviors noted above for the respective interfaces.

Enable metadata creation

Localtab Group


Localtab
activetrue
titlecPanel & WHM version 70 and later

Multiexcerpt include
MultiExcerptNameMetadata Version
PageWithExcerpt70Docs:The backups_create_metadata Script


Excerpt
hiddentrue


Localtab
titlecPanel & WHM version 70

Multiexcerpt include
MultiExcerptNameMetadata Version
PageWithExcerpt70Docs:The backups_create_metadata Script



Localtab
titlecPanel & WHM version 66 and 68

Multiexcerpt include
MultiExcerptName68 Note
PageWithExcerptHow to Manage Metadata Settings


Multiexcerpt include
MultiExcerptNameMetadata 1.0
PageWithExcerpt68Docs:The backups_create_metadata script


Disable metadata creation

Localtab Group


Localtab
activetrue
titlecPanel & WHM version 72 and later

You can disable metadata creation manually or through WHM's Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration).

When you configure any of these settings to disable metadata creation, the following actions occur:

  • WHM disables the File and Directory Restoration interface (Home >> WHM >> Backup >> File and Directory Restoration). The interface will display a warning that indicates the setting that disabled it.
  • cPanel hides the File and Directory Restoration interface (Home >> cPanel >> Files >> File and Directory Restoration) from the cPanel Home interface.

The following table shows which settings manage metadata creation. These settings function independently from teach other. 

Backup configuration file settingBackup Configuration interface settingTypeDescriptionPossible values
DISABLE_METADATANone. You must manually configure this setting with the WHM API 1 backup_config_set function.string

Whether the Backup system will create metadata when a backup runs.

  • yes — Disables metadata creation.
  • no — Enables metadata creation.
BACKUPACCTSBackup Accountsstring

Whether the system will include cPanel user accounts in the backup.

Note
titleNote:

System administrators can select which cPanel user accounts they wish to include in the backup through the Backup User Selection interface (WHM >> Home >> Backup >> Backup User Selection).


  • yes or selected checkbox — Include the cPanel user accounts in the backup. Also enables metadata creation.
  • no or deselected checkbox — Do not include the cPanel user accounts in the backup. Also disables metadata creation.
BACKUPENABLEBackup StatusstringWhether the WHM System Administrator wants backups enabled.
  • yes or set toggle to Enable — Enables backup and metadata creation.
  • no or set toggle to Disable — Disables backup and metadata creation.
BACKUPMOUNTMount Backup Drive as NeededBoolean

Whether the system should mount the backup directory as a mount point before a backups runs, then unmount it when the run completes.

  • 1 or selected checkbox — Mount the backup directory. Also disables metadata creation.
  • 0 or deselected checkbox — Do not mount the backup directory. Also enables metadata creation.
KEEPLOCALRetain backups in the default backup directory.Boolean

Whether the system will retain backups in the default local backup directory.

  • 1 or selected checkbox — Retains the backup. Also enables metadata creation.
  • 0 or deselected checkbox — Does not retain the backup. Also disables metadata creation.



Localtab
titlecPanel & WHM version 70

You can disable metadata creation manually or through WHM's Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration).

When you configure any of these settings to disable metadata creation, the following actions occur:

  • WHM disables the File Restoration interface (Home >> WHM >> Backups >> File Restoration). The interface will display a warning that indicates the setting that disabled it.
  • cPanel hides the File Restoration interface (Home >> cPanel >> Files >> File Restoration) from the cPanel Home screen.

The following table shows which settings manage metadata creation. These settings function independently from teach other. 

Backup configuration file settingBackup Configuration interface settingTypeDescriptionPossible values
DISABLE_METADATANone. You must manually configure this setting with the WHM API 1 backup_config_set function.string

Whether the Backup system will create metadata when a backup runs.

  • yes — Disables metadata creation.
  • no — Enables metadata creation.
BACKUPACCTSBackup Accountsstring

Whether the system will include cPanel user accounts in the backup.

Note
titleNote:

System administrators can select which cPanel user accounts they wish to include in the backup through the Backup User Selection interface (WHM >> Home >> Backup >> Backup User Selection).


  • yes or selected checkbox — Include the cPanel user accounts in the backup. Also enables metadata creation.
  • no or deselected checkbox — Do not include the cPanel user accounts in the backup. Also enables metadata creation.
BACKUPENABLEBackup StatusstringWhether the system will create backups.
  • yes or set toggle to Enable — Enables backup and metadata creation.
  • no or set toggle to Disable — Disables backup and metadata creation.
KEEPLOCALRetain backups in the default backup directory.Boolean

Whether the system will retain backups in the default local backup directory.

  • 1 or selected checkbox — Retains the backup. Also enables metadata creation.
  • 0 or deselected checkbox — Does not retain the backup. Also disables metadata creation.

BACKUPMOUNTMount Backup Drive as NeededBoolean

Whether the system should mount the backup directory as a mount point before a backups runs, then unmount it when the run completes.

  • 1 or selected checkbox— Mount the backup directory. Also disables metadata creation.
  • 0 or deselected checkbox — Do not mount the backup directory. Also enables metadata creation.



Localtab
titlecPanel & WHM version 66 and 68


Multiexcerpt
MultiExcerptName68 Note


Note
titleNote:
  • The system enables metadata creation automatically in cPanel & WHM version 66 and 68. You cannot disable metadata creation in these versions.
  • If you upgrade from version 66 or 68 to later versions of cPanel & WHM, your backup configuration may affect whether the File Restoration interface (version 70) or the File and Directory Restoration interface (version 72 and later) is disabled or visible. For more information, see the cPanel & WHM version 70 or cPanel & WHM version 72 or later tabs in the Disable metadata creation section of this document.





Additional documentation

Localtab Group


Localtab
activetrue
titleSuggested documentation

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("backups","restore") and label in ("whm","cpanel") and space = currentSpace()


Localtab
titleFor cPanel users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("backups","restore") and label = "cpanel" and space = currentSpace()


Localtab
titleFor WHM users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("backups","restore") and label = "whm" and space in (currentSpace(),"DOC")


Localtab
titleFor developers

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("backups","restore") and space = "DD"