Some features described in this article are available starting with meshIQ Manage version 12.1 and greater.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown. 

Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier

Version 12.x and Later

The Messages Backup feature in a Solace Cache Instance allows you to export cached messages to a backup file. This is useful for preserving cached data before maintenance, troubleshooting, or performing restore operations later. You can also cancel an ongoing backup using the Cancel Messages Backup option.
To learn how to restore cached messages, see Restore Cached Messages in a Cache Instance.

A cache instance must be fully shut down before performing a backup.

Backup Cached Messages

To back up cached messages from a cache instance:

1. In the Cache Instance widget, select the cache instance you want to back up.

2. From the Selected menu, choose Commands > Messages Backup.
   

3. The Backup Object Messages dialog opens.
   

4. The cache instance name appears in the File Name field. Verify the instance name and click Confirm to proceed.

5. A Confirm Messages Backup Action dialog opens. Click Yes to start the backup immediately, or Schedule to run it at a later time. (See Scheduling Jobs for more information.) 
   

The backup will start once the action is confirmed.

If the cache instance is not shut down, an error dialog appears indicating that the instance must be shut down before the backup can proceed. Shut down the instance, then retry the backup operation.

Cancel Messages Backup

To cancel an ongoing backup:

1. In the Cache Instance widget, select the cache instance that is currently performing the backup.

2. From the Selected menu, choose Commands > Cancel Messages Backup.
   

3. A Confirm Cancel Message Backup Action dialog opens, showing the selected cache instance details.
   
    

4. Click Yes to cancel immediately or Schedule to cancel at a later time. (See Scheduling Jobs for more information.) 

The backup operation is canceled once confirmed.

Version 11.3 and Earlier

The Messages Backup feature in a Solace Cache Instance allows you to export cached messages to a backup file. This is useful for preserving cached data before maintenance, troubleshooting, or performing restore operations later. You can also cancel an ongoing backup using the Cancel Messages Backup option.
To learn how to restore cached messages, see Restore Cached Messages in a Cache Instance.

A cache instance must be fully shut down before performing a backup.

Backup Cached Messages

To back up cached messages from a cache instance:

1. In the Cache Instance viewlet, select the cache instance you want to back up.

2. From the Selected menu, choose Commands > Messages Backup.
   

3. The Backup Object Messages dialog opens.
   

4. The cache instance name appears in the File Name field. Verify the instance name and click Confirm to proceed.

5. A Confirm Messages Backup Action dialog opens. Click Yes to start the backup immediately, or Schedule to run it at a later time. (See Scheduling Jobs for more information.) 
   

The backup will start once the action is confirmed.

If the cache instance is not shut down, an error dialog appears indicating that the instance must be shut down before the backup can proceed. Shut down the instance, then retry the backup operation.

Cancel Messages Backup

To cancel an ongoing backup:

1. In the Cache Instance viewlet, select the cache instance that is currently performing the backup.

2. From the Selected menu, choose Commands > Cancel Messages Backup.
   

3. A Confirm Cancel Message Backup Action dialog opens, showing the selected cache instance details.
   
    

4. Click Yes to cancel immediately or Schedule to cancel at a later time. (See Scheduling Jobs for more information.) 

The backup operation is canceled once confirmed.