Sign In with your
Trend Micro Account
Need Help?
Need More Help?

Create a technical support case if you need further support.

How do I backup or restore the SMS database?

    • Updated:
    • 24 Aug 2017
    • Product/Version:
    • TippingPoint SMS All
    • TippingPoint Virtual SMS
    • Platform:
Summary
The SMS server maintains important data in both its database and in configuration files. The database holds data about the current and historical operations of the SMS server as well as the devices it manages. The configuration files contain data such as SMTP server information, NAT configuration information, and user information. This data is critical to the operation of the SMS Server and should be backed up periodically to facilitate recovery from an unexpected failure.
Details
Public

Backup

The backup process backs up both the database and the configuration files. By default, event-related and statistics-related database tables are not backed up due to their size, but you can choose to include them and some other optional configuration files. The process of backing up the SMS database is resource intensive, particularly if the server is under heavy load and the database is large. Take this into consideration when scheduling a regular backup or initiating an immediate backup.

 

Restore

When restoring an SMS Server database, SMS validates the integrity of the file from which backed up data is being restored. If the file is invalid, the SMS console displays an error message. To ensure database integrity, the system automatically reboots after the restore operation. SMS supports restoring a backup taken with a previous version of SMS. For example, you can restore a backup taken with SMS v4.3 and restore it to an SMS v4.5 server. When you restore a previous-version backup, SMS not only restores the database but properly migrates the data and data structures to match the version of SMS currently running on your SMS server.

 

Note: If you restore a backup to an SMS server upon which SMS patches are installed, you may need to rollback and reapply the patch after you restore the backup. The restoration process will indicate in a dialog box if you need to perform this task.

 

The backup and restore processes need access to storage, to either back up data to the storage or restore data from the storage. The SMS backup and restore processes can perform their tasks using any of the following storage access protocols:

  • Network File System (NFS) Protocol
  • Server Message Block (SMB) Protocol, a Microsoft-based shared-access file system.
  • Secure File Transfer Protocol (sFTP)
  • Secure Copy Protocol (SCP)
  • Hypertext Transfer Protocol (HTTP) and Secure Hypertext Transfer Protocol (HTTPS)

 

Backup and restore processes break down into the following tasks, each performed by the SMS server:

  • Mount the storage destination, referred to in the SMS product as the location.
  • Stop the SMS server database and SMS server application.
  • Backup or restore the database files to/from the specified storage location.
  • Un-mount the storage destination.
  • Restart the SMS server database and SMS Server application. If it is a restore operation the SMS server is not just restarted, it is rebooted, which terminates client connections to the SMS server.

 

Some of the supported storage access protocols allow IPv6 addressing. When you specify a backup location in the SMS backup wizard with an IPv6 address, adhere to the following syntax requirements:

  • NFS - Does NOT support IPv6
  • SMB - IPv6 address MUST be surrounded by brackets
  • SCP - IPv6 address with or without brackets
  • sFTP - IPv6 address with or without brackets

 

How To: Common Task

  1. Log in to the SMS from a client.
  2. On the SMS toolbar, navigate to the Admin->Database tab.

 

How To: Backup the SMS Database

  1. If you want to schedule a one-time or recurring backup, click New in the Scheduled Backups area. If you want to initiate an immediate backup, click Backup Now in theBackup and Restore area. The SMS Backup Wizard launches.
  2. If you are initiating an immediate backup skip this step and proceed to the next one. If you are scheduling a one-time or recurring backup, enter into the first page of the SMS Backup Wizard schedule information, including the recurrence pattern of the scheduled backup as well as the date range of the backup schedule itself.
  3. Configure the backup options, referring to the following table for descriptions:
  
Database Backup Options
SettingDescription
Number of Digital VaccinesIn addition to backing up the SMS Server database, you can specify up to six of the most recent Digital Vaccines (DV) to include in the backup. You are required to back up the most recent DV.
Number of Device TOS packagesYou can optionally specify up to six of the most recent Device TOS packages to be included in the backup.
Number of custom packagesIf you have custom packages installed, you can specify up to six of the most recent custom packages to be included in the backup. The backup always includes the latest, active package. It does not automatically back up more than one package and does not automatically back up inactive packages. For example, your installation might include a custom script writer (CSW) package.
Include eventsCheck this box if you want to include in the backup the contents of the database's events table.
Email backup resultsCheck this box if you want to email the backup results to the members of the SMS notification list, which is defined in the SMTP Server area on the Admin - Server Properties - Network tab.
Timestamp suffix on backup file nameCheck this box if you want SMS to append the current timestamp to the end of the backup filename.
Encrypt backupIf you want to encrypt the contents of the backed up data, check this box and enter an encryption password. Be sure to note the password as it is not recoverable. You cannot restore the contents of an encrypted backup without this password.
  1. Click Next.
  2. Select the storage access protocol you want the backup process to use. Depending on the selected protocol you are asked to identify one or more of the following:
  • The network path to the storage location, including the hostname, directory structure, and backup file name.

Note: If HTTP/HTTPS is the chosen storage access protocol, the backup file is placed on the SMS server. Best practices imply that you move the file to other storage media. To do so you connect to the SMS server over a web browser, locate the file using the location generated by the SMS server, and copy it.

  • The username and password with sufficient access to write to the identified storage location. If NFS is the chosen storage access protocol, ensure the NFS share grants the SMS Server write permissions for the anonymous user.
  • The domain in which the storage location resides.
  1. Verify your backup configuration and then click Finish. The backup procedure begins by validating access to the specified storage location and then proceeds to back up the data. Backup time varies according to the amount of data, performance of the server, and the performance of the chosen storage location/device.

 

How To: Restore the SMS Database

  1. Before initiating a restore, ensure there are no active client connections to the SMS Server, including from the SMS client, from the SMS CLI, or from a web browser.
  2. From the Backup and Restore area, click Restore. The SMS Restore Wizard displays.
  3. Click Next.
  4. Browse to and select the backup file you want to restore. The selected file can be of a backup taken with a version of SMS that matches, or is older than, the version of SMS to which the file is being restored.
  5. Click Import. The SMS Restore Wizard verifies the integrity of the chosen file and proceeds if the file is valid. If the file is invalid, the SMS displays an error message.
  6. A summary page is displayed. If all of the summary information is correct, click Finish. Database restoration begins, with the restored data overwriting the existing data. Once complete, the SMS Server reboots to finalize the restore process and ensure data integrity of the restored database.
Premium
Internal
Rating:
Category:
Configure; Troubleshoot; Deploy
Solution Id:
TP000086726
Feedback
Did this article help you?

Thank you for your feedback!

To help us improve the quality of this article, please leave your email here so we can clarify further your feedback, if neccessary:
We will not send you spam or share your email address.

*This form is automated system. General questions, technical, sales, and product-related issues submitted through this form will not be answered.

If you need additional help, you may try to contact the support team. Contact Support


To help us improve the quality of this article, please leave your email here so we can clarify further your feedback, if neccessary:
We will not send you spam or share your email address.

*This form is automated system. General questions, technical, sales, and product-related issues submitted through this form will not be answered.