admin commands

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 
      —  telemetry 
         —  grpc 
            —  cancel 
               —  all 
               —  subscription-id number
   —  tech-support 
      —  [url] string
Parent topic: Operational commands

admin command descriptions

admin

  Synopsis Enter the administrative context for system operations
  Context admin
  Tree admin
  Introduced 16.0.R1
 

Platforms

All

application-assurance

  Synopsis Enter the application-assurance context
  Context admin application-assurance
  Tree application-assurance
 

Description

Commands in this context configure Application Assurance (AA) upgrade and AA group upgrade operations.
  Introduced 21.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
  Tree group
 

Description

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

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
[aa-group-id] reference
  Synopsis AA group ID
  Context admin application-assurance group reference
 

Reference

state application-assurance group [aa-group-id] number
 

Notes

This element is part of a list key.
  Introduced 21.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
  Context admin application-assurance group reference url-list reference
  Tree url-list
 

Description

Commands in this context configure the URL list upgrade parameters.
  Introduced 21.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
 

Reference

state application-assurance group url-list [url-list-name] string
 

Notes

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

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
upgrade
  Synopsis Upgrade the referenced URL list
  Context admin application-assurance group reference url-list reference upgrade
  Tree upgrade
  Introduced 21.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
  Tree upgrade
 

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

Platforms

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

clear

  Synopsis Enter the clear context
  Context admin clear
  Tree clear
  Introduced 19.10.R1
 

Platforms

All
security
  Synopsis Enter the security context
  Context admin clear security
  Tree security
  Introduced 19.10.R1
 

Platforms

All
lockout
  Synopsis Reset the lockout timer
  Context admin clear security lockout
  Tree lockout
  Introduced 19.10.R1
 

Platforms

All
all
  Synopsis Clear lockout of all users
  Context admin clear security lockout all
  Tree all
 

Notes

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

Platforms

All
user string
  Synopsis User to be cleared of lockout
  Context admin clear security lockout user string
  Tree user
  String Length 1 to 32
 

Notes

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

Platforms

All
password-history
  Synopsis Clear the password history
  Context admin clear security password-history
  Tree password-history
  Introduced 19.10.R1
 

Platforms

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

Notes

The following elements 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
  Context admin clear security password-history user string
  Tree user
  String Length 1 to 32
 

Notes

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

Platforms

All

disconnect

  Synopsis Disconnect a user session
  Context admin disconnect
  Tree disconnect
  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 address
  Introduced 19.10.R1
 

Platforms

All
op-table-bypass boolean
  Synopsis Avoid operation ID allocation
  Context admin disconnect op-table-bypass boolean
  Tree op-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.
  Introduced 21.5.R1
 

Platforms

All
session-id number
  Synopsis ID of the session to disconnect
  Context admin disconnect session-id number
  Tree session-id
  Range 1 to 4294967295
  Introduced 16.0.R1
 

Platforms

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

Platforms

All
username string
  Synopsis Username to disconnect
  Context admin disconnect username string
  Tree username
  String Length 1 to 32
  Introduced 19.10.R1
 

Platforms

All

nat

  Synopsis Enter the nat context
  Context admin nat
  Tree nat
  Introduced 21.2.R1
 

Platforms

All
save-deterministic-script
  Synopsis Save script that computes deterministic NAT map entries
  Context admin nat save-deterministic-script
  Tree save-deterministic-script
  Introduced 21.2.R1
 

Platforms

All

reboot

  Synopsis Reboot CPM or force an upgrade of system boot ROMs
  Context admin reboot
  Tree reboot
  Introduced 16.0.R1
 

Platforms

All
[card] keyword
  Synopsis Card to reboot
  Context admin reboot [card] keyword
  Tree [card]
  Options active, standby, upgrade
  Introduced 16.0.R1
 

Platforms

All
hold
  Synopsis Hold a rebooted standby CPM from coming back online
  Context admin reboot hold
  Tree hold
  Introduced 19.10.R1
 

Platforms

7750 SR-7s, 7750 SR-14s, VSR
now
  Synopsis Reboot immediately without prompts or confirmation
  Context admin reboot now
  Tree now
  Introduced 16.0.R1
 

Platforms

All

redundancy

  Synopsis Enter the redundancy context
  Context admin redundancy
  Tree redundancy
  Introduced 16.0.R1
 

Platforms

All
force-switchover
  Synopsis Force a switchover to the standby CPM
  Context admin redundancy force-switchover
  Tree force-switchover
  Introduced 16.0.R1
 

Platforms

All
ignore-status
  Synopsis Switch to the standby CPM regardless of its status
  Context admin redundancy force-switchover ignore-status
  Tree ignore-status
  Introduced 19.10.R1
 

Platforms

7950 XRS
now
  Synopsis Force the switchover to the standby CPM immediately
  Context admin redundancy force-switchover now
  Tree now
  Introduced 16.0.R1
 

Platforms

All
synchronize
  Synopsis Synchronize the standby CPM
  Context admin redundancy synchronize
  Tree synchronize
  Introduced 20.10.R1
 

