2. admin Commands

clear
lockout
all
user string
all
user string
address (ipv4-address-no-zone | ipv6-address-no-zone)
op-table-bypass boolean
session-id number
session-type keyword
username string
nat
reboot
keyword
hold
now
now
save
string
bof
debug
li
set
time
string
show
string
bof
booted
cflash-id string
debug
detail
flat
json
li
running
units
xml
system
license
string
now
string
number
op-table-bypass boolean
number
op-table-bypass boolean
algorithm keyword
key string
grpc
cancel
all
subscription-id number
string

2.1. admin Command Descriptions

admin

Synopsis

Enter the administrative context for system operations

Context
Tree
Introduced

16.0.R1

Platforms

All

clear

Synopsis

Enter the clear context

Context
Tree
Introduced

19.10.R1

Platforms

All

security

Synopsis

Enter the security context

Tree
Introduced

19.10.R1

Platforms

All

lockout

Synopsis

Reset the lockout timer

Tree
Introduced

19.10.R1

Platforms

All

all

Synopsis

Clear lockout of all users

Tree
Notes

The following are part of a mandatory choice: all or user.

Introduced

19.10.R1

Platforms

All

user string

Synopsis

User to be cleared of lockout

Tree
String Length

1 to 32

Notes

The following are part of a mandatory choice: all or user.

Introduced

19.10.R1

Platforms

All

password-history

Synopsis

Clear the password history

Introduced

19.10.R1

Platforms

All

all

Synopsis

Clear password history of all users

Tree
Notes

The following are part of a mandatory choice: all or user.

Introduced

19.10.R1

Platforms

All

user string

Synopsis

User to be cleared of password history information

Tree
String Length

1 to 32

Notes

The following are part of a mandatory choice: all or user.

Introduced

19.10.R1

Platforms

All

disconnect

Synopsis

Disconnect a user session

Context
Introduced

16.0.R1

Platforms

All

address (ipv4-address-no-zone | ipv6-address-no-zone)

Synopsis

IP address of the session to disconnect

Context

admin disconnect address (ipv4-address-no-zone | ipv6-address-no-zone)

Tree
Introduced

19.10.R1

Platforms

All

op-table-bypass boolean

Synopsis

Avoid operation ID allocation

Description

When configured to true, the system bypasses the YANG-based operations infrastructure and avoids the allocation of an operation ID. This is useful if the global operations table is full and a delete operation or admin disconnect is required.

Introduced

21.5.R1

Platforms

All

session-id number

Synopsis

ID of the session to disconnect

Context
Range

1 to 4294967295

Introduced

16.0.R1

Platforms

All

session-type keyword

Synopsis

Type of session to disconnect

Context
Options

console, bluetooth, telnet, ssh, ftp, netconf, grpc, cron-ehs

Introduced

19.10.R1

Platforms

All

username string

Synopsis

Username to disconnect

Context
Tree
String Length

1 to 32

Introduced

19.10.R1

Platforms

All

nat

Synopsis

Enter the nat context

Context
Tree
Introduced

21.2.R1

Platforms

All

save-deterministic-script

Synopsis

Save script that computes deterministic NAT map entries

Introduced

21.2.R1

Platforms

All

reboot

Synopsis

Reboot CPM or force an upgrade of system boot ROMs

Context
Tree
Introduced

16.0.R1

Platforms

All

[card] keyword

Synopsis

Card to reboot

Context

admin reboot keyword

Options

active, standby, upgrade

Introduced

16.0.R1

Platforms

All

hold

Synopsis

Hold a rebooted standby from coming back online

Context
Tree
Introduced

19.10.R1

Platforms

7750 SR-7s, 7750 SR-14s, VSR

now

Synopsis

Force the reboot immediately without confirmation

Context
Tree
Introduced

16.0.R1

Platforms

All

redundancy

Synopsis

Enter the redundancy context

Context
Introduced

16.0.R1

Platforms

All

force-switchover

Synopsis

Force a switchover to the standby CPM

Introduced

16.0.R1

Platforms

All

ignore-status

Synopsis

Switch to standby CPM regardless of its status

Introduced

19.10.R1

Platforms

7950 XRS-20, 7950 XRS-20e, 7950 XRS-40

now

Synopsis

