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 Reference 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.
- 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.
- Pay-as-You-Grow Licensing Reference Guide
- YANG Browser

test-oam commands

configure 
   —  test-oam 
      —  apply-groups reference
      —  apply-groups-exclude reference
      —  icmp 
         —  ipv6 
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  length-field boolean
            —  maximum-original-datagram boolean
      —  mpls 
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  echo-request-downstream-map keyword
         —  timestamp-format keyword
      —  twamp 
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  server 
            —  admin-state keyword
            —  allow-ipv6-udp-checksum-zero boolean
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  enforce-test-session-start-time boolean
            —  inactivity-timeout number
            —  max-connections number
            —  max-sessions number
            —  prefix (ipv4-prefix | ipv6-prefix) 
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  description description
               —  max-connections number
               —  max-sessions number
         —  twamp-light 
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  inactivity-timeout number

test-oam command descriptions

test-oam


	Synopsis	Enter the test-oam context
	Context	configure test-oam
	Tree	test-oam
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

icmp


	Synopsis	Enter the icmp context
	Context	configure test-oam icmp
	Tree	icmp
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

ipv6


	Synopsis	Enter the ipv6 context
	Context	configure test-oam icmp ipv6
	Tree	ipv6
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

length-field boolean


	Synopsis	Use length field in ICMPv6 responses
	Context	configure test-oam icmp ipv6 length-field boolean
	Tree	length-field
	Default	false
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

maximum-original-datagram boolean


	Synopsis	ICMPv6 traceroute responses with largest datagram
	Context	configure test-oam icmp ipv6 maximum-original-datagram boolean
	Tree	maximum-original-datagram
	Description	When configured to true, this command enables the original datagram field of the ICMPv6 error message to be a maximum of 1232 bytes. When configured to false, the original datagram field of the ICMPv6 error message smaller than 1232 bytes be built smaller.
	Default	false
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

mpls


	Synopsis	Enter the mpls context
	Context	configure test-oam mpls
	Tree	mpls
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

echo-request-downstream-map keyword


	Synopsis	Format of the downstream mapping TLV
	Context	configure test-oam mpls echo-request-downstream-map keyword
	Tree	echo-request-downstream-map
	Description	This command specifies the format of the downstream mapping TLV to use in all LSP trace packets and LDP tree trace packets originated on this node. The following downstream mapping TLVs are supported: the original Downstream Mapping (DSMAP) TLV, defined in RFC 4379 (obsoleted by RFC 8029) and the Downstream Detailed Mapping (DDMAP) TLV, defined in RFC 6424. See the "DDMAP TLV" section in the 7705 SAR Gen 2 OAM and Diagnostics Guide for more information.
	Options	dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV
	Default	dsmap
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

timestamp-format keyword


	Synopsis	Timestamp format for MPLS ping request and reply PDUs
	Context	configure test-oam mpls timestamp-format keyword
	Tree	timestamp-format
	Options	rfc4379 – 1900-based timestamp (standard) unix – 1970-based timestamp
	Default	unix
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

twamp


	Synopsis	Enter the twamp context
	Context	configure test-oam twamp
	Tree	twamp
	Description	Commands in this context configure the TWAMP functionality.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

server


	Synopsis	Enter the server context
	Context	configure test-oam twamp server
	Tree	server
	Description	Commands in this context configure the node for TWAMP server functionality.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

admin-state keyword


	Synopsis	Administrative state of the TWAMP server
	Context	configure test-oam twamp server admin-state keyword
	Tree	admin-state
	Options	enable, disable
	Default	disable
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

allow-ipv6-udp-checksum-zero boolean


	Synopsis	Process IPv6 packets with a zero UDP checksum
	Context	configure test-oam twamp server allow-ipv6-udp-checksum-zero boolean
	Tree	allow-ipv6-udp-checksum-zero
	Description	When configured to true, the router accepts IPv6 packets with UDP checksums of 0. This optional configuration allows the router to process arriving IPv6 TWAMP Test packets that contain IPv6 UDP checksum of 0x0000. The UDP port specific to this TWAMP Light test bypasses the default discard IPv6 UDP checksum 0x0000. If this optional command is not configured, IPv6 UDP checksum 0x000 arriving packets are discarded. When configured to false, the router discards packets that arrive with an IPv6 UDP checksum of 0x0000.
	Default	false
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

