52. test-oam Commands
52.1. test-oam Command Descriptions
test-oam
Synopsis
Enter the test-oam context
Tree
Introduced
16.0.R4
Platforms
All
icmp
Synopsis
Enter the icmp context
Tree
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
ping-template [name] string
Synopsis
Enter the ping-template list instance
Context
configure test-oam icmp ping-template string
Tree
Description
Commands in this context define timers and thresholds that determine the basis for
connectivity verification and influence the service IP interface's operational state. The
configuration of the ping template is located in the configure test-oam icmp context.
The configuration options are separated to allow different failure detection and
recovery behaviors.
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
[name] string
Synopsis
Ping template name
Context
configure test-oam icmp ping-template string
String Length
1 to 64
Notes
This element is part of a list key.
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
description string
Synopsis
Text description
Context
configure test-oam icmp ping-template string description string
Tree
String Length
1 to 80
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
dot1p number
Synopsis
Dot1p in Ethernet header of outgoing ping packets
Context
configure test-oam icmp ping-template string dot1p number
Tree
Range
0 to 7
Default
7
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
dscp keyword
Synopsis
DSCP value used in the outgoing ping packet
Context
configure test-oam icmp ping-template string dscp keyword
Tree
Default
nc1
Options
be, cp1, cp2, cp3, cp4, cp5, cp6, cp7, cs1, cp9, af11, cp11, af12, cp13, af13, cp15, cs2, cp17, af21, cp19, af22, cp21, af23, cp23, cs3, cp25, af31, cp27, af32, cp29, af33, cp31, cs4, cp33, af41, cp35, af42, cp37, af43, cp39, cs5, cp41, cp42, cp43, cp44, cp45, ef, cp47, nc1, cp49, cp50, cp51, cp52, cp53, cp54, cp55, nc2, cp57, cp58, cp59, cp60, cp61, cp62, cp63
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
failure-threshold number
Synopsis
Failure threshold to declare inter-connectivity down
Context
configure test-oam icmp ping-template string failure-threshold number
Tree
Range
2 to 10
Default
3
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
interval number
Synopsis
Packet transmit interval
Context
configure test-oam icmp ping-template string interval number
Tree
Range
1 to 60
Default
60
Units
seconds
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
reactivation-failure-threshold number
Synopsis
Threshold of consecutive failures at reactivation
Context
configure test-oam icmp ping-template string reactivation-failure-threshold number
Description
This command configures the number of consecutive failures that must occur when transmitting at the reactivation interval without success before the transmission interval is changed to the standard interval.
Range
1 to 10
Default
4
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
reactivation-interval number
Synopsis
Ping reactivation interval
Context
configure test-oam icmp ping-template string reactivation-interval number
Description
This command configures the packet transmit interval used when the IP interface becomes operationally down because of a ping template failure after receiving a successful response to the previous ICMP echo request.
Range
1 to 60
Default
1
Units
seconds
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
reactivation-threshold number
Synopsis
Success threshold to declare inter-connectivity up
Context
configure test-oam icmp ping-template string reactivation-threshold number
Description
This command configures the minimum number of consecutive successful responses of ICMP replies that must occur before the IP interface transitions from operationally down (due to ping validation failure) to operationally up. This value is a stability metric intended to prevent flapping.
Range
1 to 10
Default
3
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
reactivation-timeout number
Synopsis
Reactivation wait time before packet is declared lost
Context
configure test-oam icmp ping-template string reactivation-timeout number
Tree
Range
1 to 60
Default
1
Units
seconds
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
size number
Synopsis
Data field size of the outgoing ICMP echo packet
Context
configure test-oam icmp ping-template string size number
Tree
Range
12 to 9786
Default
56
Units
octets
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
timeout number
Synopsis
Wait time before ICMP echo request is declared lost
Context
configure test-oam icmp ping-template string timeout number
Tree
Range
1 to 60
Default
5
Units
seconds
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
ttl number
Synopsis
TTL value for the outgoing ping packet
Context
configure test-oam icmp ping-template string ttl number
Tree
Description
This command configures the TTL value used in the outgoing ping packet. The tested interface must be directly connected on the same subnet.
Range
1 to 255
Default
1
Introduced
20.10.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
link-measurement
Synopsis
Enter the link-measurement context
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
measurement-template [template-name] string
Synopsis
Enter the measurement-template list instance
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
[template-name] string
Synopsis
Measurement template name
Context
String Length
1 to 64
Notes
This element is part of a list key.
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
admin-state keyword
Synopsis
Administrative state of the measurement template
Context
configure test-oam link-measurement measurement-template string admin-state keyword
Tree
Default
disable
Options
enable, disable
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
aggregate-sample-window
Synopsis
Enter the aggregate-sample-window context
Context
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
multiplier number
Synopsis
Number of sample windows in the aggregate sample window
Context
Tree
Range
1 to 12
Default
12
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
threshold
Synopsis
Enter the threshold context
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
absolute number
Synopsis
Absolute time delta for delay measurement reporting
Context
Tree
Range
1 to 100000
Units
microseconds
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
relative number
Synopsis
Relative time delta for delay measurement reporting
Context
Tree
Range
1 to 100
Units
percent
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
window-integrity number
Synopsis
Sample percentage required for window integrity report
Context
Tree
Range
1 to 100
Units
percent
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
delay keyword
Synopsis
Delay measurement statistic type
Context
configure test-oam link-measurement measurement-template string delay keyword
Tree
Default
min
Options
min, max, avg
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
description string
Synopsis
Configure a text description for the template
Context
configure test-oam link-measurement measurement-template string description string
Tree
String Length
1 to 80
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
interval number
Synopsis
Interval between test packet transmissions
Context
configure test-oam link-measurement measurement-template string interval number
Tree
Range
1 to 10
Default
1
Units
seconds
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
last-reported-delay-hold number
Synopsis
Time to wait to flush the last reported delay
Context
Range
0 | 1 to 86400
Default
86400
Units
seconds
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sample-window
Synopsis
Enter the sample-window context
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
multiplier number
Synopsis
Multiplier used for sample-window probes
Context
configure test-oam link-measurement measurement-template string sample-window multiplier number
Tree
Range
1 to 900
Default
10
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
threshold
Synopsis
Enter the threshold context
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
absolute number
Synopsis
Absolute time delta for delay measurement reporting
Context
Tree
Range
1 to 100000
Units
microseconds
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
relative number
Synopsis
Configure the relative (percentage) amount of time by which a new measurement must exceed the last reported measurement to be deemed worthy of reporting
Context
Tree
Range
1 to 500
Units
percent
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
window-integrity number
Synopsis
Sample percentage required for window integrity report
Context
Tree
Range
1 to 100
Units
percent
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
twamp-light
Synopsis
Enter the twamp-light context
Context
Tree
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
allow-egress-remark-dscp boolean
Synopsis
Allow overwrite of DSCP value by the egress QoS policy
Context
Default
false
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
allow-ipv6-udp-checksum-zero boolean
Synopsis
Process IPv6 packets with UDP check sum zero
Context
Default
false
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
dest-udp-port number
Synopsis
Destination UDP port used by link measurement tests
Context
Tree
Range
1 to 65535
Default
862
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
dscp keyword
Synopsis
DSCP copied to TWAMP light echo request packet header
Context
configure test-oam link-measurement measurement-template string twamp-light dscp keyword
Tree
Default
nc1
Options
be, cp1, cp2, cp3, cp4, cp5, cp6, cp7, cs1, cp9, af11, cp11, af12, cp13, af13, cp15, cs2, cp17, af21, cp19, af22, cp21, af23, cp23, cs3, cp25, af31, cp27, af32, cp29, af33, cp31, cs4, cp33, af41, cp35, af42, cp37, af43, cp39, cs5, cp41, cp42, cp43, cp44, cp45, ef, cp47, nc1, cp49, cp50, cp51, cp52, cp53, cp54, cp55, nc2, cp57, cp58, cp59, cp60, cp61, cp62, cp63
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
fc keyword
Synopsis
Forwarding class name for the TWAMP light packet
Context
configure test-oam link-measurement measurement-template string twamp-light fc keyword
Tree
Default
h1
Options
be, l2, af, l1, h2, ef, h1, nc
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
profile keyword
Synopsis
QoS profile for packet treatment in local node
Context
configure test-oam link-measurement measurement-template string twamp-light profile keyword
Tree
Default
in
Options
in, out
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
timestamp-format keyword
Synopsis
Format of the timestamp used in TWAMP light PDU packet
Context
configure test-oam link-measurement measurement-template string twamp-light timestamp-format keyword
Tree
Default
ntp
Options
ntp, ptp
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
ttl number
Synopsis
Time to live value used in the TWAMP light test packet
Context
configure test-oam link-measurement measurement-template string twamp-light ttl number
Tree
Range
1 to 255
Default
1
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
unidirectional-measurement keyword
Synopsis
Method used to compute the unidirectional delay value
Context
Default
derived
Options
derived, actual
Introduced
21.7.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
mpls-dm
Synopsis
Enter the mpls-dm context
Tree
Introduced
16.0.R6
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
admin-state keyword
Synopsis
Administrative state of MPLS DM packet processing
Context
configure test-oam mpls-dm admin-state keyword
Tree
Default
disable
Options
enable, disable
Introduced
16.0.R6
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
twamp
Synopsis
Enter the twamp context
Tree
Introduced
16.0.R4
Platforms
All
server
Synopsis
Enter the server context
Tree
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
admin-state keyword
Synopsis
Administrative state of the TWAMP server
Context
configure test-oam twamp server admin-state keyword
Tree
Default
disable
Options
enable, disable
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
inactivity-timeout number
 | Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
System wide inactivity timeout for each TWAMP server control connection
Context
Tree
Range
60 to 3600
Default
900
Units
seconds
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
max-connections number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
System wide maximum number of concurrent TWAMP server control connections
Context
configure test-oam twamp server max-connections number
Tree
Range
0 to 64
Default
32
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
max-sessions number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
System wide maximum number of concurrent TWAMP server test sessions
Context
configure test-oam twamp server max-sessions number
Tree
Range
0 to 128
Default
32
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
prefix [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis
Enter the prefix list instance
Tree
Max. Elements
100
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis
Prefix to match against TWAMP client address
Notes
This element is part of a list key.
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
description string
Synopsis
Text description
Tree
String Length
1 to 80
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
max-connections number
Synopsis
Maximum number of control connections for TWAMP prefix
Tree
Range
0 to 64
Default
32
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
max-sessions number
Synopsis
Maximum concurrent TWAMP test sessions based on prefix
Tree
Range
0 to 128
Default
32
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
twamp-light
Synopsis
Enter the twamp-light context
Context
Tree
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
inactivity-timeout number
Synopsis
Time to maintain stale state on the session reflector
Context
Tree
Range
10 to 100
Default
100
Units
seconds
Introduced
16.0.R4
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS