Configuration of CLI options

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/cli/global-settings/~resource id
Resource Methods


Name Type Default Value Required Access Description
audit string   optional read/write Specifies the global audit option of the CLI. The audited commands are stored in /var/log/audit.
description string   optional read/write User defined description.
idleTimeout string 0 optional read/write Set the idle timeout value for users in the tmsh command line interface. Time is set in number of minutes or disabled.
scfBackupNumber integer   optional read/write Use this option to configure the number of backup single configuration files that the system stores when you run load sys config file command in tmsh. Each time you issue the command, the system saves the single configuration file. For example, if you set the scf-backup-number option to 3, after you use the tmsh load sys config file command for the third time, you will see these three files on your system: /var/local/scf/backup.scf, /var/local/scf/backup-1.scf, and /var/local/scf/backup-2.scf. The newest file is /var/local/scf/backup.scf. By default, the system saves two backup single configuration files.
service string   optional read/write Specifies the format in which the CLI shell displays a service. The options are: [STRIKEOUT:name - The CLI shell displays a service using a host name, for example,] number - The CLI shell displays a service using a numeric value, for example,, where 80 indicates http. The default value is name.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.