Backup the appliance

If an appliance is corrupted, you might need to restore the appliance from a backup file. The backup file contains configuration settings and management data that is stored in a proprietary format.

After the backup is initiated, a TaskResource URI is created, that you use to track the progress of the backup. When the backup is complete, you can use a GET REST API operation to download and change the backup file name. The latest backup is stored on the appliance and is replaced when a new backup is initiated.

Prerequisites

  • Minimum required session ID privileges: Backup administrator

Creating and downloading an appliance backup file using REST APIs
  1. Create the backup file.

    POST /rest/backups

  2. Download the backup file.

    GET /rest/backups/archive/{backup URI}


[NOTE: ]

NOTE: After the POST operation is complete, a TaskResource URI and backup URI are returned. You can use the TaskResource URI to monitor the progress of the backup. Use the backup URI to refer to a specific backup when downloading the backup file or performing another operation.