F5 Logo MyF5
Search
  1. MyF5 Home
  2. Knowledge Centers
  3. BIG-IQ Device
  4. BIG-IQ Device: Device Management
  5. UCS File Backup and Restoration
Manual Chapter : UCS File Backup and Restoration

Applies To:

Show Versions Show Versions

BIG-IQ Device

  • 4.5.0
Manual Chapter
Table of Contents | << Previous Chapter | Next Chapter >>

About UCS files

The configuration details of managed devices (including the BIG-IQ® system itself) are contained in a compressed user configuration set (UCS) file. The UCS file contains all of the information required to restore a device's configuration, such as:

  • System-specific configuration files
  • License
  • User account and password information
  • SSL certificates and keys

You can back up devices at regularly scheduled intervals and select the amount of time to save the backups.

Creating a backup UCS file

It is best practice to create a backup of the UCS file for each device in your network (including the BIG-IQ® system itself, on a regular basis, and before performing a software upgrade. The UCS file backup provides your network with added stability in the event that a system needs to be restored. You can create backup UCS archives for managed devices on demand, or at scheduled intervals.
  1. Log in to BIG-IQ Device with your administrator user name and password.
  2. At the top of the screen, click Configuration.
  3. Hover over the Backups panel, click the + icon when it appears, and then click Add Backup.
  4. In the Description field, type a description to identify this UCS backup file.
  5. From the Device list, select the device or device group for which you want to create the UCS file backup.
  6. If you want to include the SSL private keys in the backup file, select the Include Private Keys check box.
  7. To encrypt the backup file, select the Encrypt Backup Files check box, and type the password in the Passphrase and Verify Passphrase fields.
  8. To retain scheduled backups, for the Archiving setting, select the preferred method.
    1. If you select Local, specify a valid BIG-IQ Device directory on which to save the file.
    2. If you select SCP or SFTP, specify the server's user name, IP address, valid directory to which to save the file, and the user's password.
  9. To delete archived backups, in the Delete backups field, specify the number of days to keep the backup before deleting it.
  10. To archive scheduled backups indefinitely, select the Never Delete check box.
  11. To immediately create a backup the UCS file for the selected device, for the Schedule Backup setting, select Backup Now.
  12. To schedule a backup of the UCS file at regular intervals, select Daily, Weekly, or Monthly for the Schedule Backup setting.
    1. If you selected Weekly, select the check box next to the day of the week you want BIG-IQ Device to create the backup.
    2. If you selected Monthly, specify the day of the month you want BIG-IQ Device to create the backup.
  13. For scheduled backups, place the cursor in the Start Date field, click the left mouse button, and click a day on the calendar on which you want to start this schedule. Alternatively, you can click the Today button located at the bottom of the calendar.
  14. In the associated field, type the time you want BIG-IQ Device to start this scheduled backup.
  15. To specify an end date for the scheduled backup, click the cursor in the End Date field, and then click a date on the calendar.
  16. To run scheduled backups indefinitely, select the No End Date check box.
  17. Click the Create button
  18. To view the status of a scheduled backup or change its description, click the gear icon.
This UCS backup file is now available for restoration.

Restoring a UCS file backup

You must create a backup of a device's UCS file before you can restore it.
In the event of a system failure or a requirement to roll back to a previous configuration, you can easily restore a backed up UCS file without having to recreate all of a device’s content.
  1. Log in to BIG-IQ Device with your administrator user name and password.
  2. At the top of the screen, click Provisioning.
  3. Hover on the Backups panel, click the gear icon next to the backup that you want to restore, and then click Properties.
  4. To change the target device, click the Change Device button and select a device from the Device list.
  5. Click the Restore button.
The BIG-IQ system restores the saved UCS backup file to the associated device.
Table of Contents | << Previous Chapter | Next Chapter >>
Contact Support Contact Support

Have a Question?

Support and Sales >

About F5

Education

F5 Sites

Support Tasks




©2023 F5 Networks, Inc. All rights reserved.


Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information