Reference
Documents under this category include information about the attributes, APIs, and the full set of CLI commands (MD-CLI and classic) supported by SR OS.
- Acronyms Guide
  This guide provides expansions of acronyms found in the user guides.
- Classic CLI Command Reference Guide
  This guide describes all classic CLI commands (except for the clear, monitor, show, and tools commands) and their supported values and parameters.
- Clear, Monitor, Show, and Tools CLI Command Reference Guide
  This guide describes all clear, monitor, show, and tools CLI commands and their supported values and parameters.
- Gx AVPs Reference Guide
  This guide describes Gx Attribute Value Pairs (AVPs).
- Gy AVPs Reference Guide
  This guide describes Gy Attribute Value Pairs (AVPs).
- MD-CLI Command Reference Guide
  This guide describes all MD-CLI commands (except for the clear, monitor, show, and tools commands) and their supported values and parameters.
- MD-CLI Explorer Tool
- MD-CLI Quick Reference Guide
  This guide provides a comparison of the Nokia SR OS Model-Driven Command Line Interface (MD-CLI) with those used by Junos OS and IOS XR.
- NISH Installation and User Guide
  This guide describes the Nokia Network Interface Shell (NISH) system architecture, functional overview, features, and how to install and set up the NISH.
- Pay-as-you-Grow Licensing Guide
- pySROS API
- RADIUS Guide
  This guide describes all supported RADIUS authentication, authorization, and accounting attributes.
- SR BNG TPSDA Python 3 API
  Python developers can use these APIs for a model-driven management interface to integrate with supported Nokia routers running the SR OS.

esa commands

configure 
   —  esa number 
      —  admin-state keyword
      —  apply-groups reference
      —  apply-groups-exclude reference
      —  description description
      —  host-port port 
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  crc-monitor 
            —  signal-degrade 
               —  multiplier number
               —  threshold number
            —  signal-failure 
               —  multiplier number
               —  threshold number
            —  window-size number
      —  vm number 
         —  admin-state keyword
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  cores number
         —  description description
         —  host-port reference
         —  memory number
         —  vm-type keyword

esa command descriptions

esa [esa-id] number


	Synopsis	Enter the esa list instance
	Context	configure esa number
	Tree	esa
	Description	Commands in this context configure the Extended Services Appliance (ESA) instance.
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

[esa-id] number


	Synopsis	ESA ID
	Context	configure esa number
	Tree	esa
	Range	1 to 16
	Notes	This element is part of a list key.
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

admin-state keyword


	Synopsis	Administrative state of the ESA
	Context	configure esa number admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	disable
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

description description


	Synopsis	Text description
	Context	configure esa number description description
	Tree	description
	String length	1 to 80
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

host-port [host-port] port


	Synopsis	Enter the host-port list instance
	Context	configure esa number host-port port
	Tree	host-port
	Max. instances	4
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

[host-port] port


	Synopsis	Ethernet port associated with the ESA
	Context	configure esa number host-port port
	Tree	host-port
	Description	This command configures an Ethernet port associated with the ESA-VM instance. The port ID must be the same as the port ID associated with the ESA context on which the ESA-VM is configured.
	Notes	This element is part of a list key.
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

crc-monitor


	Synopsis	Enter the crc-monitor context
	Context	configure esa number host-port port crc-monitor
	Tree	crc-monitor
	Description	Commands in this context configure ESA cyclic redundancy check (CRC) monitoring.
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

signal-degrade


	Synopsis	Enter the signal-degrade context
	Context	configure esa number host-port port crc-monitor signal-degrade
	Tree	signal-degrade
	Description	Commands in this context configure the error rate at which to declare the signal degrade (SD) condition on an Ethernet interface. The value represents M10E-N, a ratio of errored frames over total frames received over W seconds of the sliding window. The CRC errors on the interface are sampled once per second. A default of 10 seconds is used when no additional window-size* is configured. If you omit the multiplier value, the multiplier returns to the default value of 1. Note: Crossing the configured SD threshold raises a log event.
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

