environment commands

See “Environment commands” in the 7705 SAR Gen 2 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
   —  commit-options 
      —  comment boolean
      —  confirm boolean
   —  console 
      —  length number
      —  width number
   —  history 
      —  recall boolean
      —  size number
   —  info-output 
      —  always-display 
         —  admin-state boolean
   —  match-highlight 
      —  admin-state keyword
      —  style keyword
   —  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
	Context	environment
	Tree	environment
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

[alias-name] string


	Synopsis	Alias name
	Context	environment command-alias alias string
	Tree	alias
	String length	1 to 64
	String format	must only contain alpha-numeric characters, underscore or hyphen (not as the first character)
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

description string-not-all-spaces


	Synopsis	Text description
	Context	environment command-alias alias string description string-not-all-spaces
	Tree	description
	String length	1 to 110
	String format	'string-not-all-spaces' must contain at least one non-space character
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

[path] (keyword | string)


	Synopsis	Mount point where the alias is available
	Context	environment command-alias alias string mount-point (keyword \| string)
	Tree	mount-point
	String length	1 to 255
	Options	global
	String format	must start with forward slash
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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 named-item
	Notes	The following elements are part of a mandatory choice: cli-command or python-script.
	Introduced	26.7.R1
	Platforms	SAR Gen 2

command-completion


	Synopsis	Enter the command-completion context
	Context	environment command-completion
	Tree	command-completion
	Introduced	25.3.R2
	Platforms	SAR Gen 2

enter boolean


	Synopsis	Complete the command when the Enter key is pressed
	Context	environment command-completion enter boolean
	Tree	enter
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

space boolean


	Synopsis	Complete the command when the Space key is pressed
	Context	environment command-completion space boolean
	Tree	space
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

tab boolean


	Synopsis	Complete the command when the Tab key is pressed
	Context	environment command-completion tab boolean
	Tree	tab
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

commit-options


	Synopsis	Enter the commit-options context
	Context	environment commit-options
	Tree	commit-options
	Introduced	25.3.R2
	Platforms	SAR Gen 2

comment boolean


	Synopsis	Require a commit comment when committing configuration
	Context	environment commit-options comment boolean
	Tree	comment
	Default	false
	Introduced	25.3.R2
	Platforms	SAR Gen 2

confirm boolean


	Synopsis	Require confirmed commit when committing configuration
	Context	environment commit-options confirm boolean
	Tree	confirm
	Default	false
	Introduced	25.3.R2
	Platforms	SAR Gen 2

console


	Synopsis	Enter the console context
	Context	environment console
	Tree	console
	Introduced	25.3.R2
	Platforms	SAR Gen 2

length number


	Synopsis	Number of lines displayed on the console
	Context	environment console length number
	Tree	length
	Range	24 to 512
	Default	24
	Introduced	25.3.R2
	Platforms	SAR Gen 2

width number


	Synopsis	Number of columns displayed on the console
	Context	environment console width number
	Tree	width
	Range	80 to 512
	Default	80
	Introduced	25.3.R2
	Platforms	SAR Gen 2

history


	Synopsis	Enter the history context
	Context	environment history
	Tree	history
	Introduced	25.3.R2
	Platforms	SAR Gen 2

recall boolean


	Synopsis	Allow command history recall and search execution
	Context	environment history recall boolean
	Tree	recall
	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.
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

size number


	Synopsis	Command history size
	Context	environment history size number
	Tree	size
	Description	This command specifies the maximum size of the command history. A value of 0 disables the command history.
	Range	0 to 1000
	Default	50
	Introduced	25.3.R2
	Platforms	SAR Gen 2

info-output


	Synopsis	Enter the info-output context
	Context	environment info-output
	Tree	info-output
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

admin-state boolean


	Synopsis	Always 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	25.3.R2
	Platforms	SAR Gen 2

match-highlight


	Synopsis	Enter the match-highlight context
	Context	environment match-highlight
	Tree	match-highlight
	Introduced	26.3.R1
	Platforms	SAR Gen 2

