saa commands

configure 
saa 
apply-groups reference
apply-groups-exclude reference
owner named-item test named-item 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
continuous boolean
description description
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 
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 interface-name
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 interface-name
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 interface-name
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 named-item-64
path named-item-64
sr-isis 
igp-instance number
path-destination 
interface interface-name
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 interface-name
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 interface-name
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 named-item-64
path named-item-64
path-destination 
interface interface-name
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
sdp-ping 
apply-groups reference
apply-groups-exclude reference
count number
interval number
originating-sdp-identifier number
qos 
fc keyword
profile keyword
responder-sdp-identifier number
size number
timeout number
trap-generation 
probe-fail boolean
probe-fail-threshold number
test-complete boolean
test-fail boolean
test-fail-threshold number

saa command descriptions

saa

Synopsis Enter the saa context
Context configure saa
Treesaa

Description

Commands in this context configure the Service Assurance Agent (SAA) tests.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

owner [owner-name] named-item test named-item

Synopsis Enter the owner list instance
Context configure saa owner named-item test named-item
Treeowner
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[owner-name] named-item
Synopsis Optional owner name of the SAA operation
Contextconfigure saa owner named-item test named-item
Treeowner

Description

This command configures the owner associated with the SAA operation.

String length1 to 32
MD-CLI defaultTiMOS CLI

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

test named-item
Synopsis SAA test name
Contextconfigure saa owner named-item test named-item
Treeowner
String length1 to 32

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

accounting-policy reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAccounting policy associated with the SAA test
Contextconfigure saa owner named-item test named-item accounting-policy reference
Treeaccounting-policy

Reference

configure log accounting-policy number

Introduced25.3.R2

Platforms

7705 SAR Gen 2

admin-state keyword
Synopsis Administrative state of the SAA test
Context configure saa owner named-item test named-item admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced25.3.R2

Platforms

7705 SAR Gen 2

continuous boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisExecute the SAA tests as continuous
Contextconfigure saa owner named-item test named-item continuous boolean
Treecontinuous

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

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

description description
Synopsis Text description
Context configure saa owner named-item test named-item description description
Treedescription
String length1 to 80
Introduced25.3.R2

Platforms

7705 SAR Gen 2

jitter-event [direction] keyword threshold-type keyword
Synopsis Enter the jitter-event list instance
Contextconfigure saa owner named-item test named-item jitter-event keyword threshold-type keyword
Treejitter-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

[direction] keyword
Synopsis Direction for OAM ping responses for OAM ping test run
Contextconfigure saa owner named-item test named-item jitter-event keyword threshold-type keyword
Treejitter-event
Optionsinbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold-type keyword
Synopsis Threshold type
Contextconfigure saa owner named-item test named-item jitter-event keyword threshold-type keyword
Treejitter-event
Optionsrising, falling

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold number
Synopsis Threshold jitter value
Context configure saa owner named-item test named-item jitter-event keyword threshold-type keyword threshold number
Treethreshold

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.

Range0 to 2147483647
Unitsmicroseconds

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

latency-event [direction] keyword threshold-type keyword
Synopsis Enter the latency-event list instance
Contextconfigure saa owner named-item test named-item latency-event keyword threshold-type keyword
Treelatency-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

[direction] keyword
Synopsis Direction for OAM ping responses for OAM ping test run
Contextconfigure saa owner named-item test named-item latency-event keyword threshold-type keyword
Treelatency-event
Optionsinbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold-type keyword
Synopsis Threshold type
Contextconfigure saa owner named-item test named-item latency-event keyword threshold-type keyword
Treelatency-event
Optionsrising, falling

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold number
Synopsis Threshold latency value
Context configure saa owner named-item test named-item latency-event keyword threshold-type keyword threshold number
Treethreshold

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.

Range0 to 2147483647
Unitsmicroseconds

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

loss-event [direction] keyword threshold-type keyword
Synopsis Enter the loss-event list instance
Contextconfigure saa owner named-item test named-item loss-event keyword threshold-type keyword
Treeloss-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

[direction] keyword
Synopsis Direction for OAM ping responses for OAM ping test run
Contextconfigure saa owner named-item test named-item loss-event keyword threshold-type keyword
Treeloss-event
Optionsinbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold-type keyword
Synopsis Threshold type
Contextconfigure saa owner named-item test named-item loss-event keyword threshold-type keyword
Treeloss-event
Optionsrising, falling

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold number
Synopsis Threshold loss event value
Context configure saa owner named-item test named-item loss-event keyword threshold-type keyword threshold number
Treethreshold

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.

Range0 to 2147483647
Unitspackets

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-history keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisHistory probe behavior
Contextconfigure saa owner named-item test named-item probe-history keyword
Treeprobe-history
Optionskeep, drop, auto
Defaultauto
Introduced25.3.R2