Force the switchover to the standby CPM immediately

Tree
Introduced

16.0.R1

Platforms

All

synchronize

Synopsis

Synchronize the secondary CPM

Introduced

20.10.R1

Platforms

All

boot-environment

Synopsis

Synchronize files used in system initialization

Notes

The following are part of a mandatory choice: boot-environment or configuration.

Introduced

20.10.R1

Platforms

All

configuration

Synopsis

Synchronize the configuration files only

Notes

The following are part of a mandatory choice: boot-environment or configuration.

Introduced

20.10.R1

Platforms

All

save

Synopsis

Perform configuration save operations

Context
Tree
Introduced

16.0.R1

Platforms

All

[url] string

Synopsis

Location to save the configuration

Context

admin save string

Introduced

16.0.R1

Platforms

All

bof

Synopsis

Save the bof region configuration

Context
Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

20.10.R1

Platforms

All

configure

Synopsis

Save the configure region configuration

Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

20.10.R1

Platforms

All

debug

Synopsis

Save the debug region configuration

Context
Tree
Description

This command saves debugging configuration. When a URL is not specified, the file is saved at the location specified by the bof configuration primary-location command.

Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

21.5.R1

Platforms

All

li

Synopsis

Save the li region configuration

Context
Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

19.10.R1

Platforms

All

set

Synopsis

Enter the set context

Context
Tree
Introduced

19.10.R1

Platforms

All

time

Synopsis

Current date and time (UTC) maintained in the system

Context
Tree
Introduced

19.10.R1

Platforms

All

[time] string

Synopsis

Current date and time (UTC) maintained in the system

Context

admin set time string

Notes

This element is mandatory.

Introduced

19.10.R1

Platforms

All

show

Synopsis

Enter the show context

Context
Tree
Introduced

16.0.R1

Platforms

All

configuration

Synopsis

Show the current configuration

Introduced

16.0.R1

Platforms

All

[cli-path] string

Synopsis

Absolute path or relative path from '/'

Context
Introduced

20.10.R1

Platforms

All

bof

Synopsis

Show the configuration from the bof region

Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

20.10.R1

Platforms

All

booted

Synopsis

Show the booted BOF configuration

Tree
Notes

The following are part of a choice: booted or cflash-id.

Introduced

20.10.R1

Platforms

All

cflash-id string

Synopsis

Show the BOF configuration file on a compact flash

Tree
String Length

4 to 6

Notes

The following are part of a choice: booted or cflash-id.

Introduced

20.10.R1

Platforms

All

configure

Synopsis

Show the configuration from the configure region

Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

20.7.R1

Platforms

All

debug

Synopsis

Show the configuration from the debug region

Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

21.5.R1

Platforms

All

detail

Synopsis

Include default and unconfigured values

Tree
Introduced

20.7.R1

Platforms

All

flat

Synopsis

Show the context from the pwc on each line

Tree
Notes

The following are part of a choice: flat, full-context, json, or xml.

Introduced

20.7.R1

Platforms

All

full-context

Synopsis

Show the full context on each line

Notes

The following are part of a choice: flat, full-context, json, or xml.

Introduced

20.7.R1

Platforms

All

intended

Synopsis

Show the intended configuration

Tree
Notes

The following are part of a choice: intended or running.

Introduced

20.7.R1

Platforms

All

json

Synopsis

Show the output in indented JSON format

Tree
Notes

The following are part of a choice: flat, full-context, json, or xml.

Introduced

19.10.R1

Platforms

All

li

Synopsis

Show the configuration from the li region

Tree
Notes

The following are part of a choice: bof, configure, debug, or li.

Introduced

19.10.R1

Platforms

All

running

Synopsis

Show the running configuration

Tree
Notes

The following are part of a choice: intended or running.

Introduced

20.7.R1

Platforms

All

units

Synopsis

Show units

Tree
Introduced

20.10.R1

Platforms

All

xml

Synopsis

Show the output in indented XML format

Tree
Notes

The following are part of a choice: flat, full-context, json, or xml.

Introduced

20.7.R1

Platforms

All

support-mode

Synopsis

Enable the shell and kernel commands

Introduced

16.0.R4

Platforms

All

system

Synopsis

Enter the system context

Context
Tree
Introduced

