Manual Chapter : Terminal Control

Applies To:

Show Versions Show Versions

ARX

  • 6.3.0
Manual Chapter
Use the save profile command to save the current terminal settings for future login sessions.
Use the show terminal command to view the current terminal settings. To remove the profile, run delete configs admin-profile.scr.
Since an administrator with a role of operator does not have privileges to access priv-exec mode, exec mode also supports this command. The command operates identically in both modes.
bstnA# save profile
Use the show history command to see the list of CLI commands from the current CLI session.
bstnA> show history
Use the show terminal command to see the terminal settings for the current CLI session.
If Terminal Idle Timeout is enabled, the system logs you out of the CLI after the idle time shown in the Terminal Idle Timeout Value field. Use terminal timeout to set the idle-timeout time.
Terminal Expand Prompt shows the current object name in the CLI prompt. For example, if you are configuring a namespace volume, the volume name appears in the CLI prompt. Use [no] terminal expand-prompt to disable/enable the expanded prompt.
Terminal Confirmation, if enabled, causes the CLI to prompt for confirmation at sensitive configuration commands. If disabled, the CLI performs all commands without prompting for confirmation. Use [no] terminal confirmation to disable/enable Terminal Confirmation.
Expert Mode, if enabled, stops the CLI from prompting for confirmation when a user creates a new global-configuration object. If disabled, the CLI prompts for confirmation for every new policy, namespace, or global-server object. Use [no] terminal expert to disable/enable Expert Mode.
Terminal Length is the number of lines for each page of the CLIs more output. (By default, the CLI pipes all of its output through more.) Use terminal length to reset the number of lines; use terminal length 0 to disable the more feature.
Terminal Width is the maximum number of characters in each line of CLI output. Use terminal width to reset this maximum.
Logfile Directory only appears if terminal logging is enabled. This shows the directory where the current CLI-log file is being written; currently, this is always reports.
Terminal Logfile is enabled if the CLI is recording its output to a report file. Use terminal logging to enable CLI logging.
Terminal History is the number of CLI commands kept in a history buffer. Use terminal history to set this number. To access the commands, use show history or <up-arrow>.
Script History Logging indicates whether the CLI keeps terminal history for commands in CLI scripts, too. This is enabled or disabled with the script flag in the terminal history command.
Terminal Character Set is either ISO 8859-1 or Unicode/UTF-8. If the latter, the terminal supports multi-byte characters (for Japanese, Chinese, and other languages with multi-byte characters). Use terminal character-set to change this.
Stop Scripts on error is disabled if CLI scripts continue on error. Use terminal stop-on-error to stop CLI scripts that encounter an error.
If terminal beta is enabled, you can preview and test the CLI beta test commands available in later versions of F5 software. Contact your F5 representative for more information on these commands. Use [no] terminal beta to disable/enable previewing the beta test commands.
bstnA> show terminal
Use the terminal beta command to unlock CLI beta test commands.
Use the no form of the command to lock these commands.
The terminal beta command provides access to the CLI beta test commands to be released in later versions of F5 software. Use terminal beta to unlock these commands for previewing and testing purposes only. Contact your F5 representative for more information on the availability of these commands.
Entering terminal beta causes the beta test commands to appear in Help.
Use show terminal to find the current setting (locked or unlocked) for the beta test commands.
bstnA> terminal beta
bstnA> no terminal beta
The iso-8859-1 setting is for single-byte-character languages like English. The other setting, unicode-utf-8, supports all languages including those with characters larger than one byte.
bstnA> terminal character-set unicode-utf-8
bstnA> no terminal character-set
bstnA> terminal clear
Use the affirmative form, terminal confirmation, to make the CLI start prompting for confirmations again.
Use show terminal to find the current setting for terminal confirmation.
bstnA(cfg)# no terminal confirmation
bstnA(cfg)# terminal confirmation
Use the terminal expand-prompt command to display the fully expanded CLI command prompt.
bstnA(gbl-ns[[nfsNamespace1])#no terminal expand-prompt
bstnA(gbl-ns[nfsNamespace1])# terminal expand-prompt
The CLI keeps a configurable number of CLI commands in a list, so that you can display the list with the show history command. Use the terminal history command to set the number of CLI commands to keep.
Use the no form of this command stop saving any CLI history.
number (0-255) is the number of CLI commands to keep in the terminal-history list.
script (optional) enables logging for CLI scripts. If the run command invokes a script, the CLI keeps terminal history for the commands in the script, too.
Use show history to view the terminal history. You can also use the up-arrow key to view the history one command at a time.
bstnA(cfg)# terminal history 100
bstnA(cfg)# terminal history script
bstnA(cfg)# no terminal history
By default, the CLI pipes all of its output through the more paging program. Each page of more output has a configurable number of lines; use the terminal length command to set the number of lines in each CLI page.
Use no terminal length to return to the default length and enable the more feature.
number (0-255) is the number of lines in each page of CLI output. 0 (zero) means infinite; this effectively disables the CLI more feature.
24 (and see the Guidelines below)
Use terminal length 0 to disable the more feature. The no terminal length command enables the more feature and returns the length to the default.
Use terminal width to determine the number of characters in each line of CLI output. Use show terminal to find the current terminal length, and to find whether or not more is disabled.
bstnA(cfg)# terminal length 200
bstnA(cfg)# terminal length 0
bstnA(cfg)# no terminal length
Use the terminal logging command to capture output from CLI show commands to a report file. This starts a session where the output of all subsequent CLI commands is recorded in the report file.
Use the no form of this command to stop the current terminal-logging session.
terminal logging [report-prefix]
report-prefix (optional, 1-1024 characters) is the prefix for a report file. The CLI logs its output to a report file named as follows:
report-prefix_yyyymmddHHMM.rpt, where report-prefix is chosen here, yyyy is the current year, mm is the current month, dd is the day, HH is the hour, and MM is the minute.
The CLI displays the name of the report file when you enter the command. Use show reports type CLI to view all CLI-log reports, or show reports report-name to view a specific CLI-log file.
The show terminal command indicates whether or not terminal logging is enabled.
bstnA(cfg)# terminal logging showoutput
enables terminal logging and captures show command output to the named log file.
bstnA(cfg)# no terminal logging
In CLI scripts, use terminal stop-on-error to stop script processing if the CLI responds with an error.
Use no terminal stop-on-error to continue processing the CLI script through all errors.
Use show terminal to find the current setting (enabled or disabled) for stop-on-error. Use copy ... scripts script-name to download a CLI script onto the switch.
bstnA(cfg)# terminal stop-on-error
bstnA(cfg)# no terminal stop-on-error
Use the affirmative form, terminal timeout, to re-instate time-outs.
seconds (0-2048) is the number of idle seconds before timing out the current CLI session. If you omit this value with the terminal timeout command, you set the default timeout of 900 (seconds, or 15 minutes).
Use show terminal to find the current setting (enabled or disabled) for terminal time-out.
bstnA(cfg)# no terminal timeout
bstnA(cfg)# terminal timeout
bstnA(cfg)# terminal timeout 1800
Use the terminal width command to set the maximum number of characters in each line of CLI output.
Use no terminal width to return to the default width.
number (0-255) is the maximum number of characters in each line of CLI output.
80 (and see the Guidelines, below)
Use terminal length to determine the number of lines in each page of CLI output. Use show terminal to find the current terminal width.
bstnA(cfg)# terminal width 120
bstnA(cfg)# no terminal width