Restoring a secure backup by using the CLI

You can restore a secure backup of the IBM® MQ Appliance by using the command line interface.

About this task

A secure backup creates files that contains the configuration of the appliance. The backup files are secured by a user certificate. The backup includes details of MQ users, but does not include queue manager configurations or data, or high availability or disaster recovery configuration details. For more details, see Secure backup.

You can use the secure backup and restore to migrate to another appliance, see Secure restore.

You must reinitialize an appliance (complete a factory reset) before you restore to it. See Factory reset.

Note: When a secure backup is restored the password for the built-in admin user is reset to admin. The password for the admin user must be changed at first login (as happens after a factory reset of the appliance).

Procedure

Connect to the IBM MQ Appliance as described in Command line access.
Log in as a user in the administrators group.
Type the following command:
```
secure-restore credential source [validate]
```
Where:

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, see Creating an identity credentials object for a secure backup restore.

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.

Results

The configuration in the secure backup is applied to the appliance and the appliance restarts.

Example

The following example restores the secure backup stored in the directory temporary:///myBackupDir using the identity credentials object mybackupcred:

secure-restore mybackupcred temporary:///myBackupDir

The following example validates the secure backup stored in the directory temporary:///myBackupDir using the identity credentials object mybackupcred, but does not modify the system configuration:

secure-restore mybackupcred temporary:///myBackupDir on