enforce-test-session-start-time boolean


	Synopsis	Discard TWAMP packets before test-session start time
	Context	configure test-oam twamp server enforce-test-session-start-time boolean
	Tree	enforce-test-session-start-time
	Description	When configured to true, the router checks the signalled test-session start time against the server time and discards TWAMP test packets that arrive before the negotiated test-session start time. When configured to false, the router processes all TWAMP test packets without checking the test-session start time against the server time.
	Default	true
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

inactivity-timeout number


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Inactivity time-out for TWAMP control connections
	Context	configure test-oam twamp server inactivity-timeout number
	Tree	inactivity-timeout
	Description	This command configures the inactivity time-out for all TWAMP-control connections. If no TWAMP control message is exchanged over the TCP connection for this duration of time the connection is closed and all in-progress tests are terminated.
	Range	60 to 3600
	Units	seconds
	Default	900
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

max-connections number


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	TWAMP server control connections limit
	Context	configure test-oam twamp server max-connections number
	Tree	max-connections
	Description	This command configures the maximum number of TWAMP control connections from all TWAMP clients. The system rejects a new control connection if accepting it causes either this limit or a prefix limit (prefix max-connections) to be exceeded.
	Range	0 to 64
	Default	32
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

max-sessions number


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Maximum number of concurrent TWAMP server test sessions
	Context	configure test-oam twamp server max-sessions number
	Tree	max-sessions
	Description	This command configures the maximum number of concurrent TWAMP-Test sessions across all allowed clients. The system rejects a new test session (described by a Request-TW-Session message) if accepting it causes either the limit defined by this command or a prefix limit (prefix max-sessions) to be exceeded.
	Range	0 to 128
	Default	32
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

prefix [ip-prefix] (ipv4-prefix | ipv6-prefix)


	Synopsis	Enter the prefix list instance
	Context	configure test-oam twamp server prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Description	Commands in this context configure an IP address prefix containing one or more TWAMP clients. For a TWAMP client to connect to the TWAMP server (and subsequently conduct tests) it must establish the control connection using an IP address that is part of a configured prefix.
	Max. instances	100
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

[ip-prefix] (ipv4-prefix | ipv6-prefix)


	Synopsis	Prefix to match against TWAMP client address
	Context	configure test-oam twamp server prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is part of a list key.
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

description description


	Synopsis	Text description
	Context	configure test-oam twamp server prefix (ipv4-prefix \| ipv6-prefix) description description
	Tree	description
	String length	1 to 80
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

max-connections number


	Synopsis	Maximum number of control connections for TWAMP prefix
	Context	configure test-oam twamp server prefix (ipv4-prefix \| ipv6-prefix) max-connections number
	Tree	max-connections
	Description	This command configures the maximum number of control connections by clients with an IP address in a specific prefix. The system rejects a new control connection if accepting it causes either the prefix limit defined by this command or the server limit (server max-connections) to be exceeded.
	Range	0 to 64
	Default	32
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

max-sessions number


	Synopsis	Maximum concurrent TWAMP test sessions based on prefix
	Context	configure test-oam twamp server prefix (ipv4-prefix \| ipv6-prefix) max-sessions number
	Tree	max-sessions
	Description	This command configures the maximum number of concurrent TWAMP-Test sessions by clients with an IP address in a specific prefix. The system rejects a new test session (described by a Request-TW-Session message) if accepting it causes either the limit defined by this command or the server limit (server max-sessions) to be exceeded.
	Range	0 to 128
	Default	32
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

twamp-light


	Synopsis	Enter the twamp-light context
	Context	configure test-oam twamp twamp-light
	Tree	twamp-light
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

inactivity-timeout number


	Synopsis	Time to maintain stale state on the session reflector
	Context	configure test-oam twamp twamp-light inactivity-timeout number
	Tree	inactivity-timeout
	Range	10 to 100
	Units	seconds
	Default	100
	Introduced	25.3.R2
	Platforms	7705 SAR Gen 2

March 12, 2026