cli preference¶

cli preference(1) BIG-IP TMSH Manual cli preference(1)

NAME
preference - Configures tmsh preferences.

MODULE
cli

SYNTAX
Configure the preference component within the cli module using the syntax shown in the following sections.

MODIFY
edit preference
modify preference [option]
options:
alias-path [string list]
app-service [[string] | none]
confirm-edit [disabled | enabled]
display-threshold [integer]
editor [nano | vi]
history-date-time [disabled | enabled]
history-file-size [integer]
history-size [integer]
keymap [default | emacs | vi]
list-all-properties [disabled | enabled]
pager [disabled | enabled]
prompt { [avc-count config-sync-status current-folder
fully-qualified-host host mcp-load-status
mcp-state multi-line status user user-role] | none }
show-aliases [disabled | enabled]
stat-units [default | exa | gig | kil | meg | peta | raw |
tera | yotta | zetta]
suppress-warnings [ all | config-version | none ]
table-indent-width [integer]
tcl-syntax-highlighting [disabled | enabled]
video [disabled | enabled]
warn [bell | disabled | visual-bell]

edit preference
options:
all-properties

DISPLAY
list preference
list preference [option]
show running-config preference
show running-config preference [option]
options:
all-properties
one-line

DESCRIPTION
You can use the preference component to configure tmsh to meet your specific needs.

EXAMPLES
modify preference display-threshold 500

Configures tmsh to retrieve up to 500 objects before requiring a user response to the question, "Display all
items? (y/n)."

modify preference history-file-size 80

Configures the maximum number of commands that a user can view in the command history list to be 80.

modify preference history-size 1000

Configures the maximum number of commands that tmsh saves in a user's .tmsh_history file to be 1000 commands.

modify preference suppress-warnings config-version

Configures tmsh to suppress warning messages for configuration version related (for backward compatibility of
configuration).

OPTIONS
alias-path
Specifies the search paths for shared aliases. The shared aliases could be in multiple locations, only
ones on the search paths can be used. If a folder is deleted from the system it will be automatically
remove from the alias-path.

app-service
Specifies the name of the application service to which the preference belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the preference. Only the application service can modify or delete the preference.

confirm-edit
Specifies whether the command edit prompts for confirmation before saving changes. The default value is
enabled.

Note that the value of this option does not affect the behavior of the editor if the changes made in the
editor result in a failed update. In this case, tmsh always prompts the user to either re-edit the file
or discard the changes. The options are:

enabled
tmsh prompts a user to either submit (y), discard (n), or edit (e) the changes made to a component
within the editor.

disabled
tmsh does not prompt the user, but instead, immediately submits the changes made in the editor.

display-threshold
Specifies the maximum number of objects that tmsh displays without requiring a user response to the
question, "Display all [number] items? (y/n)." You can specify from 0 (zero) through 4,294,967,265
objects. If you set this option to 0 (zero), tmsh displays an unlimited number of objects without
requesting a response.

editor
Specifies the editor that the command edit invokes. Users assigned the user role of Administrator can
select nano or vi. Users assigned other user roles must use nano.

history-date-time
Specifies whether tmsh displays in the command history the date and time that each command was issued.
The default value is disabled.

Note that the command history file, ~/.tmsh-history-[user], always contains the date and time that a
command was issued.

history-file-size
Specifies the maximum number of tmsh commands that the system saves in each user's .tmsh_history file. If
you set this option to 0 (zero), the system does not save tmsh commands in the file. The maximum value is
100,000. For performance reasons, the system does not truncate the file after a user enters a command.
Instead, the system truncates the file after a user exits tmsh.

history-size
Specifies the number of commands that a user can view or search in the command history list. The maximum
number of commands is 100,000. The default value is 500.

If you set this option to 0 (zero), the system does not add commands to the list of commands in memory;
however, the system does write commands to the .tmsh_history file, unless the history-file-size option is
set to 0 (zero).

When you change the value of this option, the system renumbers the commands listed in memory; however,
the commands remain in the same order.

keymap
Specifies the keyboard bindings that you want tmsh to use. The default value is default. The options are
default, emacs, and vi.

list-all-properties
Specifies whether the system displays all of the properties of a component by default when you run the
command list. The default value is disabled.

pager
Specifies whether the system sends the output of the tmsh commands list and show to less. The default
value is enabled.

prompt
Specifies the information that you want to display in the tmsh prompt. By default the prompt displays
user_name@host_name(tmos-current_module)#. The options are:

avc-count
Displays the current SELinux Access Vector Cache in the tmsh prompt. The value displayed in the
prompt indicates the number of times SELinux has denied access to a protected resource. The default
is to not display this information.

config-sync-status
Displays global sync status in the tmsh prompt. The status displayed in the prompt indicates the
rolled-up sync status of all the device groups where the local device resides. The default is to
display this information.

current-folder
Displays the current working folder in the tmsh prompt. The default is to not display this
information.

fully-qualified-host
Displays the fully qualified host name in the tmsh prompt. The default is to not display this
information.

host Displays the host name in the tmsh prompt. The default is to display the host name in the prompt.

mcp-load-status
Displays the configuration file load status in the tmsh prompt. This information is also available
in the Last Configuration Load Status of the show sys mcp command output. The default is to not
display this information.

mcp-state
Displays the running phase of the mcpd service in the tmsh prompt. This information is also
available in the Running Phase of the show sys mcp command output. The default is to not display
this information.

multi-line
Displays the tmsh prompt on multiple lines, with information on the first line, and a pound sign (#)
on the second line, for example:

(Common:all) operator1@6400(tmos.cli)

The multi-line option is disabled by default.

none Sets the tmsh prompt to display (tmos.current_module)#, where the system replaces current_module
with the name of the module within which you are working.

status
Displays the system status in the tmsh prompt. The default is to display system status in the
prompt.

user Displays the user name in the tmsh prompt. The default value is to display the user name in the
prompt.

user-role
Display the user's current role in the tmsh prompt. By default the user role is not displayed in the
prompt.

show-aliases
Specifies whether the system displays aliases in the results of the command completion and context-
sensitive help features. The default value is enabled.

suppress-warnings
Specifies the type of warning messages which needs to be suppressed. The default value is none.

stat-units
Specifies the default unit in which the system displays statistics. The options are:

default
Displays data in the simplest units. For example, if the value of the data is 1,200,001, the system
displays 1.20M; however, if the value of the data is 1,200, the system displays 1.2K.

exa Display data in parts per quintillion.

gig Displays data in parts per billion.

kil Displays data in parts per thousand.

meg Displays data in parts per million.

peta Displays data in parts per quadrillion.

raw Displays raw data.

tera Displays data in parts per trillion.

yotta
Displays data in parts per septillion.

zetta
Displays data in parts per sextillion.

table-indent-width
Specifies the indent width when tmsh displays the child object tables in a show command. You can specify
from 0 (zero) through 10. If you set this option to 0 (zero), tmsh displays child object tables without
any indent.

tcl-syntax-highlighting
Specifies whether Tcl syntax highlighting will be enabled in the editor. This setting only applies if
your editor preference is set to vi. The default value is disabled.

video
Enables or disables any video features used to highlight text. The default value is enabled.

warn Specifies how the system warns you when you make an incorrect keystroke. The default value is bell.

The options are:

bell Sounds a bell.

disabled
Disables the warning function.

visual-bell
Displays a visual warning.

SEE ALSO
edit, list, modify, show, sys mcp-state, 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.

BIG-IP 2016-03-14 cli preference(1)