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 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. We highly recommend that you use this feature to mitigate the potential loss of BIG-IP system configuration data. To create an archive, you can use the 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. For more information about creating and managing archives, see the remainder of this chapter.
| || |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. For details about using a single configuration file, see Chapter 3, Single Configuration Files (SCF)
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.
Each time you back up the configuration data, the BIG-IP system creates a
new file with a .ucs
UCS file contains various configuration files needed for the BIG-IP system to operate correctly, as well as the configuration data.
Using the Configuration utility, you can save and restore archives that are
stored on the BIG-IP system. Furthermore, for added security, you can save archives to and restore archives from a remote system, that is, the system on which you are running the Configuration utility.
By default, the system stores all archives in the directory /var/local/ucs
. You can specify a different location, but in this case, the 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
file to the system from which you are running the 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: Any UCS file that you create includes the host name of the BIG-IP system as
part of the data stored in that file. When you later specify this UCS file during the process of restoring configuration data to a BIG-IP system, the host name stored in this UCS file must match the host name of the system to which you are restoring the configuration data. Otherwise, the system does not fully restore the data.
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.