tools system

system
+  aaa
   +  authentication
      +  session id number 
         +  disconnect 
+  app-management
   +  application name string 
      +  kill 
      +  quit 
      +  reload 
      +  restart
         +  cold 
         +  warm 
      +  start 
      +  statistics
         +  clear 
      +  stop 
+  boot
+  cgroup
+  configuration
   +  candidate name string 
      +  clear 
   +  checkpoint id (number | checkpoint-name) 
      +  clear 
      +  load 
      +  revert 
   +  confirmed-accept 
   +  confirmed-reject 
   +  generate-checkpoint
      +  comment string
      +  name string
   +  rescue-clear 
   +  rescue-save 
   +  save 
   +  session id number 
      +  clear 
   +  upgrade
      +  checkpoint id (number | checkpoint-name) 
      +  file string
      +  rescue 
      +  startup 
+  dhcp-server
   +  network-instance name string 
      +  dhcpv4
         +  statistics
            +  clear 
      +  dhcpv6
         +  statistics
            +  clear 
+  event-handler
   +  instance name string 
      +  reload 
      +  statistics
         +  clear 
+  l2cp-transparency
   +  dot1x
      +  clear 
   +  l2cp-total-statistics
      +  clear 
   +  lacp
      +  clear 
   +  lldp
      +  clear 
   +  ptp
      +  clear 
   +  xstp
      +  clear 
+  packet-trace-base64
   +  interface string
   +  packet binary
+  sync
+  tls
   +  generate-csr
      +  common-name string
      +  country string
      +  email string
      +  locality string
      +  organization string
      +  organization-unit string
      +  state string
   +  generate-self-signed
      +  common-name string
      +  country string
      +  duration number
      +  email string
      +  locality string
      +  organization string
      +  organization-unit string
      +  state string

system Descriptions

system


	Description	Enclosing container for system management.
	Context	system
	Tree	system
	Configurable	True
	Platforms	Supported on all platforms

aaa


	Description	Top-level container for operational commands related to aaa
	Context	system aaa
	Tree	aaa
	Configurable	True
	Platforms	Supported on all platforms

authentication


	Description	Operational commands related to authentication
	Context	system aaa authentication
	Tree	authentication
	Configurable	True
	Platforms	Supported on all platforms

session id number


	Description	List of active sessions in the system
	Context	system aaa authentication session id number
	Tree	session
	Configurable	True
	Platforms	Supported on all platforms

id number


	Description	System generated session ID
	Context	system aaa authentication session id number
	Configurable	True
	Platforms	Supported on all platforms

disconnect


	Description	Disconnect the cli session, requesting the cli to terminate
	Context	system aaa authentication session id number disconnect
	Tree	disconnect
	Configurable	True
	Platforms	Supported on all platforms

app-management


	Description	Operational commands related to app-management
	Context	system app-management
	Tree	app-management
	Configurable	True
	Platforms	Supported on all platforms

application name string


	Description	List of all applications managed by the application manager
	Context	system app-management application name string
	Tree	application
	Configurable	True
	Platforms	Supported on all platforms

name string


	Description	Unique name of this application instance
	Context	system app-management application name string
	Configurable	True
	Platforms	Supported on all platforms

kill


	Description	Terminate the application instance ungracefully
	Context	system app-management application name string kill
	Tree	kill
	Configurable	True
	Platforms	Supported on all platforms

quit


	Description	Terminate the application instance, requesting it to core dump
	Context	system app-management application name string quit
	Tree	quit
	Configurable	True
	Platforms	Supported on all platforms

reload


	Description	Reload the configuration of the application instance
	Context	system app-management application name string reload
	Tree	reload
	Configurable	True
	Platforms	Supported on all platforms

restart


	Description	Restart the application instance The best restart that is supported by the application is used if neither 'warm' or 'cold' is specified. If 'warm' restart is supported that will be used, or 'cold' if 'warm' is unavailable. A 'warm' restart will result in the application leaving its state in IDB during the restart, and recovering it post restart. This restart type results in less disruption to surrounding applications that would depend on the restarting applications state. A 'cold' restart will result in a normal stop/start of the application, including the purging of its state in IDB.
	Context	system app-management application name string restart
	Tree	restart
	Configurable	True
	Platforms	Supported on all platforms

cold


	Description	Perform a cold restart of the application instance
	Context	system app-management application name string restart cold
	Tree	cold
	Configurable	True
	Platforms	Supported on all platforms

