sys config
sys config(1) BIG-IP TMSH Manual sys config(1)
NAME
config - Manages the BIG-IP(r) system configuration.
MODULE
sys
SYNTAX
Save the running configuration or load the system configuration files within the sys module using the following syntax.
MODIFY
save config
options:
base
binary
current-partition
exclude-gtm
file
gtm-only
no-passphrase
one-line
passphrase
partitions
tar-file
time-stamp
user-only
wait
load config
options:
base
current-partition
default
exclude-gtm
file
files-folder
from-terminal
gtm-only
merge
replace
passphrase
partitions
tar-file
user-only
verify
delete config file [file name]
DISPLAY
list config file
DESCRIPTION
The system applies all configuration changes that you make from within tmsh to the running configuration. To save the
running configuration to the system configuration files, use the command sequence save config. Additionally, you can
replace the running configuration with the configuration in the system configuration files using the command sequence load
config.
If any of these options are not specified, save/load config will save or load the configuration in all partitions on this
system:
• binary
• default
• file
• from-terminal
• partitions
EXAMPLES
save config
Saves the running configuration in all partitions by overwriting the system configuration files.
In Virtual Editions with f5-swap-eth installed, saves the mapping of Ethernet device names and MAC addresses to /etc/ethmap
to make the working BIG-IP still work after adding/deleting virtual NIC(s). It also works for save config partitions all.
save config base
Saves the running base configuration in all partitions by overwriting the system base configuration files.
save config binary
Saves all running configuration by overwriting the system binary configuration database file.
save config current-partition
Saves the running configuration in current update partition by overwriting the system configuration files.
save config wait
Save request waits if another save operation is in progress.
save config file my_file tar-file my_tar_file no-passphrase
Saves all running configuration to the specified file, my_file, and all the user provided disk files referred to by the
configuration into my_tar_file. From v12.1.0 onwards the no-passphrase option should be explicitly specified for saving the
unencrypted SCF and SCF.tar.
save config file my_file passphrase my_password
Saves all running configuration to the specified file, my_file and encrypt it with my_password.
save config partitions { my_partition }
Saves the running configuration in my_partition by overwriting the system configuration files.
save config partitions all
Saves the running configuration in all partitions by overwriting the system configuration files.
save config user-only
Saves only user account configuration by overwriting the system configuration files.
load config
Replaces the running configuration in all partitions with the configuration in the system configuration files.
load config base
Replaces the running base configuration in all partitions with the configuration in the system base configuration files.
load config current-partition
Replaces the running configuration in current update partition with the configuration in the system configuration files.
load config merge file my_file
Loads the specified configuration from my_file, which modifies the running configuration.
load config replace file my_file
Loads the specified configuration from my_file, which modifies the running configuation, overwrites certain elements that
may be conflicting.
load config verify file my_file
Validates the specified configuration in my_file to see whether they are valid to replace the running configuration. The
running configuration will not be changed.
load config verify merge file my_file
Validates the specified configuration in my_file to see whether they are valid to be merged into the running configuration.
The running configuration will not be changed.
load config verify replace file my_file
Validates the specified configuration in my_file to see whether they are valid to be merged into the running configuration
with some elements replaced. The running configuration will not be changed.
load config default
Sets system configuration back to factory default settings.
load config file my_file tar-file my_tar_file
Replaces all running configurations with the configuration in the specified file, my_file and the disk files referred to by
the configuration are retrieved from my_tar_file.
load config file my_file files-folder my_files_folder
Replace all running configuration with the configuration in the specified file, my_file and the disk files referred to by
the configuration is taken from the directory tree under my_files_folder.
load config file my_file passphrase my_password
Replaces all running configuration with the configuration in the specified encrypted file, my_file and decrypt it with
my_password.
While searching for disk files under the specified folder, the order of search is first by file name as in cache-path, and
then by object-name. If more than one file is found for a name, then the relative path in the cache-path is used to make
the selection.
That is, while looking for
Looks for file(s) named B.
If none are found, looks for file(s) named "xxx"
When more than one file is found, looks for a copy that matches paths in the order:
B>
B>
load config partitions { x }
Replace the running configuration in partition x with the configuration in the system configuration files.
load config partitions all
Replace the running configuration in all partitions with the configuration in the system configuration files.
load config from-terminal
Replace the running configuration with what is entered from the terminal.
1. Type the initial command. 2. The system responds with a confirmation prompt, type Y to confirm.
Replace the running configuration? (y/n) y
3. Type in the replacement configuration entries.
net self-allow {
defaults {
igmp:any
ospf:any
pim:any
tcp:161
tcp:22
tcp:4353
tcp:443
tcp:53
udp:1026
udp:161
udp:4353
udp:520
udp:53
}
}
net stp-globals {
config-name 00-01-D7-B5-67-00
}
sys management-ip 172.27.41.70/24 { }
sys management-route default {
gateway 172.27.41.254
}
sys provision ltm {
level nominal
}
....
ltm pool pool1 {
slow-ramp-time 200
}
.....
^D
4. Use Ctrl+D to submit the changes or Ctrl+C to cancel the changes.
delete config file myfile
Delete myfile in default directory, /var/local/scf/.
list config file
Display files in default directory, /var/local/scf/.
OPTIONS
base Indicates the base configuration. This option cannot be specified with the binary, default, gtm-only, and user-only
options.
binary
Indicates binary configuration. This option may not be specified with any other options.
default
Indicates factory default configuration. This option cannot be specified with any other options.
file Loads or saves a configuration from the specified file. For save, a file with a relative path is saved in the default
directory, /var/local/scf. For load, in shell mode, the default directory, /var/local/scf, is used for a file with a
relative path. In bash mode, for a file with a relative path, the current directory is searched first. If the file
can't be found in the current directory, /var/local/scf is searched.
This option can be used with binary, default, from-terminal and partitions options.
passphrase
Specifies a password to save or load an encrypted configuration file. This option can only be used with option file.
tar-file
Loads or saves disk files referred to by the configuration from the specified tar file. A file with a relative path is
looked up, relative to the current directory.
files-folder
Loads disk files referred to by the configuration from the folder tree under the specified folder. Disk files by name
are searched for recursively. When there is more than one file with the same name, the relative path of the file from
the cache-path is used for selection.
from-terminal
Specifies that the configuration will be input from the terminal in the same format as the system configuration files
in . Use Ctrl+D to submit the changes and Ctrl+C to cancel the changes.
This option cannot be specified with default, file and partitions.
gtm-only
Indicates the Global Traffic Manage (GTM) configuration. This option cannot be specified with the base, exclude-gtm,
and user-only options.
exclude-gtm
Indicates the BIG-IP configuration, excluding GTMs. This is only valid with the file option. This option cannot be
specified with the base, gtm-only, and user-only options.
merge
Loads the configuration from the specified file or from the terminal, which modifies the running configuration. If
merging from the terminal, it requires Ctrl+D to complete the operation. This option is only valid with the file or
from-terminal options.
partitions
Indicates the partitions in which configuration components reside. This option cannot be specified with the default,
file, from-terminal, or merge options.
user-only
Indicates the configuration including user account information only. This option cannot be specified with the base,
default, exclude-gtm, or gtm-only options.
time-stamp
Inserts a time-stamp in a file name. This is only valid with the file option.
verify
Validates the specified configuration from file(s) or from the terminal without changing the running configuration.
wait Specifies that tmsh should wait for another instance of tmsh to finish saving the configuration before proceeding. If
wait is not specified and another instance of tmsh is in the process of saving the configuration, the command exits
tmsh immediately (because the other instance of tmsh is already saving the configuration).
SEE ALSO
load, save, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2013, 2015-2016. All rights reserved.
BIG-IP 2019-01-14 sys config(1)