4. environment commands

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

alias string
admin-state keyword
cli-command string
description string
mount-point (keyword | string)
python-script reference
enter boolean
space boolean
tab boolean
console
length number
width number
admin-state boolean
cli keyword
more boolean
admin-state keyword
delay number
type keyword
prompt
context boolean
newline boolean
timestamp boolean
python
memory-reservation number
timeout number
time-display keyword
time-format keyword

4.1. environment command descriptions

environment

Synopsis

Enter the environment configuration context

Context
Introduced

16.0.R1

Platforms

All

command-alias

Synopsis

Enter the command-alias context

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

Tree
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

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

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

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

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)

Min. Elements

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
Reference

state python python-script name

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

Introduced

16.0.R1

Platforms

All

enter boolean

Synopsis

Complete the command when the Enter key is pressed

Tree
Default

true

Introduced

16.0.R1

Platforms

All

space boolean

Synopsis

Complete the command when the Space key is pressed

Tree
Default

true

Introduced

16.0.R1

Platforms

All

tab boolean

Synopsis

Complete the command when the Tab key is pressed

Tree
Default

true

Introduced

16.0.R1

Platforms

All

console

Synopsis

Enter the console context

Tree
Introduced

16.0.R1

Platforms

All

length number

Synopsis

Number of lines displayed on the screen

Context
Tree
Range

24 to 512

Default

24

Introduced

16.0.R1

Platforms

All

width number

Synopsis

Number of columns displayed on the screen

Context
Tree
Range

80 to 512

Default

80

Introduced

16.0.R1

Platforms

All

info-output

Synopsis

Enter the info-output context

Introduced

22.2.R1

Platforms

All

always-display

Synopsis

Enter the always-display context

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

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

Introduced

16.0.R1

Platforms

All

cli keyword

Synopsis

Message severity threshold for CLI messages

Tree
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
Tree
Default

true

Introduced

16.0.R1

Platforms

All

progress-indicator

Synopsis

Enter the progress-indicator context

Introduced

16.0.R1

Platforms

All

admin-state keyword

Synopsis

Administrative state of the progress indicator

Default

enable

Options

enable, disable

Introduced

16.0.R1

Platforms

All

delay number

Synopsis

Delay before progress indicator is displayed

Tree
Range

0 to 10000

Default

1000

Units

milliseconds

Introduced

16.0.R1

Platforms

All

type keyword

Synopsis

Progress indicator output style

Tree
Default

dots

Options

dots

Introduced

16.0.R1

Platforms

All

prompt

Synopsis

Enter the prompt context

Tree
Introduced

16.0.R1

Platforms

All

context boolean

Synopsis

Show the current command context in the prompt

Context
Tree
Default

true

Introduced

16.0.R1

Platforms

All

newline boolean

Synopsis

Add a new line before every prompt line

Context
Tree
Default

true

Introduced

16.0.R1

Platforms

All

timestamp boolean

Synopsis

Show the timestamp before the first prompt line

Context
Tree
Default

false

Introduced

16.0.R1

Platforms

All

uncommitted-changes-indicator boolean

Synopsis

Show an asterisk (*) when uncommitted changes exist

Default

true

Introduced

16.0.R1

Platforms

All

python

Synopsis

Enter the python context

Tree
Introduced

21.10.R1

Platforms

All

memory-reservation number

Synopsis

Memory reserved per interpreter

Range

1 to 500

Units

megabytes

Introduced

21.10.R1

Platforms

All

minimum-available-memory number

Synopsis

Minimum memory requirement to spawn Python interpreter

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
Tree
Range

30 to 86400

Default

3600

Units

seconds

Introduced

21.10.R1

Platforms

All

time-display keyword

Synopsis

Time zone to display time

Context
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
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