Platforms

7705 SAR Gen 2

type
Synopsis Enter the type context
Context configure saa owner named-item test named-item type
Treetype
Introduced25.3.R2

Platforms

7705 SAR Gen 2

icmp-ping
Synopsis Enable the icmp-ping context
Context configure saa owner named-item test named-item type icmp-ping
Treeicmp-ping

Description

Commands in this context configure an ICMP ping test.

Notes

The following elements are part of a choice: dns, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

bypass-routing boolean
Synopsis Bypass routing table for directly connected interfaces
Contextconfigure saa owner named-item test named-item type icmp-ping bypass-routing boolean
Treebypass-routing
Defaultfalse

Notes

The following elements are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

count number
Synopsis ICMP Echo Request packets to send in a sample window
Contextconfigure saa owner named-item test named-item type icmp-ping count number
Treecount
Range1 to 100000
Unitspackets
Default 5
Introduced25.3.R2

Platforms

7705 SAR Gen 2

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
Contextconfigure saa owner named-item test named-item type icmp-ping destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
Treedestination-address
String length1 to 128

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

do-not-fragment boolean
Synopsis Do not fragment echo request packets (valid for IPv4)
Contextconfigure saa owner named-item test named-item type icmp-ping do-not-fragment boolean
Treedo-not-fragment

Description

This command sets the Do Not Fragment (DF) bit in the IPv4 header. This prevents packet fragmentation along the path when there is an MTU mismatch.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interface interface-name
Synopsis Interface name
Contextconfigure saa owner named-item test named-item type icmp-ping interface interface-name
Treeinterface
String length1 to 32

Notes

The following elements are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

interval (number | decimal-number)
Synopsis Minimum time to expire before message request is sent
Contextconfigure saa owner named-item test named-item type icmp-ping interval (number | decimal-number)
Treeinterval
Range1 to 10000
Unitsseconds
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Next-hop IP address to reach destination
Contextconfigure saa owner named-item test named-item type icmp-ping next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop-address

Notes

The following elements are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

pattern (keyword | number)
Synopsis Pattern to fill the data portion in a ping packet
Contextconfigure saa owner named-item test named-item type icmp-ping pattern (keyword | number)
Treepattern
Range0 to 65535
Optionssequential
Defaultsequential
Introduced25.3.R2

Platforms

7705 SAR Gen 2

qos
Synopsis Enter the qos context
Context configure saa owner named-item test named-item type icmp-ping qos
Treeqos
Introduced25.3.R2

Platforms

7705 SAR Gen 2

fc keyword
Synopsis Forwarding class
Context configure saa owner named-item test named-item type icmp-ping qos fc keyword
Treefc
Options

be – Best effort

l2 – Low 2 (best effort)

af – Assured forwarding (assured)

l1 – Low 1 (assured)

h2 – High 2 (high priority)

ef – Expedited forwarding (high priority)

h1 – High 1 (high priority)

nc – Network control (high priority)

Defaultnc
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

tos number
Synopsis Type of service
Context configure saa owner named-item test named-item type icmp-ping qos tos number
Treetos
Range0 to 255
Default0
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

size number
Synopsis Packet padding size
Context configure saa owner named-item test named-item type icmp-ping size number
Treesize

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.

Range0 to 16384
Unitsbytes
Default 56
Introduced25.3.R2

Platforms

7705 SAR Gen 2

source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Source IP address
Context configure saa owner named-item test named-item type icmp-ping source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treesource-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

timeout number
Synopsis Time router waits for a reply after sending last probe
Contextconfigure saa owner named-item test named-item type icmp-ping timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced25.3.R2

Platforms

7705 SAR Gen 2

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner named-item test named-item type icmp-ping trap-generation
Treetrap-generation
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner named-item test named-item type icmp-ping trap-generation probe-fail boolean
Treeprobe-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail-threshold number
Synopsis Consecutive probe failure count
Context configure saa owner named-item test named-item type icmp-ping trap-generation probe-fail-threshold number
Treeprobe-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner named-item test named-item type icmp-ping trap-generation test-fail boolean
Treetest-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner named-item test named-item type icmp-ping trap-generation test-fail-threshold number
Treetest-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

ttl number
Synopsis Time to live in the IP header
Context configure saa owner named-item test named-item type icmp-ping ttl number
Treettl
Range1 to 128
Default64
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

lsp-ping
Synopsis Enable the lsp-ping context
Context configure saa owner named-item test named-item type lsp-ping
Treelsp-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, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

interval number
Synopsis Minimum time before the next lsp-ping request is sent
Contextconfigure saa owner named-item test named-item type lsp-ping interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

