Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2407 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Backup and Restore using Web Studio

December 16, 2024
Contributed by: 
C

This article describes the actions that you can perform on the Backup and Restore node available in the left pane of your console.

Backup and Restore allows the administrator to take backups from the Web Studio.

Set up storage location

Before creating backups, you must set up a storage location to store backups.

  1. From Web Studio, click Manage.
  2. From the left-menu, select Backup+Restore.
  3. Within the Backup and Restore tab, click Setup storage.
  4. From the drop-down list, select a Storage type. The Storage type can be a File Storage or an Azure Storage.

    Note:

    • The location must be accessible to all Delivery Controllers.
    • If access to the folder requires a username and password, make sure that corporate password policies do not limit the lifespan of the password.

  5. Select the following:

    • Maximum backups
    • Maximum pinned backups
    • Maximum auto-pinned backups
  6. Click Save and create backup.

After you set up a storage location, you can create backups.

Create on-demand backups

  1. From Web Studio, click Manage.
  2. From the left-menu, select Backup+Restore.
  3. Within the Backup and Restore tab, click Create backup.

  4. On the Create backup page, enter the notes, and click Create backup.

    A summary activity is displayed showing the backup components being backed up in the admin’s name who triggers the back up.

  5. After the backup completes successfully, it is listed as a line item under the Backup and Restore tab.
  6. Select a particular backup to see more information on the backup in the Details tab.
  7. Right-click a backup to pin or delete the selected backup.

Note:

Citrix stores the last 30 backups. When you create more than 30 backups, the system deletes old backups in the order they were created. For every new backup that is created in addition to the 30 backup limit, the system deletes the backup that was created first. Pin backup is used to prevent automatic deletion of a particular backup. You can pin up to 5 backups. In case there are pinned backups, we retain all pinned backups in addition to 30 backups that is at most, you can retain 35 backups – 30 non-pinned, and 5 pinned backups.

Create scheduled backups

  1. From Web Studio, click Manage.
  2. From the left menu, select Backup + Restore.
  3. Go to the schedule tab and select Create Schedule.

  4. On the Create schedule page, enter the following:

    • Enable this schedule. Choose yes to enable this backup schedule.
    • Name. Enter a name for the backup schedule.
    • Description. Enter a description.
    • Time zone. Select the time zone of your choice.
    • Frequency. Select the frequency to run the backup.
    • Repeats every. Enter the number of days after which the schedule must be repeated.
    • Start date. Enter the start date.
    • Begin backup at. Enter the time when you want the backup to begin in a 24-hour format.
  5. Select Done.
  6. Select View Restore Details to see more information about the restore.

Limit scheduled backups

You can limit scheduled backups to one per day to avoid identical backups.

  1. Go to the Settings tab of the Backup and Restore node.
  2. Click Change in Scheduled backups box.
  3. Switch the toggle to enable limit scheduled backups to one per day.

Auto-pin scheduled backups

Use auto-pin to retain a maximum of six scheduled backups. When the maximum limit is reached, the oldest auto-pinned backup is deleted.

Note:

Citrix stores up to six auto-pinned backups. The system deletes old backups in the order that they were created after the sixth backup. For every new backup that is created in addition to the six backup limit, the system deletes the backup that was created first.

  1. Go to the Settings tab of the Backup and Restore node.
  2. Select a scheduled backup for auto-pinning.
  3. Switch the toggle to enable auto-pinned schedules.
  4. Select a schedule and click Save.

Edit backup storage

You can edit the backup storage settings to change the storage type and location, maximum backups, maximum pinned backups, and maximum auto-pinned backups.

  1. Go to the Settings tab of the Backup and Restore node.
  2. Click Change in Storage box.
  3. Change the storage settings in the Edit backup storage dialog.

Restore

This feature allows the administrators to restore the site configurations from the backups. We allow you to restore one component at a time.

Note:

  • Restoring only one component at a time ensures that there are no conflicts during restoration due to the dependencies between the components.
  • The workflow for restoring host connections is different from other components as you would need to enter the secret every time you try to restore the host connection. After you click Restore Backup, you must see a dialog to enter the secret. For example, in Azure, enter the alphanumeric application secret used to create the connection.
  1. From Web Studio, click Manage.
  2. From the left menu, select Backup and Restore.
  3. Click a specific backup from the list.
  4. Click Restore Backup.

  5. On the Restore Backup window, enter the following:

    • Components: Select the components that you want to restore.

    • Filters: Specify the member names that you want to restore in a comma-separated list. For example, filtering for the word chrome restores only objects with the name chrome. Similarly, the phrase chr restores objects beginning with chr.

      Note:

      Select a backup and navigate to Details > Components > View Members to define filters corresponding to existing components and their members.

    • Check mode: Choose yes to confirm what must be restored when an actual restore operation is done. This option pre-evaluates everything needed for a restore without actually triggering one. For example, it displays the list of applications that will be restored when the restore process is run for the applications component.

      Note:

      Check mode does not run the actual restore. This option also does not check for any dependencies between the components. For optimal results, we recommend using the check mode on one component at a time.

    • Restore type: Choose either one:

      • Missing only: Use this restore type to add components and members to a site. This option does not change the existing components and members even if the backup being restored has different configurations.
      • Missing and updating existing: Use this restore type to add and update components to a site. This option updates the existing components and members with the configurations of the backup if both have different configurations.
    • Notes: Enter any notes.
  6. Select Restore.

The restore results are listed in the Restore window after the restore action is completed. All restore actions are listed under the History tab.

History

You can track all the Backup+Restore actions in the History. This page gives you the following information:

  • Action performed
  • Components and members backed up
  • Who performed the activity

Use the search bar on the top right in the History tab to search for a specific backup. For example: you can search for backups taken by a particular admin or taken on a particular day.

Backup and Restore using Web Studio
December 16, 2024
Contributed by: 
C
December 16, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.