Applies To:

Show Versions Show Versions

Manual Chapter: Archives
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>


About archives

On any BIG-IP® system, you have a set of data that you created when you initially configured the system, using the Setup utility and the BIG-IP Configuration utility or tmsh. This data consists of traffic management elements such as virtual servers, pools, and profiles. Configuration data also consists of system and network definitions such as interface properties, self IP addresses, VLANs, and more.

Once you have created the configuration data for the BIG-IP system, you can replicate all of this set of data in a separate file. You can then use this replicated data later, for these reasons:

As an archive for disaster recovery
Using the Archives feature, you can back up the current configuration data, and if necessary, restore the data at a later time. F5 Networks® recommends that you use this feature to mitigate the potential loss of BIG-IP system configuration data. To create an archive, you can use the BIG-IP Configuration utility, which stores the configuration data in a special file known as a user configuration set, or UCS file. You can then use the UCS file to recover from any loss of data, in the unlikely event that you need to do so.
As a way to propagate data to other systems
Using the single configuration file feature, you can easily and quickly propagate the exact configuration of the BIG-IP system to other BIG-IP systems. To create a single configuration file, you export the configuration data to a special file known as an .scf file. You can then use the .scf file to configure another system in one simple operation.

Before you replace a version of the BIG-IP system with a newer version, you should always create an archive, which is a backup copy of the configuration data. This archive is in the form of a user configuration set, or UCS. Then, if you need to recover that data later, you can restore the data from the archive that you created.

A UCS contains the following types of BIG-IP system configuration data:

  • System-specific configuration files
  • Product licenses
  • User accounts and password information
  • Domain Name Service (DNS) zone files
  • Installed SSL keys and certificates

Each time you back up the configuration data, the BIG-IP system creates a new file with a .ucs extension. Each UCS file contains various configuration files needed for the BIG-IP system to operate correctly, as well as the configuration data.

Important: To create, delete, upload, or download an archive, you must have either the Administrator or Resource Administrator role assigned to your user account.

About saving archives

By default, the system stores all archives in the directory /var/local/ucs. You can specify a different location, but in this case, the BIG-IP Configuration utility does not display the UCS files when you view the list of archives

After you create an archive on the BIG-IP® system, you can download a copy of the UCS file to the system from which you are running the BIG-IP Configuration utility (a secure remote system). This provides an extra level of protection by preserving the configuration data on a remote system. In the unlikely event that you need to restore the data, and a BIG-IP system event prevents you from accessing the archive in the BIG-IP system directory in which you saved the archive, you still have a backup copy of the data.

Important: If your configuration data includes SSL keys and certificates, be sure to store the archive file in a secure environment.

About archive restoration

Not only is the /var/local/ucs directory the only location on the BIG-IP® system in which you can save an archive, but it is also the only location on the BIG-IP system from which you can restore an archive. However, if you previously downloaded an archive to a remote system, and a BIG-IP system event prevents you from accessing the /var/local/ucs directory, you can upload the archive from that remote system.

Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Was this resource helpful in solving your issue?

NOTE: Please do not provide personal information.

Additional Comments (optional)