admin commands

admin commands are used to perform administrative functions, such as displaying configuration that is not subject to AAA, manually saving the configuration, clearing user sessions, and rebooting the system.

admin 
application-assurance 
group reference 
url-list reference 
upgrade 
upgrade 
clear 
security 
lockout 
all 
user string
password-history 
all 
user string
disconnect 
address (ipv4-address-no-zone | ipv6-address-no-zone)
op-table-bypass boolean
session-id number
session-type keyword
username string
nat 
save-deterministic-script 
reboot 
[card] keyword
hold 
now 
redundancy 
force-switchover 
ignore-status 
now 
synchronize 
boot-environment 
configuration 
satellite 
ethernet-satellite reference 
reboot 
now 
upgrade 
synchronize 
tech-support 
[url] string
save 
bof 
configure 
debug 
li 
[url] string
set 
time 
[system-time] string
show 
configuration 
bof 
booted 
cflash-id string
[cli-path] string
configure 
debug 
detail 
flat 
full-context 
intended 
json 
li 
running 
units 
xml 
support-mode 
system 
license 
activate 
[file-url] string
now 
validate 
[file-url] string
management-interface 
operations 
delete-operation 
[delete-id] number
op-table-bypass boolean
stop-operation 
op-table-bypass boolean
[stop-id] number
security 
hash-control 
custom-hash 
algorithm keyword
key string
remove-custom-hash 
system-password 
admin-password 
vsd-password 
telemetry 
grpc 
cancel 
all 
subscription-id number
tech-support 
[url] string

admin command descriptions

admin

Synopsis Enter the administrative context for system operations
Contextadmin
Treeadmin
Introduced16.0.R1

Platforms

All

application-assurance

Synopsis Enter the application-assurance context
Contextadmin application-assurance
Treeapplication-assurance

Description

Commands in this context configure Application Assurance (AA) upgrade and AA group upgrade operations.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

group [aa-group-id] reference
Synopsis Enter the group list instance
Context admin application-assurance group reference
Treegroup

Description

Commands in this context configure the attributes of the group-specific upgrade.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[aa-group-id] reference
Synopsis AA group ID
Contextadmin application-assurance group reference
Treegroup

Reference

state application-assurance group number

Notes

This element is part of a list key.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

url-list [url-list-name] reference
Synopsis Enter the url-list list instance
Contextadmin application-assurance group reference url-list reference
Treeurl-list

Description

Commands in this context configure the URL list upgrade parameters.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[url-list-name] reference
Synopsis AA URL list name
Context admin application-assurance group reference url-list reference
Treeurl-list

Reference

state application-assurance group url-list string

Notes

This element is part of a list key.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

upgrade
Synopsis Upgrade to a new isa-aa.tim file
Context admin application-assurance upgrade
Treeupgrade

Description

This command loads a new isa-aa.tim file as part of a router-independent signature upgrade. An AA ISA reboot is required for the upgrade to take effect.

Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

clear

Synopsis Enter the clear context
Context admin clear
Treeclear
Introduced19.10.R1

Platforms

All

security
Synopsis Enter the security context
Context admin clear security
Treesecurity
Introduced19.10.R1

Platforms

All

lockout
Synopsis Reset the lockout timer
Context admin clear security lockout
Treelockout
Introduced19.10.R1

Platforms

All

all
Synopsis Clear lockout of all users
Context admin clear security lockout all
Treeall

Notes

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

Introduced19.10.R1

Platforms

All

user string
Synopsis User to be cleared of lockout
Context admin clear security lockout user string
Treeuser
String Length1 to 32

Notes

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

Introduced19.10.R1

Platforms

All

password-history
Synopsis Clear the password history
Context admin clear security password-history
Treepassword-history
Introduced19.10.R1

Platforms

All

all
Synopsis Clear password history of all users
Context admin clear security password-history all
Treeall

Notes

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

Introduced19.10.R1

Platforms

All

user string
Synopsis User to be cleared of password history information
Contextadmin clear security password-history user string
Treeuser
String Length1 to 32

Notes

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

Introduced19.10.R1

Platforms

All

disconnect

Synopsis Disconnect a user session
Context admin disconnect
Treedisconnect
Introduced16.0.R1

Platforms

All

address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the session to disconnect
Contextadmin disconnect address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeaddress
Introduced19.10.R1

Platforms

All

op-table-bypass boolean
Synopsis Avoid operation ID allocation
Context admin disconnect op-table-bypass boolean
Treeop-table-bypass

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.

Introduced21.5.R1

Platforms

All

session-type keyword
Synopsis Type of session to disconnect
Context admin disconnect session-type keyword
Treesession-type
Optionsconsole, bluetooth, telnet, ssh, ftp, netconf, grpc, cron-ehs
Introduced 19.10.R1