qos
Synopsis Enter the qos context
Context configure saa owner named-item test named-item type lsp-ping qos
Treeqos
Introduced25.3.R2

Platforms

7705 SAR Gen 2

fc keyword
Synopsis Forwarding class
Context configure saa owner named-item test named-item type lsp-ping qos fc keyword
Treefc
Options

be – Best effort

l2 – Low 2 (best effort)

af – Assured forwarding (assured)

l1 – Low 1 (assured)

h2 – High 2 (high priority)

ef – Expedited forwarding (high priority)

h1 – High 1 (high priority)

nc – Network control (high priority)

Defaultbe
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

profile keyword
Synopsis Profile
Contextconfigure saa owner named-item test named-item type lsp-ping qos profile keyword
Treeprofile
Options

in – In profile

out – Out of profile

Default out
Introduced25.3.R2

Platforms

7705 SAR Gen 2

send-count number
Synopsis Number of request packets to send in a sample window
Contextconfigure saa owner named-item test named-item type lsp-ping send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

size number
Synopsis Packet pad size
Context configure saa owner named-item test named-item type lsp-ping size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

sub-type
Synopsis Enter the sub-type context
Context configure saa owner named-item test named-item type lsp-ping sub-type
Treesub-type
Introduced25.3.R2

Platforms

7705 SAR Gen 2

bgp-label
Synopsis Enable the bgp-label context
Context configure saa owner named-item test named-item type lsp-ping sub-type bgp-label
Treebgp-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context configure saa owner named-item test named-item type lsp-ping sub-type bgp-label prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

ldp
Synopsis Enable the ldp context
Context configure saa owner named-item test named-item type lsp-ping sub-type ldp
Treeldp

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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interface interface-name
Synopsis Egress router interface used with the path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination interface interface-name
Treeinterface
String length1 to 32

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context configure saa owner named-item test named-item type lsp-ping sub-type ldp prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

rsvp-te
Synopsis Enable the rsvp-te context
Context configure saa owner named-item test named-item type lsp-ping sub-type rsvp-te
Treersvp-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

lsp-name named-item-64
Synopsis Name of the LSP to be tested
Context configure saa owner named-item test named-item type lsp-ping sub-type rsvp-te lsp-name named-item-64
Treelsp-name
String length1 to 64

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path named-item-64
Synopsis Name of the MPLS path to be tested
Context configure saa owner named-item test named-item type lsp-ping sub-type rsvp-te path named-item-64
Treepath
String length1 to 64
Introduced25.3.R2

Platforms

7705 SAR Gen 2

sr-isis
Synopsis Enable the sr-isis context
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-isis
Treesr-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interface interface-name
Synopsis Egress router interface used with the path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination interface interface-name
Treeinterface
String length1 to 32

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-isis prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

sr-ospf
Synopsis Enable the sr-ospf context
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf
Treesr-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interface interface-name
Synopsis Egress router interface used with the path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination interface interface-name
Treeinterface
String length1 to 32

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

sr-policy
Synopsis Enable the sr-policy context
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-policy
Treesr-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

color number
Synopsis Segment Routing color for the test
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-policy color number
Treecolor
Range0 to 4294967295

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Segment Routing endpoint for the test
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-policy endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Treeendpoint

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

sr-te
Synopsis Enable the sr-te context
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-te
Treesr-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.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

lsp-name named-item-64
Synopsis Name of the LSP to be tested
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-te lsp-name named-item-64
Treelsp-name
String length1 to 64

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

path named-item-64
Synopsis Name of the MPLS path to be tested
Context configure saa owner named-item test named-item type lsp-ping sub-type sr-te path named-item-64
Treepath
String length1 to 64
Introduced25.3.R2

Platforms

7705 SAR Gen 2

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination
Treepath-destination
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interface interface-name
Synopsis Egress router interface used with the path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination interface interface-name
Treeinterface
String length1 to 32

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: interface or next-hop.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

timeout number
Synopsis Time router waits for a reply to an echo request
Contextconfigure saa owner named-item test named-item type lsp-ping timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced25.3.R2

Platforms

7705 SAR Gen 2

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner named-item test named-item type lsp-ping trap-generation
Treetrap-generation
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner named-item test named-item type lsp-ping trap-generation probe-fail boolean
Treeprobe-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail-threshold number
Synopsis Consecutive probe failure count
Context configure saa owner named-item test named-item type lsp-ping trap-generation probe-fail-threshold number
Treeprobe-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner named-item test named-item type lsp-ping trap-generation test-fail boolean
Treetest-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner named-item test named-item type lsp-ping trap-generation test-fail-threshold number
Treetest-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

ttl number
Synopsis TTL value for the echo request MPLS label
Contextconfigure saa owner named-item test named-item type lsp-ping ttl number
Treettl
Range1 to 255
Default255
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

