secure-restore

This command restores a secure back up to an appliance.

Syntax

secure-restore credential source [validate]

Parameters

credential
The name of an identification credentials object in the system configuration, which identifies a crypto certificate that is used to validate and decrypt the content of the backup.
source
The URL of a directory in which the backup files are stored. The URL can be a local directory in either the local: or the temporary: directory on the appliance, or it can be a location on a remote FTP server.
validate
Optionally specify that the backup is just validated, rather than actually restored. Set to on to just validate, or off to validate and restore. The default is off.

Guidelines

You must be logged in as the admin user to use this command.

A secure backup contains private data (certificates, keys, and user data), which the appliance encrypts with a user-provided certificate. The secure backup also contains an unencrypted XML manifest. The manifest includes the date of the backup and the firmware level, model, and serial number of the appliance. You cannot view the encrypted private data, but you can view the manifest.

You can refer to the manifest files of multiple backups to determine which backup you want to restore. For example, you can identify which backup has an applicable firmware level.

The following limitations apply:
  • You must restore onto an appliance that has been reinitialized (had a factory reset performed). See Factory reset.
  • You can only restore a backup to an appliance that has exactly the same V.R.M.F version number.
  • You can restore a backup image from an M2002 to an M2002, or to an M2003.
  • You can restore a backup image from an M2003 to an M2002, or to an M2003.
  • Secure backups do not include the passwords for IPMI users. You must restore these manually.

Examples

The following example restores the backup in the temporary:///myBackupDir/ directory using the myCred identification credentials, overwriting and replacing the system configuration:
secure-restore myCred temporary:///myBackupDir
The following example validates the backup in the temporary:///myBackupDir/ directory using the myCred identification credentials, but does not modify the system configuration:
secure-restore myCred temporary:///myBackupDir on