warm


	Description	Perform a warm restart of the application instance
	Context	system app-management application name string restart warm
	Tree	warm
	Configurable	True
	Platforms	Supported on all platforms

start


	Description	Start the application instance
	Context	system app-management application name string start
	Tree	start
	Configurable	True
	Platforms	Supported on all platforms

statistics


	Description	Top-level grouping of operational commands related to application statistics
	Context	system app-management application name string statistics
	Tree	statistics
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Clear statistics for this application instance
	Context	system app-management application name string statistics clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

stop


	Description	Terminate the application instance gracefully
	Context	system app-management application name string stop
	Tree	stop
	Configurable	True
	Platforms	Supported on all platforms

boot


	Description	Top-level container for operational commands related to booting the system
	Context	system boot
	Tree	boot
	Configurable	True
	Platforms	Supported on all platforms

cgroup


	Description	Top-level container for query commands related to cgroup in the system
	Context	system cgroup
	Tree	cgroup
	Configurable	True
	Platforms	Supported on all platforms

configuration


	Description	Top-level container for operational commands related to the system configuration
	Context	system configuration
	Tree	configuration
	Configurable	True
	Platforms	Supported on all platforms

candidate name string


	Description	List of configuration candidates currently active
	Context	system configuration candidate name string
	Tree	candidate
	Configurable	True
	Platforms	Supported on all platforms

name string


	Description	The name of the candidate
	Context	system configuration candidate name string
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Clear the candidate from the system, discarding any changes This results in any users currently in the candidate being dropped back to running mode.
	Context	system configuration candidate name string clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

checkpoint id (number | checkpoint-name)


	Description	List of current checkpoints present in the system
	Context	system configuration checkpoint id (number \| checkpoint-name)
	Tree	checkpoint
	Configurable	True
	Platforms	Supported on all platforms

id (number | checkpoint-name)


	Description	System generated ID, or operator defined name for the checkpoint
	Context	system configuration checkpoint id (number \| checkpoint-name)
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Clear the checkpoint from the system
	Context	system configuration checkpoint id (number \| checkpoint-name) clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

load


	Description	Load candidate from saved checkpoint configuration
	Context	system configuration checkpoint id (number \| checkpoint-name) load
	Tree	load
	Configurable	True
	Platforms	Supported on all platforms

revert


	Description	Revert running system configuration to the saved checkpoint configuration This functions as a load and commit action.
	Context	system configuration checkpoint id (number \| checkpoint-name) revert
	Tree	revert
	Configurable	True
	Platforms	Supported on all platforms

confirmed-accept


	Description	Accepts an in progress commit and stops the confirmation timer
	Context	system configuration confirmed-accept
	Tree	confirmed-accept
	Configurable	True
	Platforms	Supported on all platforms

confirmed-reject


	Description	Rejects an in progress commit and stops the confirmation timer
	Context	system configuration confirmed-reject
	Tree	confirmed-reject
	Configurable	True
	Platforms	Supported on all platforms

generate-checkpoint


	Description	Generate a checkpoint point based on the current running configuration
	Context	system configuration generate-checkpoint
	Tree	generate-checkpoint
	Configurable	True
	Platforms	Supported on all platforms

comment string


	Description	User provided comment to associate with the checkpoint
	Context	system configuration generate-checkpoint comment string
	Tree	comment
	Configurable	True
	Platforms	Supported on all platforms

name string


	Description	User provided name of the checkpoint
	Context	system configuration generate-checkpoint name string
	Tree	name
	Configurable	True
	Platforms	Supported on all platforms

rescue-clear


	Description	Remove rescue configuration
	Context	system configuration rescue-clear
	Tree	rescue-clear
	Configurable	True
	Platforms	Supported on all platforms

rescue-save


	Description	Save current running configuration as rescue configuration - rescue-config.json
	Context	system configuration rescue-save
	Tree	rescue-save
	Configurable	True
	Platforms	Supported on all platforms

save


	Description	Save current running configuration as initial (startup) configuration - config.json
	Context	system configuration save
	Tree	save
	Configurable	True
	Platforms	Supported on all platforms

session id number


	Description	List of configuration sessions currently active
	Context	system configuration session id number
	Tree	session
	Configurable	True
	Platforms	Supported on all platforms

id number


	Description	System generated ID for the configuration session
	Context	system configuration session id number
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Clear the session from the system, discarding any changes
	Context	system configuration session id number clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

upgrade


	Description	Operational commands related to configuration upgrade
	Context	system configuration upgrade
	Tree	upgrade
	Configurable	True
	Platforms	Supported on all platforms

