Creating a secure backup by using the CLI

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

About this task

A secure backup creates files that contain 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.

Procedure

  1. Connect to the IBM MQ Appliance as described in Command line access.
  2. Log in as a user in the administrators group.
  3. Type the following command:
    secure-backup certificate destination 
    Where:
    certificate
    The name of a certificate object in the system configuration, which identifies a crypto certificate that is used to encrypt the content of the backup. A certificate that contains ECDSA keys is not supported. See Creating a certificate for a secure backup.
    destination
    The URL of a directory in which the backup files are written. If the directory is on a local file system, it is created automatically if it does not exist. The URL can be a local directory in either the local: or the temporary: directories on the appliance, or it can be a location on a remote FTP server.

Results

The backup folders are written to the specified location.

Example

The following example creates a secure backup in the temporary:///myBackupDir/ folder using the myCert certificate object.

secure-backup myCert temporary:///myBackupDir/

What to do next

You can restore the backup to another appliance by using the secure-restore command.