saa commands

configure 
   —  saa 
      —  apply-groups reference
      —  apply-groups-exclude reference
      —  owner string test string 
         —  accounting-policy reference
         —  admin-state keyword
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  continuous boolean
         —  description string
         —  jitter-event keyword threshold-type keyword 
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  threshold number
         —  latency-event keyword threshold-type keyword 
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  threshold number
         —  loss-event keyword threshold-type keyword 
            —  apply-groups reference
            —  apply-groups-exclude reference
            —  threshold number
         —  probe-history keyword
         —  type 
            —  dns 
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  count number
               —  interval number
               —  name-server (ipv4-address-no-zone | ipv6-address-no-zone)
               —  record-type keyword
               —  router-instance string
               —  source-address (ipv4-address-no-zone | ipv6-address-no-zone)
               —  target-address string
               —  timeout number
               —  trap-generation 
                  —  probe-fail boolean
                  —  probe-fail-threshold number
                  —  test-complete boolean
                  —  test-fail boolean
                  —  test-fail-threshold number
            —  icmp-ping 
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  bypass-routing boolean
               —  count number
               —  destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
               —  do-not-fragment boolean
               —  interface string
               —  interval (number | decimal-number)
               —  next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
               —  pattern (keyword | number)
               —  qos 
                  —  fc keyword
                  —  tos number
               —  router-instance string
               —  size number
               —  source-address (ipv4-address-no-zone | ipv6-address-no-zone)
               —  timeout number
               —  trap-generation 
                  —  probe-fail boolean
                  —  probe-fail-threshold number
                  —  test-complete boolean
                  —  test-fail boolean
                  —  test-fail-threshold number
               —  ttl number
            —  lsp-ping 
               —  apply-groups reference
               —  apply-groups-exclude reference
               —  interval number
               —  qos 
                  —  fc keyword
                  —  profile keyword
               —  send-count number
               —  size number
               —  source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
               —  sub-type 
                  —  bgp-label 
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  prefix (ipv4-prefix | ipv6-prefix)
                  —  ldp 
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  prefix (ipv4-prefix | ipv6-prefix)
                  —  rsvp-te 
                     —  lsp-name string
                     —  path string
                  —  sr-isis 
                     —  igp-instance number
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  prefix (ipv4-prefix | ipv6-prefix)
                  —  sr-ospf 
                     —  igp-instance number
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  prefix (ipv4-prefix | ipv6-prefix)
                  —  sr-ospf3 
                     —  igp-instance number
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  prefix (ipv4-prefix | ipv6-prefix)
                  —  sr-policy 
                     —  color number
                     —  endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
                     —  segment-list number
                  —  sr-te 
                     —  lsp-name string
                     —  path string
                     —  path-destination 
                        —  interface string
                        —  ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
                        —  next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
               —  timeout number
               —  trap-generation 
                  —  probe-fail boolean
                  —  probe-fail-threshold number
                  —  test-complete boolean
                  —  test-fail boolean
                  —  test-fail-threshold number
               —  ttl number

saa command descriptions

saa


	Synopsis	Enter the saa context
	Context	configure saa
	Tree	saa
	Description	Commands in this context configure the Service Assurance Agent (SAA) tests.
	Introduced	16.0.R4
	Platforms	All

owner [owner-name] string test string


	Synopsis	Enter the owner list instance
	Context	configure saa owner string test string
	Tree	owner
	Introduced	16.0.R4
	Platforms	All

[owner-name] string


	Synopsis	Optional owner name of the SAA operation
	Context	configure saa owner string test string
	Tree	owner
	Description	This command configures the owner associated with the SAA operation. The owner is optional and "TiMOS CLI" is used if an owner is not specified.
	String Length	1 to 32
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

test string


	Synopsis	SAA test name
	Context	configure saa owner string test string
	Tree	owner
	String Length	1 to 32
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

accounting-policy reference


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Accounting policy associated with the SAA test
	Context	configure saa owner string test string accounting-policy reference
	Tree	accounting-policy
	Reference	configure log accounting-policy number
	Introduced	16.0.R4
	Platforms	All

