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
vccv-ping 
apply-groups reference
apply-groups-exclude reference
count number
interval number
qos 
fc keyword
profile keyword
size number
sub-type 
fec-128 
pseudowire 
destination-ip-address string
pw-id number
source-ip-address string
reply-mode keyword
sdp-bind-id string
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
Treesaa

Description

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

Introduced16.0.R4

Platforms

All

owner [owner-name] string test string

Synopsis Enter the owner list instance
Context configure saa owner string test string
Treeowner
Introduced16.0.R4

Platforms

All

[owner-name] string
Synopsis Optional owner name of the SAA operation
Contextconfigure saa owner string test string
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.

Introduced16.0.R4

Platforms

All

test string
Synopsis SAA test name
Contextconfigure saa owner string test string
Treeowner
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.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.

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

Reference

configure log accounting-policy number

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the SAA test
Context configure saa owner string test string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.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.

SynopsisExecute the SAA tests as continuous
Contextconfigure saa owner string test string 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
Introduced16.0.R4

Platforms

All

description string
Synopsis Text description
Context configure saa owner string test string description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

All

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

Introduced16.0.R4

Platforms

All

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

Notes

This element is part of a list key.

Introduced16.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
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.

Introduced16.0.R4

Platforms

All

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

Introduced16.0.R4

Platforms

All

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

Notes

This element is part of a list key.

Introduced16.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
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.

Introduced16.0.R4

Platforms

All

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

Introduced16.0.R4

Platforms

All

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

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

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

Notes

This element is part of a list key.

Introduced16.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
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.

Introduced16.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.

SynopsisHistory probe behavior
Contextconfigure saa owner string test string probe-history keyword
Treeprobe-history
Optionskeep, drop, auto
Defaultauto
Introduced16.0.R4

Platforms

All

type
Synopsis Enter the type context
Context configure saa owner string test string type
Treetype
Introduced16.0.R4

Platforms

All

dns
Synopsis Enable the dns context
Context configure saa owner string test string type dns
Treedns

Notes

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

Introduced22.10.R1

Platforms

All

count number
Synopsis Number of messages to send in a sample window
Contextconfigure saa owner string test string type dns count number
Treecount

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.

Range1 to 100
Unitspackets
Default 1
Introduced22.10.R1

Platforms

All

interval number
Synopsis Minimum time before the next message request is sent
Contextconfigure saa owner string test string type dns interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced22.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
Contextconfigure saa owner string test string type dns name-server (ipv4-address-no-zone | ipv6-address-no-zone)
Treename-server

Notes

This element is mandatory.

Introduced22.10.R1

Platforms

All

record-type keyword
Synopsis Record type
Contextconfigure saa owner string test string type dns record-type keyword
Treerecord-type
Optionsipv4-a-record, ipv6-aaaa-record
Defaultipv4-a-record
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)
Treesource-address

Description

This command configures the IP address on the local system.

If unconfigured, the router uses a system selected local IP address.

Introduced22.10.R1

Platforms

All

target-address string
Synopsis DNS name to be resolved to an IP address
Contextconfigure saa owner string test string type dns target-address string
Treetarget-address
String Length1 to 255

Notes

This element is mandatory.

Introduced22.10.R1

Platforms

All

timeout number
Synopsis Maximum time to wait for a reply message
Contextconfigure saa owner string test string type dns timeout number
Treetimeout

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.

Range1 to 120
Unitsseconds
Default 5
Introduced22.10.R1

Platforms

All

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner string test string type dns trap-generation
Treetrap-generation
Introduced22.10.R1

Platforms

All

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner string test string type dns 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
Introduced22.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
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 22.10.R1

Platforms

All

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner string test string type dns 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
Introduced22.10.R1

Platforms

All

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner string test string type dns 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 22.10.R1

Platforms

All

icmp-ping
Synopsis Enable the icmp-ping context
Context configure saa owner string test string 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, icmp-ping, lsp-ping, or vccv-ping.

Introduced16.0.R4

Platforms

All

bypass-routing boolean
Synopsis Bypass routing table for directly connected interfaces
Contextconfigure saa owner string test string 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.

Introduced16.0.R4

Platforms

All

count number
Synopsis ICMP Echo Request packets to send in a sample window
Contextconfigure saa owner string test string type icmp-ping count number
Treecount
Range1 to 100000
Unitspackets
Default 5
Introduced16.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
Contextconfigure saa owner string test string 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.

Introduced16.0.R4

Platforms

All

interface string
Synopsis Interface name
Contextconfigure saa owner string test string type icmp-ping interface string
Treeinterface
String Length1 to 32

Notes

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

Introduced16.0.R4

Platforms

All

interval (number | decimal-number)
Synopsis Minimum time to expire before message request is sent
Contextconfigure saa owner string test string type icmp-ping interval (number | decimal-number)
Treeinterval
Range1 to 10000
Unitsseconds
Default 1
Introduced16.0.R4

Platforms

All

next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Next-hop IP address to reach destination
Contextconfigure saa owner string test string 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.

Introduced16.0.R4

Platforms

All

pattern (keyword | number)
Synopsis Pattern to fill the data portion in a ping packet
Contextconfigure saa owner string test string type icmp-ping pattern (keyword | number)
Treepattern
Range0 to 65535
Optionssequential
Defaultsequential
Introduced16.0.R4

Platforms

All

qos
Synopsis Enter the qos context
Context configure saa owner string test string type icmp-ping qos
Treeqos
Introduced16.0.R4

Platforms

All

fc keyword
Synopsis Forwarding class
Context configure saa owner string test string type icmp-ping qos fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default nc
Introduced16.0.R4

Platforms

All

tos number
Synopsis Type of service
Context configure saa owner string test string type icmp-ping qos tos number
Treetos
Range0 to 255
Default0
Introduced 16.0.R4

Platforms

All

size number
Synopsis Packet padding size
Context configure saa owner string test string 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
Introduced16.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)
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.

Introduced16.0.R4

Platforms

All

timeout number
Synopsis Time router waits for a reply after sending last probe
Contextconfigure saa owner string test string type icmp-ping timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced16.0.R4

Platforms

All

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner string test string type icmp-ping trap-generation
Treetrap-generation
Introduced22.10.R1

Platforms

All

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner string test string 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
Introduced22.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
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 22.10.R1

Platforms

All

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner string test string 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
Introduced22.10.R1

Platforms

All

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner string test string 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 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
Treettl
Range1 to 128
Default64
Introduced 16.0.R4

Platforms

All

lsp-ping
Synopsis Enable the lsp-ping context
Context configure saa owner string test string 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, icmp-ping, lsp-ping, or vccv-ping.

Introduced22.10.R1

Platforms

All

interval number
Synopsis Minimum time before the next lsp-ping request is sent
Contextconfigure saa owner string test string type lsp-ping interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced22.10.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure saa owner string test string type lsp-ping qos
Treeqos
Introduced22.10.R1

Platforms

All

fc keyword
Synopsis Forwarding class
Context configure saa owner string test string type lsp-ping qos fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced22.10.R1

Platforms

All

send-count number
Synopsis Number of request packets to send in a sample window
Contextconfigure saa owner string test string type lsp-ping send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced22.10.R1

Platforms

All

size number
Synopsis Packet pad size
Context configure saa owner string test string type lsp-ping size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced22.10.R1

Platforms

All

sub-type
Synopsis Enter the sub-type context
Context configure saa owner string test string type lsp-ping sub-type
Treesub-type
Introduced22.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
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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type bgp-label path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.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)
Treeprefix

Notes

This element is mandatory.

Introduced22.10.R1

Platforms

All

ldp
Synopsis Enable the ldp context
Context configure saa owner string test string 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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type ldp path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.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)
Treeprefix

Notes

This element is mandatory.

Introduced22.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
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.

Introduced22.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
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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type sr-isis path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.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)
Treeprefix

Notes

This element is mandatory.

Introduced22.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
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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type sr-ospf path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.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)
Treeprefix

Notes

This element is mandatory.

Introduced22.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
Treesr-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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type sr-ospf3 path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string type lsp-ping sub-type sr-ospf3 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.

Introduced22.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)
Treeprefix

Notes

This element is mandatory.

Introduced22.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
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.

Introduced22.10.R1

Platforms

All

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

Notes

This element is mandatory.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type sr-policy path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.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
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.

Introduced22.10.R1

Platforms

All

path-destination
Synopsis Enter the path-destination context
Contextconfigure saa owner string test string type lsp-ping sub-type sr-te path-destination
Treepath-destination
Introduced22.10.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address used with path destination
Contextconfigure saa owner string test string 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.

Introduced22.10.R1

Platforms

All

timeout number
Synopsis Time router waits for a reply to an echo request
Contextconfigure saa owner string test string type lsp-ping timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced22.10.R1

Platforms

All

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner string test string type lsp-ping trap-generation
Treetrap-generation
Introduced22.10.R1

Platforms

All

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner string test string 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
Introduced22.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
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 22.10.R1

Platforms

All

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner string test string 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
Introduced22.10.R1

Platforms

All

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner string test string 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 22.10.R1

Platforms

All

ttl number
Synopsis TTL value for the echo request MPLS label
Contextconfigure saa owner string test string type lsp-ping ttl number
Treettl
Range1 to 255
Default255
Introduced 22.10.R1

Platforms

All

vccv-ping
Synopsis Enable the vccv-ping context
Context configure saa owner string test string type vccv-ping
Treevccv-ping

Description

Commands in this context configure a Virtual Circuit Connectivity Verification (VCCV) ping test.

A VCCV-ping test checks connectivity of a VLL inband. It verifies that the destination (target) PE is the egress for the Layer 2 FEC and provides for a cross-check between the data plane and the control plane. Because it is inband, the VCCV-ping message is sent using the same encapsulation and along the same path as user packets in that VLL. The VCCV-ping test is the equivalent of the LSP-ping test for a VLL service. The VCCV-ping test reuses an LSP-ping message format and can be used to test a VLL configured over both an MPLS and a GRE SDP.

Notes

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

Introduced23.10.R1

Platforms

All

count number
Synopsis Number of echo request packets to send
Contextconfigure saa owner string test string type vccv-ping count number
Treecount
Range1 to 100
Unitspackets
Default 1
Introduced23.10.R1

Platforms

All

interval number
Synopsis Interval between packets sent
Context configure saa owner string test string type vccv-ping interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.10.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure saa owner string test string type vccv-ping qos
Treeqos
Introduced23.10.R1

Platforms

All

fc keyword
Synopsis QoS FC for the sent echo request packets
Contextconfigure saa owner string test string type vccv-ping qos fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.10.R1

Platforms

All

profile keyword
Synopsis QoS profile for the sent echo request packets
Contextconfigure saa owner string test string type vccv-ping qos profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.10.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context configure saa owner string test string type vccv-ping size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.10.R1

Platforms

All

sub-type
Synopsis Enter the sub-type context
Context configure saa owner string test string type vccv-ping sub-type
Treesub-type

Description

Commands in this context configure the FEC type for a remote PW segment targeted by a VCCV-ping echo request.

Introduced23.10.R1

Platforms

All

fec-128
Synopsis Enable the fec-128 context
Context configure saa owner string test string type vccv-ping sub-type fec-128
Treefec-128

Description

Commands in this context configure the FEC-128 sub-type.

Introduced23.10.R1

Platforms

All

pseudowire
Synopsis Enable the pseudowire context
Context configure saa owner string test string type vccv-ping sub-type fec-128 pseudowire
Treepseudowire

Description

Commands in this context configure the PW that is used for performing a VCCV-ping operation.

Introduced23.10.R1

Platforms

All

timeout number
Synopsis Wait time for a reply after sending an echo request
Contextconfigure saa owner string test string type vccv-ping timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.10.R1

Platforms

All

trap-generation
Synopsis Enter the trap-generation context
Contextconfigure saa owner string test string type vccv-ping trap-generation
Treetrap-generation
Introduced23.10.R1

Platforms

All

probe-fail boolean
Synopsis Enable the generation of probe fail notifications
Contextconfigure saa owner string test string type vccv-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
Introduced23.10.R1

Platforms

All

probe-fail-threshold number
Synopsis Consecutive probe failure count
Context configure saa owner string test string type vccv-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 23.10.R1

Platforms

All

test-fail boolean
Synopsis Enable the generation of test fail notifications
Contextconfigure saa owner string test string type vccv-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
Introduced23.10.R1

Platforms

All

test-fail-threshold number
Synopsis Total probe failures for trap generation
Contextconfigure saa owner string test string type vccv-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 23.10.R1

Platforms

All

ttl number
Synopsis TTL value for the echo request MPLS label
Contextconfigure saa owner string test string type vccv-ping ttl number
Treettl
Range1 to 255
Default1
Introduced 23.10.R1

Platforms

All