sdp-ping
Synopsis Enable the sdp-ping context
Context configure saa owner named-item test named-item type sdp-ping
Treesdp-ping

Description

Commands in this context configure tests on SDPs for unidirectional or round-trip connectivity, as well as for performing SDP MTU path tests.

Notes

The following elements are part of a choice: dns, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

count number
Synopsis Number of SDP echo request packets to send
Contextconfigure saa owner named-item test named-item type sdp-ping count number
Treecount

Description

This command specifies the number of echo request packets to send. Each request must either time out or receive a reply before the next message request is sent. The interval value must expire before the next message request is sent.

Range1 to 100
Unitspackets
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

interval number
Synopsis Interval between SDP echo request packets sent
Contextconfigure saa owner named-item test named-item type sdp-ping interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced25.3.R2

Platforms

7705 SAR Gen 2

originating-sdp-identifier number
Synopsis SDP ID used to send packets
Context configure saa owner named-item test named-item type sdp-ping originating-sdp-identifier number
Treeoriginating-sdp-identifier

Description

This command specifies the SDP ID that is used by SDP ping.

The far-end address of the specified SDP ID is the expected responder ID within each reply received. The SDP ID defines the SDP tunnel encapsulation used to reach the far end. This can be IP/GRE or MPLS. If this ID is invalid, administratively down, or otherwise unavailable, the SDP echo request message is not sent, and an error message is displayed. After the interval timer expires, the SDP ping attempts to send the next request, if required.

Range1 to 32767

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

qos
Synopsis Enter the qos context
Context configure saa owner named-item test named-item type sdp-ping qos
Treeqos
Introduced25.3.R2

Platforms

7705 SAR Gen 2

fc keyword
Synopsis FC for the transmitted SDP echo request packets
Contextconfigure saa owner named-item test named-item type sdp-ping qos fc keyword
Treefc
Options

be – Best effort

l2 – Low 2 (best effort)

af – Assured forwarding (assured)

l1 – Low 1 (assured)

h2 – High 2 (high priority)

ef – Expedited forwarding (high priority)

h1 – High 1 (high priority)

nc – Network control (high priority)

Defaultbe
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

profile keyword
Synopsis QoS profile for transmitted SDP echo request packets
Contextconfigure saa owner named-item test named-item type sdp-ping qos profile keyword
Treeprofile
Options

in – In profile

out – Out of profile

Default out
Introduced25.3.R2

Platforms

7705 SAR Gen 2

responder-sdp-identifier number
Synopsis SDP ID used by the far-end to reply to the request
Contextconfigure saa owner named-item test named-item type sdp-ping responder-sdp-identifier number
Treeresponder-sdp-identifier

Description

This command configures the return SDP ID to be used by the far-end router for the message reply for round-trip SDP connectivity testing.

If this ID does not exist on the far-end router, or terminates on a different router from the originating router, or another issue prevents the far-end router from using this ID, the SDP echo reply is sent using generic IP or GRE OAM encapsulation. The received FC (as mapped on the ingress network interface for the far end) defines the FC encapsulation for the reply message.

Range1 to 32767
Introduced25.3.R2

Platforms

7705 SAR Gen 2

size number
Synopsis Size of the SDP echo request packets
Context configure saa owner named-item test named-item type sdp-ping size number
Treesize

Description

This command configures the size of the SDP echo request packets, which includes the SDP header and payload. The size does not include the SDP encapsulation, VC label (if applied), or any DLC headers or trailers.

Range72 to 9786
Unitsbytes
Default 72
Introduced25.3.R2

Platforms

7705 SAR Gen 2

timeout number
Synopsis Maximum time to wait for SDP echo reply packets
Contextconfigure saa owner named-item test named-item type sdp-ping timeout number
Treetimeout

Description

This command configures the time the router waits for a message reply after sending the last probe for a specific test. When the timeout expires, the test is marked complete and no more packets are processed.

Range1 to 10
Unitsseconds
Default 5
Introduced25.3.R2

Platforms

7705 SAR Gen 2

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner named-item test named-item type sdp-ping trap-generation
Treetrap-generation
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner named-item test named-item type sdp-ping trap-generation probe-fail boolean
Treeprobe-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

probe-fail-threshold number
Synopsis Consecutive probe failure count
Context configure saa owner named-item test named-item type sdp-ping trap-generation probe-fail-threshold number
Treeprobe-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner named-item test named-item type sdp-ping trap-generation test-fail boolean
Treetest-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.

Defaultfalse
Introduced25.3.R2

Platforms

7705 SAR Gen 2

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner named-item test named-item type sdp-ping trap-generation test-fail-threshold number
Treetest-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.

Range0 to 15
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2