admin-state keyword


	Synopsis	Administrative state of match highlighting
	Context	environment match-highlight admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	disable
	Introduced	26.3.R1
	Platforms	SAR Gen 2

style keyword


	Synopsis	Match highlighting style
	Context	environment match-highlight style keyword
	Tree	style
	Options	bold, underline, reverse
	Max. instances	3
	Introduced	26.3.R1
	Platforms	SAR Gen 2

message-severity-level


	Synopsis	Enter the message-severity-level context
	Context	environment message-severity-level
	Tree	message-severity-level
	Introduced	25.3.R2
	Platforms	SAR Gen 2

cli keyword


	Synopsis	Message severity threshold for CLI messages
	Context	environment message-severity-level cli keyword
	Tree	cli
	Options	warning, info
	Default	info
	Introduced	25.3.R2
	Platforms	SAR Gen 2

more boolean


	Synopsis	Activate the pager when output is longer than a screen
	Context	environment more boolean
	Tree	more
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

progress-indicator


	Synopsis	Enter the progress-indicator context
	Context	environment progress-indicator
	Tree	progress-indicator
	Introduced	25.3.R2
	Platforms	SAR Gen 2

admin-state keyword


	Synopsis	Administrative state of the progress indicator
	Context	environment progress-indicator admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	enable
	Introduced	25.3.R2
	Platforms	SAR Gen 2

delay number


	Synopsis	Delay before the progress indicator is displayed
	Context	environment progress-indicator delay number
	Tree	delay
	Range	0 to 10000
	Units	milliseconds
	Default	1000
	Introduced	25.3.R2
	Platforms	SAR Gen 2

type keyword


	Synopsis	Progress indicator output style
	Context	environment progress-indicator type keyword
	Tree	type
	Options	dots
	Default	dots
	Introduced	25.3.R2
	Platforms	SAR Gen 2

prompt


	Synopsis	Enter the prompt context
	Context	environment prompt
	Tree	prompt
	Introduced	25.3.R2
	Platforms	SAR Gen 2

context boolean


	Synopsis	Show the current command context in the prompt
	Context	environment prompt context boolean
	Tree	context
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

newline boolean


	Synopsis	Add a new line before every prompt line
	Context	environment prompt newline boolean
	Tree	newline
	Default	true
	Introduced	25.3.R2
	Platforms	SAR Gen 2

timestamp boolean


	Synopsis	Show the timestamp before the first prompt line
	Context	environment prompt timestamp boolean
	Tree	timestamp
	Default	false
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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	25.3.R2
	Platforms	SAR Gen 2

python


	Synopsis	Enter the python context
	Context	environment python
	Tree	python
	Introduced	25.3.R2
	Platforms	SAR Gen 2

memory-reservation number


	Synopsis	Memory reserved per Python interpreter
	Context	environment python memory-reservation number
	Tree	memory-reservation
	Range	1 to 500
	Units	megabytes
	Introduced	25.3.R2
	Platforms	SAR Gen 2

minimum-available-memory number


	Synopsis	Minimum memory requirement to run a Python interpreter
	Context	environment python minimum-available-memory number
	Tree	minimum-available-memory
	Range	5 to 50
	Units	percent
	Introduced	25.3.R2
	Platforms	SAR Gen 2

timeout number


	Synopsis	Maximum run time before a Python application is stopped
	Context	environment python timeout number
	Tree	timeout
	Range	30 to 86400
	Units	seconds
	Default	3600
	Introduced	25.3.R2
	Platforms	SAR Gen 2

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 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.
	Options	local, utc
	Default	local
	Introduced	25.3.R2
	Platforms	SAR Gen 2

time-format keyword


	Synopsis	Format to display the date and time
	Context	environment time-format keyword
	Tree	time-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.
	Options	iso-8601, rfc-1123, rfc-3339
	Default	rfc-3339
	Introduced	25.3.R2
	Platforms	SAR Gen 2