Creating Local Backups of Configuration Files

Manually creating a local backup of a configuration file saves the latest configuration file pertaining to your user account in /configs/backup.

Do not use this procedure for event broker services in PubSub+ Cloud. Using this procedure in PubSub+ Cloud may result in a degradation of service. Instead, see Backing up Event Broker Services for more information.

For software event brokers and appliances, Solace recommends that you always create a local backup of your configuration file after the event broker configuration is changed to ensure the most recent backup file available is always current.

To create a local backup of your configuration file, follow this procedure:

1. Enter the following commands:

   solace> enable
   solace# backup

   CLI show commands may fail if run while a local backup is being created.

2. To confirm your local backup was created successfully, enter the following command:

   solace# show backup

   An example response is:

   Schedule            : Never
   Max Backups         : N/A
   Previous Autobackup : N/A
   Previous Backup     : Fri Jun 08 10:07:18 EDT
   Backup Status       : Unchanged since previous backup

Scheduling Local Backups of Configuration Files

You can schedule a local backup of configuration files on an event broker and automate the backup to occur regularly at a preset date, time and location. No manual interfacing is necessary to initiate the backup.

When to Schedule Local Backups

It is best to schedule backups at a time when people are not normally using the system. Often, system administrators choose to perform backups at the close of the workday or later in the evening. It is also a good idea to schedule the backup for the same time every day so users know when to expect it and can plan ahead.

Backup can be scheduled daily or weekly. The frequency of changes to information is a good indicator of how often you need to back up data. If the frequency of data revisions is high, then a backup should be scheduled daily so that potential loss of data is minimal.

By default, no configuration file backups are scheduled on event brokers.

Scheduling Local Backups

To schedule automatic local backups of configuration files on the event broker, follow this procedure:

1. Enter the following Solace CLI commands:

   solace> enable
   solace# configure
   solace(configure)# schedule backup [days <days-of-week>] times <times-of-day> [max-backups <max-backups>]

   Where:

   <days-of-week> is either the entry “daily”, or a list of named days from Sunday to Saturday separated by commas with no spaces, or a list of numbers from 0 to 6 representing the named days separated by commas with no spaces, where 0 is Sunday, 1 is Monday, on through to 6 for Saturday. Default is “daily”.

   <times-of-day> is either the entry “hourly”, or a list of up to four times of day in the format hh:mm separated by commas without spaces, where hh is 0 to 23 representing hours, and mm is 0 to 59 representing minutes.

   <max-backups> is the maximum number of scheduled backups to keep from 1 to 25. When a new scheduled backup causes the number of backups to exceed the set maximum, the oldest backup file is deleted. The default value is 5 backups if this parameter is not provided.

   The no version of this command deletes all automatic file backup schedules and returns the event broker to its default (that is, no scheduled backups).

   For example, to schedule an automatic local backup weekly for every Tuesday and Friday at 3:15 am and 8:10 pm, and then backup your configuration changes, enter:

   solace(configure)# schedule backup days 2,friday times 3:15,20:10
   solace(configure)# end
   solace#

2. To confirm your scheduled local backup was assigned successfully, enter the following User EXEC command.

   solace# show backup

   An example response is:

   Schedule            : Tue,Fri 3:15,20:10
   Max Backups         : 5
   Previous Autobackup : N/A
   Previous Backup     : Fri Mar 13 13:06:40 EST
   Backup Status       : Changed since previous backup

3. Optional: To confirm your scheduled local backup was created at the assigned time, enter the following command:

   solace# dir configs

   An example response is:

   -rw-rw-rw-     root     root 25749320 Mar 24 03:15 autobackup
   -rw-rw-rw-     root     root 25749348 Mar 24 20:10 autobackup.1
   -rw-rw-rw-     root     root 25749348 Mar 31 03:15 autobackup.2
   -rw-rw-rw-     root     root 25749348 Mar 31 20:10 autobackup.3