checkpoint id (number | checkpoint-name)


	Description	List of configuration checkpoints
	Context	system configuration upgrade checkpoint id (number \| checkpoint-name)
	Tree	checkpoint
	Configurable	True
	Platforms	Supported on all platforms

id (number | checkpoint-name)


	Description	System generated ID, or operator defined name for the checkpoint
	Context	system configuration upgrade checkpoint id (number \| checkpoint-name)
	Configurable	True
	Platforms	Supported on all platforms

file string


	Description	System file path to a json configuration file
	Context	system configuration upgrade file string
	Tree	file
	Configurable	True
	Platforms	Supported on all platforms

rescue


	Description	Rescue configuration
	Context	system configuration upgrade rescue
	Tree	rescue
	Configurable	True
	Platforms	Supported on all platforms

startup


	Description	Startup (initial) configuration
	Context	system configuration upgrade startup
	Tree	startup
	Configurable	True
	Platforms	Supported on all platforms

dhcp-server


	Description	Enable the dhcp-server context
	Context	system dhcp-server
	Tree	dhcp-server
	Configurable	True
	Platforms	Supported on all platforms

network-instance name string


	Description	List of network instances to run a dhcp server in
	Context	system dhcp-server network-instance name string
	Tree	network-instance
	Configurable	True
	Platforms	Supported on all platforms

name string


	Description	Network Instance
	Context	system dhcp-server network-instance name string
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

dhcpv4


	Description	Enter the dhcpv4 context
	Context	system dhcp-server network-instance name string dhcpv4
	Tree	dhcpv4
	Configurable	True
	Platforms	Supported on all platforms

statistics


	Description	Enter the statistics context
	Context	system dhcp-server network-instance name string dhcpv4 statistics
	Tree	statistics
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Enter the clear context
	Context	system dhcp-server network-instance name string dhcpv4 statistics clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

dhcpv6


	Description	Enter the dhcpv6 context
	Context	system dhcp-server network-instance name string dhcpv6
	Tree	dhcpv6
	Configurable	True
	Platforms	Supported on all platforms

statistics


	Description	Enter the statistics context
	Context	system dhcp-server network-instance name string dhcpv6 statistics
	Tree	statistics
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Enter the clear context
	Context	system dhcp-server network-instance name string dhcpv6 statistics clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

event-handler


	Description	Top-level container for operational commands on event handler and event handling instances
	Context	system event-handler
	Tree	event-handler
	Configurable	True
	Platforms	Supported on all platforms

instance name string


	Description	List of all event handler instances
	Context	system event-handler instance name string
	Tree	instance
	Configurable	True
	Platforms	Supported on all platforms
	Max. Elements	20

name string


	Description	A user-defined name for this event handler instance
	Context	system event-handler instance name string
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

reload


	Description	Reload the Python script for this event handler instance
	Context	system event-handler instance name string reload
	Tree	reload
	Configurable	True
	Platforms	Supported on all platforms

statistics


	Description	Top-level container for operational commands on event handler statistics
	Context	system event-handler instance name string statistics
	Tree	statistics
	Configurable	True
	Platforms	Supported on all platforms

clear


	Description	Clear statistics for this event handler instance
	Context	system event-handler instance name string statistics clear
	Tree	clear
	Configurable	True
	Platforms	Supported on all platforms

l2cp-transparency


	Description	Enable the l2cp-transparency context
	Context	system l2cp-transparency
	Tree	l2cp-transparency
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

dot1x


	Description	Enter the dot1x context
	Context	system l2cp-transparency dot1x
	Tree	dot1x
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the statistics for the 802.1x Port based Network Access Control protocol.
	Context	system l2cp-transparency dot1x clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

l2cp-total-statistics


	Description	Enter the l2cp-total-statistics context
	Context	system l2cp-transparency l2cp-total-statistics
	Tree	l2cp-total-statistics
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the global statistics for the L2CP protocols.
	Context	system l2cp-transparency l2cp-total-statistics clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

lacp


	Description	Enter the lacp context
	Context	system l2cp-transparency lacp
	Tree	lacp
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the statistics for Link Aggregation Control Protocol.
	Context	system l2cp-transparency lacp clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

lldp


	Description	Enter the lldp context
	Context	system l2cp-transparency lldp
	Tree	lldp
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the statistics for Link Layer Discovery Protocol.
	Context	system l2cp-transparency lldp clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

