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
         —  mount-point (keyword | string) 
         —  python-script reference
   —  command-completion 
      —  enter boolean
      —  space boolean
      —  tab boolean
   —  console 
      —  length number
      —  width 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
Parent topic: Operational commands

environment command descriptions

environment

  Synopsis Configure the environment settings for this session
  Context environment
  Tree environment
  Introduced 16.0.R1
 

Platforms

All

command-alias

  Synopsis Enter the command-alias context
  Context environment command-alias
  Tree command-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.
  Introduced 21.7.R1
 

Platforms

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

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.
  Introduced 21.7.R1
 

Platforms

All
[alias-name] string
  Synopsis Alias name
  Context environment command-alias alias string
  String Length 1 to 64
 

Notes

This element is part of a list key.
  Introduced 21.7.R1
 

Platforms

All
admin-state keyword
  Synopsis Administrative state of the alias
  Context environment command-alias alias string admin-state keyword
  Tree admin-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.
  Options enable, disable
  Introduced 21.10.R1
 

Platforms

All
cli-command string
  Synopsis CLI command to run when executing the alias
  Context environment command-alias alias string cli-command string
  Tree cli-command
  String Length 1 to 255
 

Notes

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

Platforms

All
description string
  Synopsis Text description
  Context environment command-alias alias string description string
  Tree description
  String Length 1 to 110
  Introduced 21.7.R1
 

Platforms

All
mount-point [path] (keyword | string)
  Synopsis Add a list entry for mount-point
  Context environment command-alias alias string mount-point (keyword | string)
  Tree mount-point
  Min. Instances 1
  Introduced 21.7.R1
 

Platforms

All
[path] (keyword | string)
  Synopsis Mount point where alias is available
  Context environment command-alias alias string mount-point (keyword | string)
  String Length 1 to 255
  Options global
 

Notes

This element is part of a list key.
  Introduced 21.7.R1
 

Platforms

All
python-script reference
  Synopsis Python script to run when executing the alias
  Context environment command-alias alias string python-script reference
  Tree python-script
 

Reference

state python python-script [name] string
 

Notes

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

Platforms

All

command-completion

  Synopsis Enter the command-completion context
  Context environment command-completion
  Tree command-completion
  Introduced 16.0.R1
 

Platforms

All
enter boolean
  Synopsis Complete the command when the Enter key is pressed
  Context environment command-completion enter boolean
  Tree enter
  Default true
  Introduced 16.0.R1
 

Platforms

All
space boolean
  Synopsis Complete the command when the Space key is pressed
  Context environment command-completion space boolean
  Tree space
  Default true
  Introduced 16.0.R1
 

Platforms

All
tab boolean
  Synopsis Complete the command when the Tab key is pressed
  Context environment command-completion tab boolean
  Tree tab
  Default true
  Introduced 16.0.R1
 

Platforms

All

console

  Synopsis Enter the console context
  Context environment console
  Tree console
  Introduced 16.0.R1
 

Platforms

All
length number
  Synopsis Number of lines displayed on the screen
  Context environment console length number
  Tree length
  Range 24 to 512
  Default 24
  Introduced 16.0.R1
 

Platforms

All
width number
  Synopsis Number of columns displayed on the screen
  Context environment console width number
  Tree width
  Range 80 to 512
  Default 80
  Introduced 16.0.R1
 

Platforms

All

info-output

  Synopsis Enter the info-output context
  Context environment info-output
  Tree info-output
  Introduced 22.2.R1
 

Platforms

All
always-display
  Synopsis Enter the always-display context
  Context environment info-output always-display
  Tree always-display
 

Description

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

Platforms

All
admin-state boolean
  Synopsis Display admin-state elements
  Context environment info-output always-display admin-state boolean
  Tree admin-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.
  Default false
  Introduced 22.2.R1
 

Platforms

All

message-severity-level

  Synopsis Enter the message-severity-level context
  Context environment message-severity-level
  Tree message-severity-level
  Introduced 16.0.R1
 

Platforms

All
cli keyword
  Synopsis Message severity threshold for CLI messages
  Context environment message-severity-level cli keyword
  Tree cli
  Default info
  Options warning, info
  Introduced 16.0.R1
 

Platforms

All

more boolean

  Synopsis Prompt to continue or stop when output text fills page
  Context environment more boolean
  Tree more
  Default true
  Introduced 16.0.R1
 

Platforms

All

progress-indicator

  Synopsis Enter the progress-indicator context
  Context environment progress-indicator
  Tree progress-indicator
  Introduced 16.0.R1
 

Platforms

All
admin-state keyword
  Synopsis Administrative state of the progress indicator
  Context environment progress-indicator admin-state keyword
  Tree admin-state
  Default enable
  Options enable, disable
  Introduced 16.0.R1
 

Platforms

All
delay number
  Synopsis Delay before progress indicator is displayed
  Context environment progress-indicator delay number
  Tree delay
  Range 0 to 10000
  Default 1000
  Units milliseconds
  Introduced 16.0.R1
 

Platforms

All
type keyword
  Synopsis Progress indicator output style
  Context environment progress-indicator type keyword
  Tree type
  Default dots
  Options dots
  Introduced 16.0.R1
 

Platforms

All

prompt

  Synopsis Enter the prompt context
  Context environment prompt
  Tree prompt
  Introduced 16.0.R1
 

Platforms

All
context boolean
  Synopsis Show the current command context in the prompt
  Context environment prompt context boolean
  Tree context
  Default true
  Introduced 16.0.R1
 

Platforms

All
newline boolean
  Synopsis Add a new line before every prompt line
  Context environment prompt newline boolean
  Tree newline
  Default true
  Introduced 16.0.R1
 

Platforms

All
timestamp boolean
  Synopsis Show the timestamp before the first prompt line
  Context environment prompt timestamp boolean
  Tree timestamp
  Default false
  Introduced 16.0.R1
 

Platforms

All
uncommitted-changes-indicator boolean
  Synopsis Show an asterisk (*) when uncommitted changes exist
  Context environment prompt uncommitted-changes-indicator boolean
  Tree uncommitted-changes-indicator
  Default true
  Introduced 16.0.R1
 

Platforms

All

python

  Synopsis Enter the python context
  Context environment python
  Tree python
  Introduced 21.10.R1
 

Platforms

All
memory-reservation number
  Synopsis Memory reserved per interpreter
  Context environment python memory-reservation number
  Tree memory-reservation
  Range 1 to 500
  Units megabytes
  Introduced 21.10.R1
 

Platforms

All
minimum-available-memory number
  Synopsis Minimum memory requirement to spawn Python interpreter
  Context environment python minimum-available-memory number
  Tree minimum-available-memory
  Range 5 to 50
  Units percent
  Introduced 21.10.R1
 

Platforms

All
timeout number
  Synopsis Maximum run time before a Python application is stopped
  Context environment python timeout number
  Tree timeout
  Range 30 to 86400
  Default 3600
  Units seconds
  Introduced 21.10.R1
 

Platforms

All

time-display keyword

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

Description

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

Log files on compact flash are maintained and displayed in UTC format.
  Default local
  Options local, utc
  Introduced 16.0.R1
 

Platforms

All

time-format keyword

  Synopsis Time format to display date and time
  Context environment time-format keyword
  Tree time-format
 

Description

This command specifies the format of the time display in configuration, state, and certain show command output in the current CLI session.
  Default rfc-3339
  Options iso-8601, rfc-1123, rfc-3339
  Introduced 20.5.R1
 

Platforms

All