Platforms

All
boot-environment
  Synopsis Synchronize files used in system initialization
  Context admin redundancy synchronize boot-environment
  Tree boot-environment
 

Notes

The following elements are part of a mandatory choice: boot-environment or configuration.
  Introduced 20.10.R1
 

Platforms

All
configuration
  Synopsis Synchronize the configuration files only
  Context admin redundancy synchronize configuration
  Tree configuration
 

Notes

The following elements are part of a mandatory choice: boot-environment or configuration.
  Introduced 20.10.R1
 

Platforms

All

satellite

  Synopsis Perform administrative operations for satellites
  Context admin satellite
  Tree satellite
  Introduced 22.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
  Context admin satellite ethernet-satellite reference
  Tree ethernet-satellite
  Introduced 22.2.R1
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
[satellite-id] reference
  Synopsis Satellite ID
  Context admin satellite ethernet-satellite reference
 

Reference

state satellite ethernet-satellite [satellite-id] number
 

Notes

This element is part of a list key.
  Introduced 22.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
  Context admin satellite ethernet-satellite reference reboot
  Tree reboot
  Introduced 22.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
  Context admin satellite ethernet-satellite reference reboot now
  Tree now
  Introduced 22.2.R1
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
upgrade
  Synopsis Initiate a firmware image update during the reboot
  Context admin satellite ethernet-satellite reference reboot upgrade
  Tree upgrade
  Introduced 22.2.R1
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
synchronize
  Synopsis Synchronize the chassis to the boot image
  Context admin satellite ethernet-satellite reference synchronize
  Tree synchronize
  Introduced 22.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
  Context admin satellite ethernet-satellite reference tech-support
  Tree tech-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).
  Introduced 22.2.R1
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
[url] string
  Synopsis URL to save technical support information
  Context admin satellite ethernet-satellite reference tech-support [url] string
  Tree [url]
  String Length 1 to 180
  Introduced 22.2.R1
 

Platforms

All

save

  Synopsis Perform configuration save operations
  Context admin save
  Tree save
  Introduced 16.0.R1
 

Platforms

All
bof
  Synopsis Save the BOF region configuration
  Context admin save bof
  Tree bof
 

Notes

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

Platforms

All
configure
  Synopsis Save the configure region configuration
  Context admin save configure
  Tree configure
 

Notes

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

Platforms

All
debug
  Synopsis Save the debug region configuration
  Context admin save debug
  Tree debug
 

Notes

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

Platforms

All
li
  Synopsis Save the LI region configuration
  Context admin save li
  Tree li
 

Notes

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

Platforms

All
[url] string
  Synopsis Location to save the configuration
  Context admin save [url] string
  Tree [url]
  Introduced 16.0.R1
 

Platforms

All

set

  Synopsis Enter the set context
  Context admin set
  Tree set
  Introduced 19.10.R1
 

Platforms

All
time
  Synopsis System date and time
  Context admin set time
  Tree time
  Introduced 19.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.
  Introduced 19.0.R1
 

Platforms

All

show

  Synopsis Enter the show context
  Context admin show
  Tree show
  Introduced 16.0.R1
 

Platforms

All
configuration
  Synopsis Show the current configuration
  Context admin show configuration
  Tree configuration
  Introduced 16.0.R1
 

Platforms

All
bof
  Synopsis Show the BOF region configuration
  Context admin show configuration bof
  Tree bof
 

Notes

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

Platforms

All
booted
  Synopsis Show the booted BOF configuration
  Context admin show configuration booted
  Tree booted
 

Notes

The following elements 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
  Context admin show configuration cflash-id string
  Tree cflash-id
  String Length 4 to 6
 

Notes

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

Platforms

All
[cli-path] string
  Synopsis Absolute path or relative path from '/'
  Context admin show configuration [cli-path] string
  Tree [cli-path]
  Introduced 21.10.R1
 

Platforms

All
configure
  Synopsis Show the configure region configuration
  Context admin show configuration configure
  Tree configure
 

Notes

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

Platforms

All
debug
  Synopsis Show the debug region configuration
  Context admin show configuration debug
  Tree debug
 

Notes

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

Platforms

All
detail
  Synopsis Include default and unconfigured values
  Context admin show configuration detail
  Tree detail
  Introduced 20.7.R1
 

Platforms

All
flat
  Synopsis Show the context from the pwc on each line
  Context admin show configuration flat
  Tree flat
 

Notes

The following elements 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
  Context admin show configuration full-context
  Tree full-context
 

Notes

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

Platforms

All
intended
  Synopsis Show the intended configuration
  Context admin show configuration intended
  Tree intended
 

Notes

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

Platforms

All
json
  Synopsis Show the output in indented JSON format
  Context admin show configuration json
  Tree json
 

Notes

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

Platforms

All
li
  Synopsis Show the LI region configuration
  Context admin show configuration li
  Tree li
 

Notes

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

Platforms

All
running
  Synopsis Show the running configuration
  Context admin show configuration running
  Tree running
 

Notes

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

Platforms