multiplier number


	Synopsis	SD multiplier
	Context	configure esa number host-port port crc-monitor signal-degrade multiplier number
	Tree	multiplier
	Max. range	0 to 4294967295
	Default	1
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

threshold number


	Synopsis	SD threshold
	Context	configure esa number host-port port crc-monitor signal-degrade threshold number
	Tree	threshold
	Range	1 to 9
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

signal-failure


	Synopsis	Enter the signal-failure context
	Context	configure esa number host-port port crc-monitor signal-failure
	Tree	signal-failure
	Description	Commands in this context configure the error rate at which to declare the signal failure (SF) condition on an Ethernet interface. The value represents M10E-N, errored frames over total frames received over W seconds of the sliding window. The CRC errors on the interface are sampled once per second. A default of 10 seconds is used when no additional window-size* is configured. If you omit the multiplier value, the multiplier returns to the default value of 1. Note: Crossing the configured signal failure (SF) threshold causes the router ESA port to enter an operational state of down when the router side detects the SF, or the port is shut down when the ESA detects the SF, which triggers redundancy for all configured ISA groups.
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

multiplier number


	Synopsis	SF multiplier
	Context	configure esa number host-port port crc-monitor signal-failure multiplier number
	Tree	multiplier
	Max. range	0 to 4294967295
	Default	1
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

threshold number


	Synopsis	SF threshold
	Context	configure esa number host-port port crc-monitor signal-failure threshold number
	Tree	threshold
	Range	1 to 9
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

window-size number


	Synopsis	Window size of the monitor
	Context	configure esa number host-port port crc-monitor window-size number
	Tree	window-size
	Range	10 to 60
	Units	seconds
	Default	10
	Introduced	24.10.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

vm [vm-id] number


	Synopsis	Enter the vm list instance
	Context	configure esa number vm number
	Tree	vm
	Description	Commands in this context configure the ESA-VM instance.
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

[vm-id] number


	Synopsis	VM ID
	Context	configure esa number vm number
	Tree	vm
	Range	1 to 4
	Notes	This element is part of a list key.
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

admin-state keyword


	Synopsis	Administrative state of the ESA-VM instance
	Context	configure esa number vm number admin-state keyword
	Tree	admin-state
	Description	This command configures the administrative state of the ESA-VM instance. The state affects the operational state of the instance and all entities contained within the instance; however, configuration settings or statistics are not changed, reset, or removed.
	Options	enable, disable
	Default	disable
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

cores number


Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Number of CPU physical cores allocated to the ESA-VM
	Context	configure esa number vm number cores number
	Tree	cores
	Description	This command specifies the number of CPU physical cores allocated to the ESA-VM instance. If an invalid value is configured for the number of cores, the VM remains in a failed state.
	Range	0 to 128
	Default	0
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

description description


	Synopsis	Text description
	Context	configure esa number vm number description description
	Tree	description
	String length	1 to 80
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

host-port reference


Warning: Modifying this element recreates the parent element automatically for the new value to take effect.
	Synopsis	Ethernet port associated with the ESA-VM instance
	Context	configure esa number vm number host-port reference
	Tree	host-port
	Description	This command configures an Ethernet port associated with the ESA-VM instance. The port ID must be the same as the port ID associated with the ESA context on which the ESA-VM is configured.
	Reference	configure esa number host-port port
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

memory number


Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Amount of memory allocated to the ESA-VM
	Context	configure esa number vm number memory number
	Tree	memory
	Range	0 to 256
	Units	gigabytes
	Default	0
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

vm-type keyword


Warning: Modifying this element recreates the parent element automatically for the new value to take effect.
	Synopsis	ESA-VM type
	Context	configure esa number vm number vm-type keyword
	Tree	vm-type
	Options	aa, bb, tunnel, video, dms
	Introduced	20.5.R1
	Platforms	7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

November 1, 2024