Applies To:

Show Versions Show Versions

Manual Chapter: Single Configuration Files SCF
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

A single configuration file (SCF) is a flat, text file that contains a series of tmsh commands, and the attributes and values of those commands, that reflect the configuration of the BIG-IP system. Specifically, the SCF contains the LTM® and TMOS® configurations of the BIG-IP system. Figure 3.1 shows a small part of a sample SCF.
The single configuration file feature allows you to save the configuration of a BIG-IP® system in a text file. You can then use the text file to easily replicate the configuration across multiple BIG-IP systems. This not only saves you time, but also allows you to create a consistent, secure, comprehensive local traffic management environment on your network.
You use the tmsh utility to perform the basic management of a single configuration file (SCF). Table 3.1 contains an overview of the commands to accomplish this. For information about the additional parameters for each command, see the Traffic Management Shell (tmsh) Reference Guide.
Table 3.1 Overview of the tmsh commands used to manage an SCF
save /sys config file [filename] tar-file [filename]
It is important to note that saving a configuration to an SCF does not affect the running configuration or the stored configuration of the BIG-IP system upon which you run the command.
load sys config file [filename] tar-file [filename]
Use this command to restore the factory default settings of the configuration file, while retaining the management IP address and the administrator user name and password.
When you use the tmsh command save /sys config file [filename] tar-file [filename] to create an SCF, the command prompts the tmsh utility to gather all of the commands (and their attributes and values) that compose the running configuration. Once gathered, the system saves the configuration to a flat file with the name you specify and the extension of .scf. By default, the system stores this file in the /var/local/scf directory, but you can specify a different path if you prefer.
Note that when you use the save command to create an SCF, you include the name of a tar file as well.
For example, the following command saves the running configuration to the specified file, my_config.scf, and saves all user-provided disk files referred to by the configuration into my_config.tar:
Note: A tar file contains objects such as trusted device certificates, device certificates, device keys, CRLs, external data group files, external monitor program files, iFiles, and so on.
Note: If you include the .scf extension in the file name, the system does not add additional extension.
The primary benefit of the SCF feature is that it gives you the ability to create a configuration on one BIG-IP system that you can load onto other BIG-IP systems (hereafter referred to as the target BIG-IP system), rather than having to recreate the configuration multiple times.
After you have created and saved the SCF using the save sys config file [filename] command, you can modify any data unique to the specific target BIG-IP system, then load the configuration on that system.
Important: To successfully load a configuration you have replicated, no line of the configuration can be longer than 4096 characters. If there are more than 4096 characters in a single line, the system reverts to the previous running configuration.
The BIG-IP system ships with a default SCF. Depending on whether you want to restore the factory default configuration or load a specific configuration, use one of the following commands.
tmsh load /sys config default
This command restores a system to the factory default configuration, while retaining the management IP and the assigned root and administrator passwords. When you use this command, the system first saves the running configuration in the backup.scf file and then resets the local traffic management and the operating system configuration to the factory default settings by loading the SCF, /defaults/defaults.scf.
tmsh load /sys config file [filename] tar-file [filename]
This command restores the configuration of a system with values defined in the specified SCF and tar files. When you use this command, the system first saves the running configuration in the backup.scf file, and then resets the running configuration to the values contained in the specified SCF and tar files.
For example, the following command replaces the running configuration with the configuration stored in the file my_config.scf and retrieves the disk files referred to in the configuration from the file my_config.tar:
You must run the command save /sys config partitions all to save the running configuration in the stored configuration files.
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)