All
units
  Synopsis Include unit types for applicable elements
  Context admin show configuration units
  Tree units
  Introduced 20.10.R1
 

Platforms

All
xml
  Synopsis Show the output in indented XML format
  Context admin show configuration xml
  Tree xml
 

Notes

The following elements 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
  Context admin support-mode
  Tree support-mode
  Introduced 16.0.R4
 

Platforms

All

system

  Synopsis Enter the system context
  Context admin system
  Tree system
  Introduced 16.0.R6
 

Platforms

All
license
  Synopsis Enter the license context
  Context admin system license
  Tree license
  Introduced 19.10.R1
 

Platforms

All
activate
  Synopsis Load and activate a system license
  Context admin system license activate
  Tree activate
  Introduced 19.10.R1
 

Platforms

All
[file-url] string
  Synopsis Location of the license file to activate
  Context admin system license activate [file-url] string
  Tree [file-url]
  String Length 1 to 256
  Introduced 19.10.R1
 

Platforms

All
now
  Synopsis Activate the license immediately
  Context admin system license activate now
  Tree now
  Introduced 19.10.R1
 

Platforms

All
validate
  Synopsis Load and validate a system license
  Context admin system license validate
  Tree validate
  Introduced 19.10.R1
 

Platforms

All
[file-url] string
  Synopsis Location of the license file to validate
  Context admin system license validate [file-url] string
  Tree [file-url]
  String Length 1 to 256
  Introduced 19.10.R1
 

Platforms

All
management-interface
  Synopsis Enter the management-interface context
  Context admin system management-interface
  Tree management-interface
  Introduced 21.5.R1
 

Platforms

All
operations
  Synopsis Enter the operations context
  Context admin system management-interface operations
  Tree operations
 

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
  Context admin system management-interface operations delete-operation
  Tree delete-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
  Context admin system management-interface operations delete-operation [delete-id] number
  Tree [delete-id]
  Range 1 to 10000
 

Notes

This element is mandatory.
  Introduced 22.2.R1
 

Platforms

All
op-table-bypass boolean
  Synopsis Avoid operation ID allocation
  Context admin system management-interface operations delete-operation op-table-bypass boolean
  Tree op-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.
  Introduced 21.5.R1
 

Platforms

All
stop-operation
  Synopsis Stop the execution of an operational command
  Context admin system management-interface operations stop-operation
  Tree stop-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.
  Introduced 21.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
  Tree op-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.
  Introduced 21.5.R1
 

Platforms

All
[stop-id] number
  Synopsis ID of the operation to stop
  Context admin system management-interface operations stop-operation [stop-id] number
  Tree [stop-id]
  Range 1 to 10000
 

Notes

This element is mandatory.
  Introduced 22.2.R1
 

Platforms

All
security
  Synopsis Enter the security context
  Context admin system security
  Tree security
  Introduced 16.0.R6
 

Platforms

All
hash-control
  Synopsis Enter the hash-control context
  Context admin system security hash-control
  Tree hash-control
  Introduced 16.0.R6
 

Platforms

All
custom-hash
  Synopsis Custom encryption
  Context admin system security hash-control custom-hash
  Tree custom-hash
  Introduced 16.0.R6
 

Platforms

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

Description

This command configures the algorithm for custom encryption. The encryption uses ECB mode, PKCS#7 padding, and Base64 encoding.
  Options 3des, aes128, aes192, aes256
 

Notes

This element is mandatory.
  Introduced 16.0.R6
 

Platforms

All
key string
  Synopsis Key for encryption algorithm
  Context admin system security hash-control custom-hash key string
  Tree key
  String Length 1 to 71
 

Notes

This element is mandatory.
  Introduced 16.0.R6
 

Platforms

All
remove-custom-hash
  Synopsis Remove the custom encryption
  Context admin system security hash-control remove-custom-hash
  Tree remove-custom-hash
  Introduced 20.10.R1
 

Platforms

All
telemetry
  Synopsis Enter the telemetry context
  Context admin system telemetry
  Tree telemetry
  Introduced 19.10.R1
 

Platforms

All
grpc
  Synopsis Enter the grpc context
  Context admin system telemetry grpc
  Tree grpc
  Introduced 19.10.R1
 

Platforms

All
cancel
  Synopsis Cancel the gRPC dynamic telemetry subscription
  Context admin system telemetry grpc cancel
  Tree cancel
  Introduced 19.10.R1
 

Platforms

All
all
  Synopsis Cancel gRPC dynamic telemetry for all subscriptions
  Context admin system telemetry grpc cancel all
  Tree all
 

Notes

The following elements 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
  Context admin system telemetry grpc cancel subscription-id number
  Tree subscription-id
  Max. Range 0 to 4294967295
 

Notes

The following elements 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
  Context admin tech-support
  Tree tech-support
  Introduced 20.10.R1
 

Platforms

All
[url] string
  Synopsis URL to save technical support information
  Context admin tech-support [url] string
  Tree [url]
  String Length 1 to 180
  Introduced 20.10.R1
 

Platforms

All