environment commands

See “Environment commands” in the 7450 ESS, 7750 SR, 7950 XRS, and VSR MD-CLI User Guide for more information.

environment 
command-alias 
alias string 
admin-state keyword
cli-command string
description string-not-all-spaces
mount-point (keyword | string) 
python-script reference
command-completion 
enter boolean
space boolean
tab boolean
console 
length number
width number
history 
recall boolean
size number
info-output 
always-display 
admin-state boolean
message-severity-level 
cli keyword
more boolean
progress-indicator 
admin-state keyword
delay number
type keyword
prompt 
context boolean
newline boolean
timestamp boolean
uncommitted-changes-indicator boolean
python 
memory-reservation number
minimum-available-memory number
timeout number
time-display keyword
time-format keyword

environment command descriptions

environment

Synopsis Configure the environment settings for this session
Contextenvironment
Treeenvironment
Introduced16.0.R1

Platforms

All

command-alias

Synopsis Enter the command-alias context
Contextenvironment command-alias
Treecommand-alias

Description

Commands in this context create aliases to existing MD-CLI commands or to Python scripts.

Aliases may be mounted for use globally or for selected context paths. Arguments and output modifiers may be provided to aliases at configuration or run time.

Introduced21.7.R1

Platforms

All

alias [alias-name] string
Synopsis Enter the alias list instance
Context environment command-alias alias string
Treealias

Description

Commands in this context create aliases to existing MD-CLI commands or to Python applications.

Aliases may be mounted for use globally or for selected context paths. Arguments and output modifiers may be provided to aliases at configuration or run time.

Introduced21.7.R1

Platforms

All

[alias-name] string
Synopsis Alias name
Contextenvironment command-alias alias string
Treealias
String length1 to 64

Notes

This element is part of a list key.

Introduced21.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the alias
Context environment command-alias alias string admin-state keyword
Treeadmin-state

Description

This command controls the administrative state of the MD-CLI alias.

MD-CLI aliases that are administratively disabled cannot be executed, do not autocomplete in operational mode, and do not appear in ? help.

Optionsenable, disable
Introduced 21.10.R1

Platforms

All

cli-command string
Synopsis CLI command to run when executing the alias
Contextenvironment command-alias alias string cli-command string
Treecli-command
String length1 to 255

Notes

The following elements are part of a mandatory choice: cli-command or python-script.

Introduced21.7.R1

Platforms

All

python-script reference
Synopsis Python script to run when executing the alias
Contextenvironment command-alias alias string python-script reference
Treepython-script

Reference

state python python-script name

Notes

The following elements are part of a mandatory choice: cli-command or python-script.

Introduced21.7.R1

Platforms

All

command-completion

Synopsis Enter the command-completion context
Contextenvironment command-completion
Treecommand-completion
Introduced16.0.R1

Platforms

All

console

Synopsis Enter the console context
Context environment console
Treeconsole
Introduced16.0.R1

Platforms

All

length number
Synopsis Number of lines displayed on the console
Contextenvironment console length number
Treelength
Range24 to 512
Default24
Introduced 16.0.R1

Platforms

All

width number
Synopsis Number of columns displayed on the console
Contextenvironment console width number
Treewidth
Range80 to 512
Default80
Introduced 16.0.R1

Platforms

All

history

Synopsis Enter the history context
Context environment history
Treehistory
Introduced24.7.R1

Platforms

All

recall boolean
Synopsis Allow command history recall and search execution
Contextenvironment history recall boolean
Treerecall

Description

When configured to true, the command history recall (!), substitution (!$), display (:p, Esc+.), and backward search (Ctrl-R) are enabled.

When configured to false, the command history can be displayed using the history command, but commands in the history cannot be executed.

Defaulttrue
Introduced24.7.R1

Platforms

All

size number
Synopsis Command history size
Context environment history size number
Treesize

Description

This command specifies the maximum size of the command history. A value of 0 disables the command history.

Range0 to 1000
Default50
Introduced 24.7.R1

Platforms

All

info-output

Synopsis Enter the info-output context
Context environment info-output
Treeinfo-output
Introduced22.2.R1

Platforms

All

always-display
Synopsis Enter the always-display context
Contextenvironment info-output always-display
Treealways-display

Description

Commands in this context specify elements that are always displayed, regardless of whether they are set to their default value.

Introduced22.2.R1

Platforms

All

admin-state boolean
Synopsis Always display admin-state elements
Context environment info-output always-display admin-state boolean
Treeadmin-state

Description

When configured to true, the values of the admin-state elements in info output (without the detail option) are always displayed, even if they are the default values.

Defaultfalse
Introduced22.2.R1

Platforms

All

more boolean

Synopsis Activate the pager when output is longer than a screen
Contextenvironment more boolean
Treemore
Defaulttrue
Introduced16.0.R1

Platforms

All

progress-indicator

Synopsis Enter the progress-indicator context
Contextenvironment progress-indicator
Treeprogress-indicator
Introduced16.0.R1

Platforms

All

delay number
Synopsis Delay before the progress indicator is displayed
Contextenvironment progress-indicator delay number
Treedelay
Range0 to 10000
Unitsmilliseconds
Default 1000
Introduced16.0.R1

Platforms

All

prompt

Synopsis Enter the prompt context
Context environment prompt
Treeprompt
Introduced16.0.R1

Platforms

All

context boolean
Synopsis Show the current command context in the prompt
Contextenvironment prompt context boolean
Treecontext
Defaulttrue
Introduced16.0.R1

Platforms

All

newline boolean
Synopsis Add a new line before every prompt line
Contextenvironment prompt newline boolean
Treenewline
Defaulttrue
Introduced16.0.R1

Platforms

All

timestamp boolean
Synopsis Show the timestamp before the first prompt line
Contextenvironment prompt timestamp boolean
Treetimestamp
Defaultfalse
Introduced16.0.R1

Platforms

All

python

Synopsis Enter the python context
Context environment python
Treepython
Introduced21.10.R1

Platforms

All

timeout number
Synopsis Maximum run time before a Python application is stopped
Contextenvironment python timeout number
Treetimeout
Range30 to 86400
Unitsseconds
Default 3600
Introduced21.10.R1

Platforms

All

time-display keyword

Synopsis Time zone to display time
Context environment time-display keyword
Treetime-display

Description

This command configures the time zone for a timestamp displayed in outputs, such as event logs and show commands for the current CLI session.

In event logs, the selected time is used to control the timestamps in the CLI output of show log log-id and in YANG state in the /state/log/log-id branch (for logs such as session, cli, memory, SNMP, and NETCONF).

Also see the configure log log-id time-format command.

Optionslocal, utc
Default local
Introduced16.0.R1

Platforms

All

time-format keyword

Synopsis Format to display the date and time
Context environment time-format keyword
Treetime-format

Description

This command specifies the format of the time display in the prompt, configuration, state, and certain show command output in the current CLI session.

Optionsiso-8601, rfc-1123, rfc-3339
Defaultrfc-3339
Introduced20.5.R1

Platforms

All