admin-state keyword


	Synopsis	Administrative state of the SAA test
	Context	configure saa owner string test string admin-state keyword
	Tree	admin-state
	Default	disable
	Options	enable, disable
	Introduced	16.0.R4
	Platforms	All

continuous boolean


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	Execute the SAA tests as continuous
	Context	configure saa owner string test string continuous boolean
	Tree	continuous
	Description	When configured to true, the SAA test execution is continuous, that is, it cannot be started or stopped with the oam saa test start or stop commands. The SAA test types supported by this command include the following: cpe-ping dns eth-cfm-loopback eth-cfm-two-way-delay eth-cfm-two-way-slm icmp-ping (not applicable to rapid type) lsp-ping mac-ping sdp-ping vccv-ping vprn-ping
	Default	false
	Introduced	16.0.R4
	Platforms	All

description string


	Synopsis	Text description
	Context	configure saa owner string test string description string
	Tree	description
	String Length	1 to 80
	Introduced	16.0.R4
	Platforms	All

jitter-event [direction] keyword threshold-type keyword


	Synopsis	Enter the jitter-event list instance
	Context	configure saa owner string test string jitter-event keyword threshold-type keyword
	Tree	jitter-event
	Description	Commands in this context configure the jitter event thresholds used to evaluate the jitter event value at the termination of an SAA test probe. The system generates SAA threshold events as required.
	Introduced	16.0.R4
	Platforms	All

[direction] keyword


	Synopsis	Direction for OAM ping responses for OAM ping test run
	Context	configure saa owner string test string jitter-event keyword threshold-type keyword
	Tree	jitter-event
	Options	inbound, outbound, round-trip
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold-type keyword


	Synopsis	Threshold type
	Context	configure saa owner string test string jitter-event keyword threshold-type keyword
	Tree	jitter-event
	Options	rising, falling
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold number


	Synopsis	Threshold jitter value
	Context	configure saa owner string test string jitter-event keyword threshold-type keyword threshold number
	Tree	threshold
	Description	This command specifies the threshold jitter value. The system generates an SAA threshold event when the jitter value of the test run crosses the threshold value.
	Range	0 to 2147483647
	Units	microseconds
	Notes	This element is mandatory.
	Introduced	16.0.R4
	Platforms	All

latency-event [direction] keyword threshold-type keyword


	Synopsis	Enter the latency-event list instance
	Context	configure saa owner string test string latency-event keyword threshold-type keyword
	Tree	latency-event
	Description	Commands in this context configure the latency event thresholds used to evaluate the latency event value at the termination of an SAA test probe. The system generates SAA threshold events as required.
	Introduced	16.0.R4
	Platforms	All

[direction] keyword


	Synopsis	Direction for OAM ping responses for OAM ping test run
	Context	configure saa owner string test string latency-event keyword threshold-type keyword
	Tree	latency-event
	Options	inbound, outbound, round-trip
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold-type keyword


	Synopsis	Threshold type
	Context	configure saa owner string test string latency-event keyword threshold-type keyword
	Tree	latency-event
	Options	rising, falling
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold number


	Synopsis	Threshold latency value
	Context	configure saa owner string test string latency-event keyword threshold-type keyword threshold number
	Tree	threshold
	Description	This command specifies the threshold latency value. The system generates an SAA threshold event when the latency value of the test run crosses the threshold value.
	Range	0 to 2147483647
	Units	microseconds
	Notes	This element is mandatory.
	Introduced	16.0.R4
	Platforms	All

loss-event [direction] keyword threshold-type keyword


	Synopsis	Enter the loss-event list instance
	Context	configure saa owner string test string loss-event keyword threshold-type keyword
	Tree	loss-event
	Description	Commands in this context configure the loss event thresholds used to evaluate the loss event value at the termination of an SAA test probe. The system generates SAA threshold events as required.
	Introduced	16.0.R4
	Platforms	All

