Manage backup templates

Templates are composed of backup policies. In policies, you can define when torun a backup, how frequently to run a backup, how long to retain the backupimage for (Days,Weeks,Months,Years), and also additionalconfiguration when the policy is applied to a different application, such as afile system, database, or VM.

Backup policy types include:

Note: Templates that are used to backup Compute Engine instances should only contain production to snapshot policies. You can't use a template that has OnVault or StreamSnap policies with a Compute Engine instance.

Create a backup template

Use these instructions to create a backup template:

  1. Click theBackup Plans tab and selectTemplates fromthe drop-down menu.

    TheTemplates page opens.

  2. ClickCreate Templates.

    TheCreate Template page opens appears with a new (empty) backup template.

  3. In theTemplate field, enter a name for the backup template. For thetemplate name, enter an alphanumeric text string. Spaces, underscores (_),and dashes (-) are allowed in a name. Don't include special characters.

  4. In theDescription field, enter a brief description about thisbackup template.

  5. To modify theALLOW OVERRIDES ON POLICY SETTINGS:

    • ClickYes to allow selectedApp Manager advanced settings tooverride the settings specified in a backup plan policy's advanced settings.You can override policy settings in theApp Manager only if theALLOW OVERRIDES ON POLICY SETTINGS parameter is set toYes.
    • ClickNo if you don't want to allow backup plan policy setting overridein theApp Manager.
  6. Click either+(Plus) in the backup plan policy map or+Add in thePolicies section to add a backup policy. Backup policy includes:

    Note: Templates that are used to backup Compute Engine instances shouldonly contain production to snapshot policies. You can't use a template thathas OnVault or StreamSnap policies with a Compute Engine instance.
  7. Enter aPolicy Name.

  8. If appropriate for the policy type, specify the schedule type,WindowedorContinuous. The default isWindowed.

  9. Configure the policy frequency settings per the selected scheduletype as outlined in the following lists:

  10. Optionally, change the application priority from thePrioritydrop-down list. The default job priority is medium, but you canchange the priority to high or low.

    1. Configure theAdvanced Policy Settings. SeeConfigure advanced policy settings for a backup plan policy for details.
    Note:Advanced Policy Settings defined in a policy can be overridden by theApplication Details & Settings inApp Manager, if the policy's template has been set to allow overrides.
  11. When you are finished creating the new policy, clickUpdate Policy toadd it to the template. You return to theTemplates list.

  12. ClickSave Template.

View and filter backup templates

The templates window lists all of the backup templates that are developed onthe management console. From theTemplates window, you can view informationsuch as the template name, description, and allow policy override for allbackup templates in management console. You can modify the display of fieldsthat appear in theTemplates table, and you can also use the filter featureto locate backup templates by these identifiers.

  1. Click theBackup Plans tab and selectTemplates from thedrop-down menu. TheTemplates page opens.
  2. To modify the display of the properties in this view, you can:

  3. To export the policy templates list click the export icon.You can export in PDF format.

Add policies to an existing backup template

To modify an existing backup template to include an additional policy:

  1. Click theBackup Plans tab and selectTemplatesfrom the drop-down menu.

    TheTemplates page opens.

  2. Select the backup template that you want to modify, thenselectEdit (bottom right-hand corner of the page).

    TheTemplates window appears with the existing backup template.

    Note: You can also right-click on the item in the list and selectEdit from the menu.
  3. If you want to modify the template name or description, make therequired changes in theTemplate orDescription fields.

    Note: For template name, enter an alphanumeric text string. Spaces, underscores (_), and dashes (-) are allowed in a name, but don't include special characters.
  4. If you want to modify theALLOW OVERRIDES ON POLICY SETTINGS,complete the following:

    Note: You can override policy settings inApp Manager only if the backup plan policy templateALLOW OVERRIDES ON POLICY SETTINGS parameter has been set toYes.
  5. To add a policy to an existing backup template, click either+(Plus)in the backup plan policy map or+Add in thePolicies area of theTemplates window. Policy types include: snapshot, snapshot toOnVault, and production-to-mirror replication (StreamSnap).

    The associated policy configuration panel appears in theTemplate window.

  6. When you are done creating the new policy, clickUpdate Policyto add it to the template. You return to theTemplates window.

  7. ClickSave Template.

Edit an existing backup template

After creating a backup template, you can change the following:

To make the changes:

  1. Click theBackup Plans tab and selectTemplates fromthe drop-down menu.

    TheTemplates page opens.

  2. Select the backup template that you want to modify, then clickEdit (bottom right-hand corner of the window).

    TheTemplates page opens with the existing backup template.

    Note: You can also right-click on the item in the list and selectEdit from the menu.
  3. If you want to modify the template name or description, make therequired changes in theTemplate orDescription fields.

    Note: For template name, enter an alphanumeric text string. Spaces, underscores (_), and dashes (-) are allowed in a name, but don't include special characters.
  4. If you want to modify theALLOW OVERRIDES ON POLICY SETTINGS,complete the following:

    Note: You can override policy settings inApp Manager only if the backupplan policy templateALLOW OVERRIDES ON POLICY SETTINGS parameter hasbeen set toYes.
  5. In thePolicies area of theTemplate window, click the arrow to theleft of the backup plan policy you want to edit and review the settings.There might be multiple policies under a specific policy type.Select the backup plan policy that you want to edit, then clickEdit Policy.The associated policy configuration panel appears in theTemplate window.

  6. Edit the backup plan policy as needed.

  7. When you are done making policy edits, clickUpdate Policy.

Clone a backup template

Use these instructions to clone an existing backup template:

  1. Click thebackup Plans tab and selectTemplates fromthe drop-down menu.

    TheTemplates page opens.

  2. Select one or more templates that you want to clone.

  3. Right-click and selectClone from the drop-down menu options.(For multiple template selections, you can also go to the bottomright corner of the page and select theClone option.)

    You are prompted to confirm that you want to clone the selected templates.

  4. ClickYes to clone the templates. You will see a successmessage at the end of the cloning process.

  5. ClickClose. The cloned template is listed in theTemplateslist and has a prefix of "Copy of ...".

    Note: If you had selected multiple templates, a clone is created for each template.

Delete a backup template

Use these instructions to delete a policy template:

Note: You can delete a policy template only when the policy template isn't used in theApp Manager service to manage an application.
  1. Click theBackup plans tab and selectTemplates from thedrop-down menu.

    TheTemplates page opens.

  2. Select the backup template from the list, then clickDelete(bottom right-hand corner of the window). The backup template isremoved from theTemplates window.

    Note: You can also right-click on the item in the list and selectDelete from the menu.

You aren't allowed to delete all replication policies from a templateif any snapshot policy includes database log replication.

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.