Platforms

All

reboot

Synopsis Reboot CPM or force an upgrade of system boot ROMs
Contextadmin reboot
Treereboot
Introduced16.0.R1

Platforms

All

[card] keyword
Synopsis Card to reboot
Contextadmin reboot [card] keyword
Tree[card]
Optionsactive, standby, upgrade
Introduced16.0.R1

Platforms

All

hold
Synopsis Hold a rebooted standby CPM from coming back online
Contextadmin reboot hold
Treehold
Introduced19.10.R1

Platforms

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

now
Synopsis Reboot immediately without prompts or confirmation
Contextadmin reboot now
Treenow
Introduced16.0.R1

Platforms

All

redundancy

Synopsis Enter the redundancy context
Context admin redundancy
Treeredundancy
Introduced16.0.R1

Platforms

All

synchronize
Synopsis Synchronize the standby CPM
Context admin redundancy synchronize
Treesynchronize
Introduced20.10.R1

Platforms

All

satellite

Synopsis Perform administrative operations for satellites
Contextadmin satellite
Treesatellite
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ethernet-satellite [satellite-id] reference
Synopsis Enter the ethernet-satellite list instance
Contextadmin satellite ethernet-satellite reference
Treeethernet-satellite
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

[satellite-id] reference
Synopsis Satellite ID
Contextadmin satellite ethernet-satellite reference
Treeethernet-satellite

Reference

state satellite ethernet-satellite number

Notes

This element is part of a list key.

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

reboot
Synopsis Initiate an administrative reboot of the chassis
Contextadmin satellite ethernet-satellite reference reboot
Treereboot
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

now
Synopsis Reboot immediately without prompts or confirmation
Contextadmin satellite ethernet-satellite reference reboot now
Treenow
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

tech-support
Synopsis Save satellite technical support information
Contextadmin satellite ethernet-satellite reference tech-support
Treetech-support

Description

This command creates a system core dump. If no file URL is specified and the ts-location command is configured in the configure system security tech-support context, the technical support file is automatically generated by the system with the file name based on the system name and the date and time, and is saved to the directory indicated by the ts-location configuration.

The format of the auto-generated file name is ts-XXXXX.YYYYMMDD.HHMMUTC.dat, where:

  • XXXXX is the system name with special characters expanded to avoid problems with file systems (for example, a period (.) is expanded to %2E)

  • YYYYMMDD is the date with leading zeros on the year, month, and day

  • HHMM is the hours and minutes in UTC time (24 hour format, always 4 characters, with leading zeros on the hours and minutes)

Note: This command is not supported over non-interactive interfaces (for example, NETCONF).

Note: This command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

save

Synopsis Perform configuration save operations
Contextadmin save
Treesave
Introduced16.0.R1

Platforms

All

bof
Synopsis Save the BOF region configuration
Context admin save bof
Treebof

Notes

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

Introduced20.10.R1

Platforms

All

configure
Synopsis Save the configure region configuration
Contextadmin save configure
Treeconfigure

Notes

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

Introduced20.7.R2

Platforms

All

debug
Synopsis Save the debug region configuration
Context admin save debug
Treedebug

Notes

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

Introduced21.5.R1

Platforms

All

li
Synopsis Save the LI region configuration
Context admin save li
Treeli

Notes

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

Introduced19.10.R1

Platforms

All

[url] string
Synopsis Location to save the configuration
Context admin save [url] string
Tree[url]
Introduced16.0.R1

Platforms

All

set

Synopsis Enter the set context
Context admin set
Treeset
Introduced19.10.R1

Platforms

All

time
Synopsis System date and time
Context admin set time
Treetime
Introduced19.10.R1

Platforms

All

[system-time] string
Synopsis System date and time
Context admin set time [system-time] string
Tree[system-time]

Description

This command sets the system date and time. The time zone may optionally be specified. When the time zone is not specified, the system uses the configured system time zone.

Notes

This element is mandatory.

Introduced19.10.R1

Platforms

All

show

Synopsis Enter the show context
Context admin show
Treeshow
Introduced16.0.R1

Platforms

All

configuration
Synopsis Show the current configuration
Context admin show configuration
Treeconfiguration
Introduced16.0.R1

Platforms

All

bof
Synopsis Show the BOF region configuration
Context admin show configuration bof
Treebof

Notes

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

Introduced20.10.R1

Platforms

All

booted
Synopsis Show the booted BOF configuration
Context admin show configuration booted
Treebooted

Notes

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

Introduced20.10.R1

Platforms

All

cflash-id string
Synopsis Show the BOF configuration file on a compact flash
Contextadmin show configuration cflash-id string
Treecflash-id
String Length4 to 6

Notes

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

Introduced20.10.R1

Platforms

All