[direction] keyword


	Synopsis	Direction for OAM ping responses for OAM ping test run
	Context	configure saa owner string test string loss-event keyword threshold-type keyword
	Tree	loss-event
	Options	inbound, outbound, round-trip
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold-type keyword


	Synopsis	Threshold type
	Context	configure saa owner string test string loss-event keyword threshold-type keyword
	Tree	loss-event
	Options	rising, falling
	Notes	This element is part of a list key.
	Introduced	16.0.R4
	Platforms	All

threshold number


	Synopsis	Threshold loss event value
	Context	configure saa owner string test string loss-event keyword threshold-type keyword threshold number
	Tree	threshold
	Description	This command specifies the threshold loss value. The system generates an SAA threshold event when the loss value of the test run crosses the threshold value.
	Range	0 to 2147483647
	Units	packets
	Notes	This element is mandatory.
	Introduced	16.0.R4
	Platforms	All

probe-history keyword


WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.
	Synopsis	History probe behavior
	Context	configure saa owner string test string probe-history keyword
	Tree	probe-history
	Default	auto
	Options	keep, drop, auto
	Introduced	16.0.R4
	Platforms	All

type


	Synopsis	Enter the type context
	Context	configure saa owner string test string type
	Tree	type
	Introduced	16.0.R4
	Platforms	All

dns


	Synopsis	Enable the dns context
	Context	configure saa owner string test string type dns
	Tree	dns
	Notes	The following elements are part of a choice: dns, icmp-ping, or lsp-ping.
	Introduced	22.10.R1
	Platforms	All

count number


	Synopsis	Number of messages to send in a sample window
	Context	configure saa owner string test string type dns count number
	Tree	count
	Description	This command specifies the number of messages to send. Each message request must either time out or receive a reply before the next message request is sent.
	Range	1 to 100
	Default	1
	Units	packets
	Introduced	22.10.R1
	Platforms	All

interval number


	Synopsis	Minimum time before the next message request is sent
	Context	configure saa owner string test string type dns interval number
	Tree	interval
	Range	1 to 10
	Default	1
	Units	seconds
	Introduced	22.10.R1
	Platforms	All