ptp


	Description	Enter the ptp context
	Context	system l2cp-transparency ptp
	Tree	ptp
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the statistics for the Precision Time Protocol .
	Context	system l2cp-transparency ptp clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

xstp


	Description	Enter the xstp context
	Context	system l2cp-transparency xstp
	Tree	xstp
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

clear


	Description	Clears the statistics for all the Spanning Tree Protocols.
	Context	system l2cp-transparency xstp clear
	Tree	clear
	Configurable	True
	Platforms	7220 IXR-D2L, 7220 IXR-D2, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D3

packet-trace-base64


	Description	Tools command to report the forwarding behavior for a specified test packet (packet specified in base64 format)
	Context	system packet-trace-base64
	Tree	packet-trace-base64
	Configurable	True
	Platforms	Supported on all platforms

interface string


	Description	References the configured name of the interface in which to inject the probe packet
	Context	system packet-trace-base64 interface string
	Tree	interface
	Configurable	True
	Platforms	Supported on all platforms

packet binary


	Description	Packet content encoded in base64 string format
	Context	system packet-trace-base64 packet binary
	Tree	packet
	Configurable	True
	Platforms	Supported on all platforms

sync


	Description	Top-level grouping for sync operational commands
	Context	system sync
	Tree	sync
	Configurable	True
	Platforms	Supported on all platforms

tls


	Description	Top-level container for operational commands related to TLS
	Context	system tls
	Tree	tls
	Configurable	True
	Platforms	Supported on all platforms

generate-csr


	Description	Generates a certificate signing request and key pair Fields for the certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination.
	Context	system tls generate-csr
	Tree	generate-csr
	Configurable	True
	Platforms	Supported on all platforms

common-name string


	Description	The common name to use for the certificate signing request By default the common name is set to the system host name and domain name combination.
	Context	system tls generate-csr common-name string
	Tree	common-name
	String Length	1 to 64
	Configurable	True
	Platforms	Supported on all platforms

country string


	Description	The country name to use for the certificate signing request The expected format is two characters long, e.g. 'US'.
	Context	system tls generate-csr country string
	Tree	country
	String Length	2
	Default	US
	Configurable	True
	Platforms	Supported on all platforms

email string


	Description	The email address to use for the certificate signing request
	Context	system tls generate-csr email string
	Tree	email
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

locality string


	Description	The city or locality to use for the certificate signing request
	Context	system tls generate-csr locality string
	Tree	locality
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

organization string


	Description	The organization to use for the certificate signing request
	Context	system tls generate-csr organization string
	Tree	organization
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

organization-unit string


	Description	The organization unit to use for the certificate signing request
	Context	system tls generate-csr organization-unit string
	Tree	organization-unit
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

state string


	Description	The state or province to use for the certificate signing request
	Context	system tls generate-csr state string
	Tree	state
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

generate-self-signed


	Description	Generates a self signed certificate and key pair Fields for the self signed certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination.
	Context	system tls generate-self-signed
	Tree	generate-self-signed
	Configurable	True
	Platforms	Supported on all platforms

common-name string


	Description	The common name to use for the certificate signing request By default the common name is set to the system host name and domain name combination.
	Context	system tls generate-self-signed common-name string
	Tree	common-name
	String Length	1 to 64
	Configurable	True
	Platforms	Supported on all platforms

country string


	Description	The country name to use for the certificate signing request The expected format is two characters long, e.g. 'US'.
	Context	system tls generate-self-signed country string
	Tree	country
	String Length	2
	Default	US
	Configurable	True
	Platforms	Supported on all platforms

duration number


	Description	The time in which the certificate is valid
	Context	system tls generate-self-signed duration number
	Tree	duration
	Range	1 to 3650
	Default	365
	Units	days
	Configurable	True
	Platforms	Supported on all platforms

email string


	Description	The email address to use for the certificate signing request
	Context	system tls generate-self-signed email string
	Tree	email
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

locality string


	Description	The city or locality to use for the certificate signing request
	Context	system tls generate-self-signed locality string
	Tree	locality
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

organization string


	Description	The organization to use for the certificate signing request
	Context	system tls generate-self-signed organization string
	Tree	organization
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

organization-unit string


	Description	The organization unit to use for the certificate signing request
	Context	system tls generate-self-signed organization-unit string
	Tree	organization-unit
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms

state string


	Description	The state or province to use for the certificate signing request
	Context	system tls generate-self-signed state string
	Tree	state
	String Length	1 to 255
	Configurable	True
	Platforms	Supported on all platforms