16.0.R6

Platforms

All

license

Synopsis

Enter the license context

Tree
Introduced

19.10.R1

Platforms

All

activate

Synopsis

Load and activate a system license

Tree
Introduced

19.10.R1

Platforms

All

[file-url] string

Synopsis

Location of the license file to activate

Context
String Length

1 to 256

Introduced

19.10.R1

Platforms

All

now

Synopsis

Activate the license immediately

Tree
Introduced

19.10.R1

Platforms

All

validate

Synopsis

Load and validate a system license

Tree
Introduced

19.10.R1

Platforms

All

[file-url] string

Synopsis

Location of the license file to validate

Context
String Length

1 to 256

Introduced

19.10.R1

Platforms

All

management-interface

Synopsis

Enter the management-interface context

Introduced

21.5.R1

Platforms

All

operations

Synopsis

Enter the operations context

Description

Commands in this context are used to manage YANG-based operations (for example, admin reboot, or ping) in model-driven interfaces.

Introduced

21.5.R1

Platforms

All

delete-operation

Synopsis

Stop and remove an operation

Description

This command removes an operation and all status and data associated with it. If the operation was executing, it is stopped before removal.

Introduced

21.5.R1

Platforms

All

[delete-id] number

Synopsis

ID of the operation to remove

Range

1 to 10000

Notes

This element is mandatory.

Introduced

21.5.R1

Platforms

All

op-table-bypass boolean

Synopsis

Avoid operation ID allocation

Description

When configured to true, the system bypasses the YANG-based operations infrastructure and avoids the allocation of an operation ID. This is useful if the global operations table is full and a delete operation or admin disconnect is required.

Introduced

21.5.R1

Platforms

All

stop-operation

Synopsis

Stop the execution of an operational command

Description

This command stops the execution of an operational command.

An operation launched as "asynchronous" is not deleted from the system when it is stopped. Status and other data associated with the operation persist until the operation is explicitly deleted using the delete operation command or a retention timeout.

Introduced

21.5.R1

Platforms

All

[stop-id] number

Synopsis

ID of the operation to stop

Range

1 to 10000

Notes

This element is mandatory.

Introduced

21.5.R1

Platforms

All

op-table-bypass boolean

Synopsis

Avoid operation ID allocation

Description

When configured to true, the system bypasses the YANG-based operations infrastructure and avoids the allocation of an operation ID. This is useful if the global operations table is full and a delete operation or admin disconnect is required.

Introduced

21.5.R1

Platforms

All

security

Synopsis

Enter the security context

Tree
Introduced

16.0.R6

Platforms

All

hash-control

Synopsis

Enter the hash-control context

Introduced

16.0.R6

Platforms

All

custom-hash

Synopsis

Custom encryption

Introduced

16.0.R6

Platforms

All

algorithm keyword

Synopsis

Algorithm for custom encryption

Tree
Options

3des, aes128, aes192, aes256

Notes

This element is mandatory.

Introduced

16.0.R6

Platforms

All

key string

Synopsis

Key for encryption algorithm

Tree
String Length

1 to 71

Notes

This element is mandatory.

Introduced

16.0.R6

Platforms

All

remove-custom-hash

Synopsis

Remove the custom encryption

Introduced

20.10.R1

Platforms

All

telemetry

Synopsis

Enter the telemetry context

Tree
Introduced

19.10.R1

Platforms

All

grpc

Synopsis

Enter the grpc context

Tree
Introduced

19.10.R1

Platforms

All

cancel

Synopsis

Cancel the gRPC dynamic telemetry subscription

Tree
Introduced

19.10.R1

Platforms

All

all

Synopsis

Cancel gRPC dynamic telemetry for all subscriptions

Tree
Notes

The following are part of a mandatory choice: all or subscription-id.

Introduced

19.10.R1

Platforms

All

subscription-id number

Synopsis

ID of the telemetry subscription to cancel

Notes

The following are part of a mandatory choice: all or subscription-id.

Introduced

19.10.R1

Platforms

All

tech-support

Synopsis

Save technical support information to a file

Introduced

20.10.R1

Platforms

All

[url] string

Synopsis

URL to save technical support information

Context
String Length

1 to 180

Introduced

20.10.R1

Platforms

All