name-server (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the DNS name server used for the test
	Context	configure saa owner string test string type dns name-server (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	name-server
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

record-type keyword


	Synopsis	Record type
	Context	configure saa owner string test string type dns record-type keyword
	Tree	record-type
	Default	ipv4-a-record
	Options	ipv4-a-record, ipv6-aaaa-record
	Introduced	22.10.R1
	Platforms	All

router-instance string


	Synopsis	Router name or VPRN service name
	Context	configure saa owner string test string type dns router-instance string
	Tree	router-instance
	Default	_Base_and_management
	Introduced	22.10.R1
	Platforms	All

source-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address on the local system
	Context	configure saa owner string test string type dns source-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	source-address
	Description	This command configures the IP address on the local system. If unconfigured, the router uses a system selected local IP address.
	Introduced	22.10.R1
	Platforms	All

target-address string


	Synopsis	DNS name to be resolved to an IP address
	Context	configure saa owner string test string type dns target-address string
	Tree	target-address
	String Length	1 to 255
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

timeout number


	Synopsis	Maximum time to wait for a reply message
	Context	configure saa owner string test string type dns timeout number
	Tree	timeout
	Description	This command specifies the maximum time the router waits for a message response after sending the message request. When the timeout expires, the requesting router assumes the message response is not received. Any response received after the request times out is silently discarded.
	Range	1 to 120
	Default	5
	Units	seconds
	Introduced	22.10.R1
	Platforms	All

trap-generation


	Synopsis	Enter the trap-generation context
	Context	configure saa owner string test string type dns trap-generation
	Tree	trap-generation
	Introduced	22.10.R1
	Platforms	All

probe-fail boolean


	Synopsis	Enable the generation of probe fail notifications
	Context	configure saa owner string test string type dns trap-generation probe-fail boolean
	Tree	probe-fail
	Description	When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests.
	Default	false
	Introduced	22.10.R1
	Platforms	All

probe-fail-threshold number


	Synopsis	Consecutive probe failure count
	Context	configure saa owner string test string type dns trap-generation probe-fail-threshold number
	Tree	probe-fail-threshold
	Description	This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

test-complete boolean


	Synopsis	Enable generation of test complete notifications
	Context	configure saa owner string test string type dns trap-generation test-complete boolean
	Tree	test-complete
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail boolean


	Synopsis	Enable the generation of test fail notifications
	Context	configure saa owner string test string type dns trap-generation test-fail boolean
	Tree	test-fail
	Description	When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting.
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail-threshold number


	Synopsis	Total probe failures for trap generation
	Context	configure saa owner string test string type dns trap-generation test-fail-threshold number
	Tree	test-fail-threshold
	Description	This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

icmp-ping


	Synopsis	Enable the icmp-ping context
	Context	configure saa owner string test string type icmp-ping
	Tree	icmp-ping
	Description	Commands in this context configure an ICMP ping test.
	Notes	The following elements are part of a choice: dns, icmp-ping, or lsp-ping.
	Introduced	16.0.R4
	Platforms	All

bypass-routing boolean


	Synopsis	Bypass routing table for directly connected interfaces
	Context	configure saa owner string test string type icmp-ping bypass-routing boolean
	Tree	bypass-routing
	Default	false
	Notes	The following elements are part of a choice: bypass-routing, interface, or next-hop-address.
	Introduced	16.0.R4
	Platforms	All

count number


	Synopsis	ICMP Echo Request packets to send in a sample window
	Context	configure saa owner string test string type icmp-ping count number
	Tree	count
	Range	1 to 100000
	Default	5
	Units	packets
	Introduced	16.0.R4
	Platforms	All

destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)


	Synopsis	Destination IP address or DNS name to send ping request
	Context	configure saa owner string test string type icmp-ping destination-address (ipv4-address-no-zone \| ipv6-address-no-zone \| string-not-all-spaces)
	Tree	destination-address
	String Length	1 to 128
	Notes	This element is mandatory.
	Introduced	16.0.R4
	Platforms	All

do-not-fragment boolean


	Synopsis	Prevent fragmentation of the ICMP Echo Request packet
	Context	configure saa owner string test string type icmp-ping do-not-fragment boolean
	Tree	do-not-fragment
	Default	false
	Introduced	16.0.R4
	Platforms	All

interface string


	Synopsis	Interface name
	Context	configure saa owner string test string type icmp-ping interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: bypass-routing, interface, or next-hop-address.
	Introduced	16.0.R4
	Platforms	All

interval (number | decimal-number)


	Synopsis	Minimum time to expire before message request is sent
	Context	configure saa owner string test string type icmp-ping interval (number \| decimal-number)
	Tree	interval
	Range	1 to 10000
	Default	1
	Units	seconds
	Introduced	16.0.R4
	Platforms	All

next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Next-hop IP address to reach destination
	Context	configure saa owner string test string type icmp-ping next-hop-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop-address
	Notes	The following elements are part of a choice: bypass-routing, interface, or next-hop-address.
	Introduced	16.0.R4
	Platforms	All

pattern (keyword | number)


	Synopsis	Pattern to fill the data portion in a ping packet
	Context	configure saa owner string test string type icmp-ping pattern (keyword \| number)
	Tree	pattern
	Range	0 to 65535
	Default	sequential
	Options	sequential
	Introduced	16.0.R4
	Platforms	All

qos


	Synopsis	Enter the qos context
	Context	configure saa owner string test string type icmp-ping qos
	Tree	qos
	Introduced	16.0.R4
	Platforms	All

fc keyword


	Synopsis	Forwarding class
	Context	configure saa owner string test string type icmp-ping qos fc keyword
	Tree	fc
	Default	nc
	Options	be, l2, af, l1, h2, ef, h1, nc
	Introduced	16.0.R4
	Platforms	All

tos number


	Synopsis	Type of service
	Context	configure saa owner string test string type icmp-ping qos tos number
	Tree	tos
	Range	0 to 255
	Default	0
	Introduced	16.0.R4
	Platforms	All

router-instance string


	Synopsis	Router name or VPRN service name
	Context	configure saa owner string test string type icmp-ping router-instance string
	Tree	router-instance
	Default	Base
	Introduced	16.0.R4
	Platforms	All

size number


	Synopsis	Packet padding size
	Context	configure saa owner string test string type icmp-ping size number
	Tree	size
	Description	This command configures the number of bytes in the combined ICMP Header (8 bytes) and ICMP Payload (variable size) of the ICMP Echo Request packets.
	Range	0 to 16384
	Default	56
	Units	bytes
	Introduced	16.0.R4
	Platforms	All

source-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Source IP address
	Context	configure saa owner string test string type icmp-ping source-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	source-address
	Description	This command configures the source IP address to be loaded into the IP header of the ICMP Echo Request packet. If unconfigured, the router uses a system-selected local address.
	Introduced	16.0.R4
	Platforms	All

timeout number


	Synopsis	Time router waits for a reply after sending last probe
	Context	configure saa owner string test string type icmp-ping timeout number
	Tree	timeout
	Range	1 to 10
	Default	5
	Units	seconds
	Introduced	16.0.R4
	Platforms	All

trap-generation


	Synopsis	Enter the trap-generation context
	Context	configure saa owner string test string type icmp-ping trap-generation
	Tree	trap-generation
	Introduced	22.10.R1
	Platforms	All

probe-fail boolean


	Synopsis	Enable the generation of probe fail notifications
	Context	configure saa owner string test string type icmp-ping trap-generation probe-fail boolean
	Tree	probe-fail
	Description	When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests.
	Default	false
	Introduced	22.10.R1
	Platforms	All

probe-fail-threshold number


	Synopsis	Consecutive probe failure count
	Context	configure saa owner string test string type icmp-ping trap-generation probe-fail-threshold number
	Tree	probe-fail-threshold
	Description	This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

test-complete boolean


	Synopsis	Enable generation of test complete notifications
	Context	configure saa owner string test string type icmp-ping trap-generation test-complete boolean
	Tree	test-complete
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail boolean


	Synopsis	Enable the generation of test fail notifications
	Context	configure saa owner string test string type icmp-ping trap-generation test-fail boolean
	Tree	test-fail
	Description	When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting.
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail-threshold number


	Synopsis	Total probe failures for trap generation
	Context	configure saa owner string test string type icmp-ping trap-generation test-fail-threshold number
	Tree	test-fail-threshold
	Description	This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

ttl number


	Synopsis	Time to live in the IP header
	Context	configure saa owner string test string type icmp-ping ttl number
	Tree	ttl
	Range	1 to 128
	Default	64
	Introduced	16.0.R4
	Platforms	All

lsp-ping


	Synopsis	Enable the lsp-ping context
	Context	configure saa owner string test string type lsp-ping
	Tree	lsp-ping
	Description	Commands in this context configure the command options to perform in-band LSP connectivity tests. LSP ping uses the protocol and data structures defined in RFC 8029, Detecting Multiprotocol Label Switched (MPLS) Data-Plane Failures.
	Notes	The following elements are part of a choice: dns, icmp-ping, or lsp-ping.
	Introduced	22.10.R1
	Platforms	All

interval number


	Synopsis	Minimum time before the next lsp-ping request is sent
	Context	configure saa owner string test string type lsp-ping interval number
	Tree	interval
	Range	1 to 10
	Default	1
	Units	seconds
	Introduced	22.10.R1
	Platforms	All

qos


	Synopsis	Enter the qos context
	Context	configure saa owner string test string type lsp-ping qos
	Tree	qos
	Introduced	22.10.R1
	Platforms	All

fc keyword


	Synopsis	Forwarding class
	Context	configure saa owner string test string type lsp-ping qos fc keyword
	Tree	fc
	Default	be
	Options	be, l2, af, l1, h2, ef, h1, nc
	Introduced	22.10.R1
	Platforms	All

profile keyword


	Synopsis	Profile
	Context	configure saa owner string test string type lsp-ping qos profile keyword
	Tree	profile
	Default	out
	Options	in, out
	Introduced	22.10.R1
	Platforms	All

send-count number


	Synopsis	Number of request packets to send in a sample window
	Context	configure saa owner string test string type lsp-ping send-count number
	Tree	send-count
	Range	1 to 100
	Default	1
	Units	packets
	Introduced	22.10.R1
	Platforms	All

size number


	Synopsis	Packet pad size
	Context	configure saa owner string test string type lsp-ping size number
	Tree	size
	Range	1 to 9786
	Default	1
	Units	bytes
	Introduced	22.10.R1
	Platforms	All

source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Source IP address
	Context	configure saa owner string test string type lsp-ping source-ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	source-ip-address
	Introduced	22.10.R1
	Platforms	All

sub-type


	Synopsis	Enter the sub-type context
	Context	configure saa owner string test string type lsp-ping sub-type
	Tree	sub-type
	Introduced	22.10.R1
	Platforms	All

bgp-label


	Synopsis	Enable the bgp-label context
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label
	Tree	bgp-label
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

prefix (ipv4-prefix | ipv6-prefix)


	Synopsis	Destination IP prefix for the test
	Context	configure saa owner string test string type lsp-ping sub-type bgp-label prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

ldp


	Synopsis	Enable the ldp context
	Context	configure saa owner string test string type lsp-ping sub-type ldp
	Tree	ldp
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type ldp path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type ldp path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type ldp path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type ldp path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

prefix (ipv4-prefix | ipv6-prefix)


	Synopsis	Destination IP prefix for the test
	Context	configure saa owner string test string type lsp-ping sub-type ldp prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

rsvp-te


	Synopsis	Enable the rsvp-te context
	Context	configure saa owner string test string type lsp-ping sub-type rsvp-te
	Tree	rsvp-te
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

lsp-name string


	Synopsis	Name of the LSP to be tested
	Context	configure saa owner string test string type lsp-ping sub-type rsvp-te lsp-name string
	Tree	lsp-name
	String Length	1 to 64
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

path string


	Synopsis	Name of the MPLS path to be tested
	Context	configure saa owner string test string type lsp-ping sub-type rsvp-te path string
	Tree	path
	String Length	1 to 64
	Introduced	22.10.R1
	Platforms	All

sr-isis


	Synopsis	Enable the sr-isis context
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis
	Tree	sr-isis
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

igp-instance number


	Synopsis	IGP instance for the SR IS-IS test
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis igp-instance number
	Tree	igp-instance
	Range	0 to 127
	Default	0
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

prefix (ipv4-prefix | ipv6-prefix)


	Synopsis	Destination IP prefix for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-isis prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

sr-ospf


	Synopsis	Enable the sr-ospf context
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf
	Tree	sr-ospf
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

igp-instance number


	Synopsis	IGP instance for the SR OSPF test
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf igp-instance number
	Tree	igp-instance
	Range	0 to 31
	Default	0
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

prefix (ipv4-prefix | ipv6-prefix)


	Synopsis	Destination IP prefix for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

sr-ospf3


	Synopsis	Enable the sr-ospf3 context
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3
	Tree	sr-ospf3
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

igp-instance number


	Synopsis	IGP instance for the SR OSPFv3 test
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 igp-instance number
	Tree	igp-instance
	Range	0 to 31 \| 64 to 95
	Default	0
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

prefix (ipv4-prefix | ipv6-prefix)


	Synopsis	Destination IP prefix for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-ospf3 prefix (ipv4-prefix \| ipv6-prefix)
	Tree	prefix
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

sr-policy


	Synopsis	Enable the sr-policy context
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy
	Tree	sr-policy
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

color number


	Synopsis	Segment Routing color for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy color number
	Tree	color
	Range	0 to 4294967295
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Segment Routing endpoint for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy endpoint (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	endpoint
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

segment-list number


	Synopsis	Segment Routing segment list for the test
	Context	configure saa owner string test string type lsp-ping sub-type sr-policy segment-list number
	Tree	segment-list
	Range	1 to 32
	Introduced	22.10.R1
	Platforms	All

sr-te


	Synopsis	Enable the sr-te context
	Context	configure saa owner string test string type lsp-ping sub-type sr-te
	Tree	sr-te
	Notes	The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te.
	Introduced	22.10.R1
	Platforms	All

lsp-name string


	Synopsis	Name of the LSP to be tested
	Context	configure saa owner string test string type lsp-ping sub-type sr-te lsp-name string
	Tree	lsp-name
	String Length	1 to 64
	Notes	This element is mandatory.
	Introduced	22.10.R1
	Platforms	All

path string


	Synopsis	Name of the MPLS path to be tested
	Context	configure saa owner string test string type lsp-ping sub-type sr-te path string
	Tree	path
	String Length	1 to 64
	Introduced	22.10.R1
	Platforms	All

path-destination


	Synopsis	Enter the path-destination context
	Context	configure saa owner string test string type lsp-ping sub-type sr-te path-destination
	Tree	path-destination
	Introduced	22.10.R1
	Platforms	All

interface string


	Synopsis	Egress router interface used with the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-te path-destination interface string
	Tree	interface
	String Length	1 to 32
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	IP address of the path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-te path-destination ip-address (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	ip-address
	Introduced	22.10.R1
	Platforms	All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)


	Synopsis	Egress IP next hop address used with path destination
	Context	configure saa owner string test string type lsp-ping sub-type sr-te path-destination next-hop (ipv4-address-no-zone \| ipv6-address-no-zone)
	Tree	next-hop
	Notes	The following elements are part of a choice: interface or next-hop.
	Introduced	22.10.R1
	Platforms	All

timeout number


	Synopsis	Time router waits for a reply to an echo request
	Context	configure saa owner string test string type lsp-ping timeout number
	Tree	timeout
	Range	1 to 10
	Default	5
	Units	seconds
	Introduced	22.10.R1
	Platforms	All

trap-generation


	Synopsis	Enter the trap-generation context
	Context	configure saa owner string test string type lsp-ping trap-generation
	Tree	trap-generation
	Introduced	22.10.R1
	Platforms	All

probe-fail boolean


	Synopsis	Enable the generation of probe fail notifications
	Context	configure saa owner string test string type lsp-ping trap-generation probe-fail boolean
	Tree	probe-fail
	Description	When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests.
	Default	false
	Introduced	22.10.R1
	Platforms	All

probe-fail-threshold number


	Synopsis	Consecutive probe failure count
	Context	configure saa owner string test string type lsp-ping trap-generation probe-fail-threshold number
	Tree	probe-fail-threshold
	Description	This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

test-complete boolean


	Synopsis	Enable generation of test complete notifications
	Context	configure saa owner string test string type lsp-ping trap-generation test-complete boolean
	Tree	test-complete
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail boolean


	Synopsis	Enable the generation of test fail notifications
	Context	configure saa owner string test string type lsp-ping trap-generation test-fail boolean
	Tree	test-fail
	Description	When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting.
	Default	false
	Introduced	22.10.R1
	Platforms	All

test-fail-threshold number


	Synopsis	Total probe failures for trap generation
	Context	configure saa owner string test string type lsp-ping trap-generation test-fail-threshold number
	Tree	test-fail-threshold
	Description	This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests.
	Range	0 to 15
	Default	1
	Introduced	22.10.R1
	Platforms	All

ttl number


	Synopsis	TTL value for the echo request MPLS label
	Context	configure saa owner string test string type lsp-ping ttl number
	Tree	ttl
	Range	1 to 255
	Default	255
	Introduced	22.10.R1
	Platforms	All