Applies To:

Show Versions Show Versions

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

Overview: Working with single configuration files

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 local traffic management and TMOS configuration of the BIG-IP system. This figure shows a small part of a sample SCF.

vlan external { tag 4093 interfaces 1.3 } vlan internal { tag 4094 interfaces 1.10 } pool dev_https3 { members { 10.60.10.105:https{} 10.60.10.106:https{} } }

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.

tmsh commands for single configuration files

You use the tmsh utility to perform the basic management of a single configuration file (SCF). This table contains an overview of the commands to accomplish this.

tmsh command Usage
save sys config file [filename] Use this command to save a copy of the currently running configuration to an SCF. It is important to note that saving a configuration to an SCF does not affect the running or stored configuration of the BIG-IP system on which you run the command.
load sys config file [filename] Use this command to replace or restore an SCF with a saved configuration. When you use this command, the system saves any previously running configuration to the directory /var/local/scf/, by default.
load sys config default 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.

Task summary

You can perform three main tasks with respect to single configuration files.

Task list

Creating and saving an SCF

Use this procedure to create and save a single configuration file.
  1. Access the tmsh utility.
  2. Use the following syntax: save sys config file [filename] If you include the .scf extension in the file name, the system does not add an additional file extension. If you create an SCF file twice (on two different occasions), you can compare the contents of the two files.
This procedure causes 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.

Loading an SCF onto a target BIG-IP system

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.

Note: To successfully load a configuration you have replicated, ensure that no line of the configuration is longer than 4096 characters. If there are more than 4096 characters in a single line, the system reverts to the previous running configuration.
  1. On the target BIG-IP system, load the saved SCF file by typing the following command: tmsh load sys config file [filename] The tmsh utility first saves the system’s stored configuration in a backup file (named /var/local/scf/backup.scf), and then uses the configuration stored in the SCF that you are loading.
  2. Use a text editor to open the SCF and edit any data that is unique to the target BIG-IP system, such as the management IP address.
  3. Save the SCF to the target BIG-IP system by typing the following command: sys save config file [filename] If a backup SCF already exists, the tmsh utility appends a number to the name of the existing backup file, and then creates a new backup file. Thus:
    • The first time the system backs up the running configuration during a load operation, the system names the backup file /var/local/scf/backup.scf.
    • The next time the system backs up the running configuration, the system renames the file from /var/local/scf/backup.scf to /var/local/scf/backup-1.scf and creates a new file named /var/local/scf/backup.scf.
    • If you run the load command a third time, the system renames the file from /var/local/scf/backup-1.scf to /var/local/scf/backup-2.scf, renames the file /var/local/scf/backup.scf to /var/local/scf/backup-1.scf, and once again creates a new file named /var/local/scf/backup.scf.

Using an SCF to restore a BIG-IP system configuration

You can use an SCF to restore a BIG-IP system 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, perform this step.
  1. From a console window, access the tmsh prompt.
  2. Choose one of these options.
    Option Description
    Restore a system to the factory default configuration Type the command tmsh load sys config default. This command retains 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.
    Restore a system with values defined in the specified SCF Type the command tmsh load sys config file [filename]. 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. You must run the save sys config partitions all command 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.



Incorrect answer. Please try again: Please enter the words to the right: Please enter the numbers you hear:

Additional Comments (optional)