configure
Synopsis Show the configure region configuration
Contextadmin show configuration configure
Treeconfigure

Notes

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

Introduced20.7.R1

Platforms

All

debug
Synopsis Show the debug region configuration
Context admin show configuration debug
Treedebug

Notes

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

Introduced21.5.R1

Platforms

All

flat
Synopsis Show the context from the pwc on each line
Contextadmin show configuration flat
Treeflat

Notes

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

Introduced20.7.R1

Platforms

All

full-context
Synopsis Show the full context on each line
Context admin show configuration full-context
Treefull-context

Notes

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

Introduced20.7.R1

Platforms

All

intended
Synopsis Show the intended configuration
Context admin show configuration intended
Treeintended

Notes

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

Introduced20.7.R1

Platforms

All

json
Synopsis Show the output in indented JSON format
Contextadmin show configuration json
Treejson

Notes

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

Introduced19.10.R1

Platforms

All

li
Synopsis Show the LI region configuration
Context admin show configuration li
Treeli

Notes

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

Introduced19.10.R1

Platforms

All

running
Synopsis Show the running configuration
Context admin show configuration running
Treerunning

Notes

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

Introduced20.7.R1

Platforms

All

xml
Synopsis Show the output in indented XML format
Contextadmin show configuration xml
Treexml

Notes

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

Introduced20.7.R1

Platforms

All

system

Synopsis Enter the system context
Context admin system
Treesystem
Introduced16.0.R6

Platforms

All

license
Synopsis Enter the license context
Context admin system license
Treelicense
Introduced19.10.R1

Platforms

All

management-interface
Synopsis Enter the management-interface context
Contextadmin system management-interface
Treemanagement-interface
Introduced21.5.R1

Platforms

All

operations
Synopsis Enter the operations context
Context admin system management-interface operations
Treeoperations

Description

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

Introduced21.5.R1

Platforms

All

delete-operation
Synopsis Stop and remove an operation
Context admin system management-interface operations delete-operation
Treedelete-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.

Introduced21.5.R1

Platforms

All

op-table-bypass boolean
Synopsis Avoid operation ID allocation
Context admin system management-interface operations delete-operation op-table-bypass boolean
Treeop-table-bypass

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.

Introduced21.5.R1

Platforms

All

stop-operation
Synopsis Stop the execution of an operational command
Contextadmin system management-interface operations stop-operation
Treestop-operation

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.

Introduced21.5.R1

Platforms

All

op-table-bypass boolean
Synopsis Avoid operation ID allocation
Context admin system management-interface operations stop-operation op-table-bypass boolean
Treeop-table-bypass

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.

Introduced21.5.R1

Platforms

All

security
Synopsis Enter the security context
Context admin system security
Treesecurity
Introduced16.0.R6

Platforms

All

hash-control
Synopsis Enter the hash-control context
Contextadmin system security hash-control
Treehash-control
Introduced16.0.R6

Platforms

All

custom-hash
Synopsis Custom encryption
Context admin system security hash-control custom-hash
Treecustom-hash
Introduced16.0.R6

Platforms

All

algorithm keyword
Synopsis Algorithm for custom encryption
Context admin system security hash-control custom-hash algorithm keyword
Treealgorithm

Description

This command configures the algorithm for custom encryption. The encryption uses ECB mode, PKCS#7 padding, and Base64 encoding.

Options3des, aes128, aes192, aes256

Notes

This element is mandatory.

Introduced16.0.R6

Platforms

All

system-password
Synopsis Change a local system password
Context admin system security system-password
Treesystem-password
Introduced22.10.R2

Platforms

All

telemetry
Synopsis Enter the telemetry context
Context admin system telemetry
Treetelemetry
Introduced19.10.R1

Platforms

All

grpc
Synopsis Enter the grpc context
Context admin system telemetry grpc
Treegrpc
Introduced19.10.R1

Platforms

All

cancel
Synopsis Cancel the gRPC dynamic telemetry subscription
Contextadmin system telemetry grpc cancel
Treecancel
Introduced19.10.R1

Platforms

All

all
Synopsis Cancel gRPC dynamic telemetry for all subscriptions
Contextadmin system telemetry grpc cancel all
Treeall

Notes

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

Introduced19.10.R1

Platforms

All

subscription-id number
Synopsis ID of the telemetry subscription to cancel
Contextadmin system telemetry grpc cancel subscription-id number
Treesubscription-id
Max. Range0 to 4294967295

Notes

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

Introduced19.10.R1

Platforms

All

tech-support

Synopsis Save technical support information to a file
Contextadmin tech-support
Treetech-support
Introduced20.10.R1

Platforms

All

[url] string
Synopsis URL to save technical support information
Contextadmin tech-support [url] string
Tree[url]
String Length1 to 180
Introduced20.10.R1

Platforms

All