test-oam commands

configure 
test-oam 
apply-groups reference
apply-groups-exclude reference
icmp 
ipv6 
apply-groups reference
apply-groups-exclude reference
length-field boolean
maximum-original-datagram boolean
ping-template string 
apply-groups reference
apply-groups-exclude reference
description string
dot1p number
dscp keyword
failure-threshold number
interval number
reactivation-failure-threshold number
reactivation-interval number
reactivation-threshold number
reactivation-timeout number
size number
timeout number
ttl number
link-measurement 
measurement-template string 
admin-state keyword
aggregate-sample-window 
multiplier number
threshold 
absolute number
relative number
window-integrity number
apply-groups reference
apply-groups-exclude reference
delay keyword
description string
interval number
last-reported-delay-hold number
reporting boolean
sample-window 
multiplier number
threshold 
absolute number
relative number
window-integrity number
twamp-light 
allow-egress-remark-dscp boolean
allow-ipv6-udp-checksum-zero boolean
dest-udp-port number
dscp keyword
fc keyword
ipv6-destination-discovery 
admin-state keyword
discovery-interval number
discovery-timer number
update-interval number
pad-tlv-size number
profile keyword
return-path 
link boolean
src-udp-port number
timestamp-format keyword
ttl number
unidirectional-measurement keyword
mpls 
apply-groups reference
apply-groups-exclude reference
echo-request-downstream-map keyword
timestamp-format keyword
mpls-dm 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
service-activation-testhead 
acceptance-criteria-template string 
apply-groups reference
apply-groups-exclude reference
cir-threshold number
delay-threshold number
delay-var-threshold number
description string
loss-threshold decimal-number
loss-threshold-policing decimal-number
m-factor number
pir-threshold number
apply-groups reference
apply-groups-exclude reference
frame-size-template string 
apply-groups reference
apply-groups-exclude reference
size-a number
size-b number
size-c number
size-d number
size-e number
size-f number
size-g number
size-h number
size-u number
service-test string 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
service-stream number 
acceptance-criteria-template reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
frame-mix 
frame-size-template reference
sequence string
frame-payload 
data-pattern 
repeat (hex-string | number)
ethernet 
c-tag 
discard-eligible boolean
dot1p number
dst-mac string
eth-cfm 
source 
ma-admin-name reference
md-admin-name reference
mep-id number
s-tag 
discard-eligible boolean
dot1p number
rate-cir number
rate-pir number
service-stream-completion-notification boolean
test-types 
cir boolean
cir-pir boolean
performance boolean
policing boolean
service-test-completion-notification boolean
stream-run-type keyword
test-duration 
cir 
minutes-seconds string
cir-pir 
minutes-seconds string
performance 
hours-minutes-seconds string
policing 
minutes-seconds string
twamp 
apply-groups reference
apply-groups-exclude reference
server 
admin-state keyword
allow-ipv6-udp-checksum-zero boolean
apply-groups reference
apply-groups-exclude reference
enforce-test-session-start-time boolean
inactivity-timeout number
max-connections number
max-sessions number
prefix (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
description string
max-connections number
max-sessions number
twamp-light 
apply-groups reference
apply-groups-exclude reference
inactivity-timeout number
source-udp-port-pools 
port number 
apply-groups reference
apply-groups-exclude reference
pool-type keyword

test-oam command descriptions

test-oam

Synopsis Enter the test-oam context
Context configure test-oam
Treetest-oam
Introduced16.0.R4

Platforms

All

icmp

Synopsis Enter the icmp context
Context configure test-oam icmp
Treeicmp
Introduced20.10.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure test-oam icmp ipv6
Treeipv6
Introduced22.7.R1

Platforms

All

maximum-original-datagram boolean
Synopsis ICMPv6 traceroute responses with largest datagram
Contextconfigure test-oam icmp ipv6 maximum-original-datagram boolean
Treemaximum-original-datagram

Description

When configured to true, this command enables the original datagram field of the ICMPv6 error message to be a maximum of 1232 bytes.

When configured to false, the original datagram field of the ICMPv6 error message smaller than 1232 bytes be built smaller.

Defaultfalse
Introduced22.7.R1

Platforms

All

ping-template [name] string
Synopsis Enter the ping-template list instance
Contextconfigure test-oam icmp ping-template string
Treeping-template

Description

Commands in this context define ping timers and thresholds that verify connectivity and the the operational state of the IP interface.

Introduced20.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
Treeping-template
String Length1 to 64

Notes

This element is part of a list key.

Introduced20.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
Treedescription
String Length1 to 80
Introduced20.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
Contextconfigure test-oam icmp ping-template string dot1p number
Treedot1p
Range0 to 7
Default7
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
Contextconfigure test-oam icmp ping-template string dscp keyword
Treedscp
Optionsbe, 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
Default nc1
Introduced20.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
Contextconfigure test-oam icmp ping-template string failure-threshold number
Treefailure-threshold
Range2 to 10
Default3
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
Treeinterval
Range1 to 60
Unitsseconds
Default 60
Introduced20.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
Contextconfigure test-oam icmp ping-template string reactivation-failure-threshold number
Treereactivation-failure-threshold

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.

Range1 to 10
Default4
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
Treereactivation-interval

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.

Range1 to 60
Unitsseconds
Default 1
Introduced20.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
Contextconfigure test-oam icmp ping-template string reactivation-threshold number
Treereactivation-threshold

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.

Range1 to 10
Default3
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
Contextconfigure test-oam icmp ping-template string size number
Treesize
Range12 to 9786
Unitsoctets
Default 56
Introduced20.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
Contextconfigure test-oam icmp ping-template string timeout number
Treetimeout
Range1 to 60
Unitsseconds
Default 5
Introduced20.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
Contextconfigure test-oam icmp ping-template string ttl number
Treettl

Description

This command configures the TTL value used in the outgoing ping packet. The tested interface must be directly connected on the same subnet.

Range1 to 255
Default1
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
Contextconfigure test-oam link-measurement
Treelink-measurement

Description

Commands in this context configure the link measurement template attributes that are inherited on associated IP interfaces for delay reporting to the routing engine.

Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string
Treemeasurement-template

Description

Commands in this context configure the attributes of the measurement template that can be assigned to an IP interface.

Changes can be made without disabling the template, although some modifications cause the test on associated IP interfaces to terminate and restart.

A measurement template can be removed if no interfaces reference it. 

Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string aggregate-sample-window
Treeaggregate-sample-window

Description

Commands in this context configure the attributes of the aggregate sample window used with the measurement template assigned to an IP interface. The aggregate sample window is the collection of sample windows.

Introduced21.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 configure test-oam link-measurement measurement-template string aggregate-sample-window threshold
Treethreshold
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

absolute number
Synopsis Absolute delta for delay measurement reporting
Contextconfigure test-oam link-measurement measurement-template string aggregate-sample-window threshold absolute number
Treeabsolute

Description

This command configures the absolute minimum delta by which a new delay measurement must differ from the previously reported measurement to be reported to the routing engine. 

If an absolute value is not configured the threshold is disabled.

Range1 to 100000
Unitsmicroseconds
Introduced 21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

relative number
Synopsis Relative delta for measurement reporting
Contextconfigure test-oam link-measurement measurement-template string aggregate-sample-window threshold relative number
Treerelative

Description

This command configures the relative minimum delta by which a new delay measurement must differ from the previously reported measurement to be reported to the routing engine.  

If a relative value is not configured, the threshold is disabled.

Range1 to 100
Unitspercent
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
Contextconfigure test-oam link-measurement measurement-template string aggregate-sample-window window-integrity number
Treewindow-integrity

Description

This command configures the percentage value that is used to determine whether the aggregate sample window is integral, by comparing the number of samples received from the sample window to the percentage configured. 

The configured percentage translates to a required sample window count that must be included in the aggregate sample window. The number of samples is computed as follows: 

(window-integrity (%)) x (((aggregate-sample-window length (s)) / (sample-window length (s))) 

If the number of samples in the aggregate sample window is equal to or greater than the computed number of required samples, the sample window has integrity and the aggregate sample window result is compared to the configured sample window thresholds.

If the count is less than the computed number of required samples, the aggregate sample window does not have integrity and the value is not considered as representative. In this case the aggregate sample window results are not compared to the configured sample window thresholds. 

If this parameter is not configured, integrity checking is disabled and all results are compared to the configured thresholds.  

Range1 to 100
Unitspercent
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
Treedelay

Description

This command configures the type of delay measurement statistic used in the sample window and aggregate sample window.

Optionsmin, max, avg
Defaultmin
Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string last-reported-delay-hold number
Treelast-reported-delay-hold

Description

This command configures the timer that specifies the wait time before the last reported delay measurement is flushed after a link measurement test enters the operationally down state.

The aging timer delays the flushing of the last reported delay metric to the routing engine. This timer starts a countdown to zero when an administrative function causes the operational state of the test on that specific interface to transition from up to down. If the timer expires before the operational state transitions to up, the previously reported value is flushed. The Delay Measurement Last Reported indicates “Cleared”. The timestamp indicates the time of the clear event. The Triggered By indicates “Expired”. If the administrative state recovers to operationally up before the expiration of the timer, the previous reported value is not flushed.

The aging timer does not apply to failure conditions that do not affect the administrative state of the interface, for example interface failure or routing changes.

Range0 | 1 to 86400
Unitsseconds
Default 86400
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

reporting boolean
Synopsis Report behavior for values for the configured threshold
Contextconfigure test-oam link-measurement measurement-template string reporting boolean
Treereporting

Description

When configured to true, the system reports a reached threshold to the routing engine.Reaching a configured sample-window or aggregate-sample-window indicates a value of interest.

When configured to false, values reaching thresholds are not reported to the routing engine. In both enabled and disabled cases, the sample-window and aggregate-sample-window information and computed values are stored on the node until overwriting occurs.

Defaulttrue
Introduced22.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
Contextconfigure test-oam link-measurement measurement-template string sample-window
Treesample-window

Description

Commands in this context configure sample window attributes used when the measurement template is assigned to an IP interface. The sample window is the collection of individual probe results over a defined period.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

multiplier number
Synopsis Multiplier of interval used for sample window length
Contextconfigure test-oam link-measurement measurement-template string sample-window multiplier number
Treemultiplier

Description

This command configures the number of probe results that should be in the sample window. For example, a multiplier of 10 and an interval of 5 equals 50 probes being transmitted from an individual sample window. Consequently, 50 probe results are expected within the 50 second duration that the sample window is “In-progress”.

Range1 to 900
Default10
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 configure test-oam link-measurement measurement-template string sample-window threshold
Treethreshold
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

absolute number
Synopsis Absolute delta for delay measurement reporting
Contextconfigure test-oam link-measurement measurement-template string sample-window threshold absolute number
Treeabsolute

Description

This command configures the absolute minimum delta by which a new delay measurement must differ from the previously reported measurement to be reported to the routing engine. 

If an absolute value is not configured the threshold is disabled.

Range1 to 100000
Unitsmicroseconds
Introduced 21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

relative number
Synopsis Relative delta for delay measurement reporting
Contextconfigure test-oam link-measurement measurement-template string sample-window threshold relative number
Treerelative

Description

This command configures the relative minimum delta by which a new delay measurement must differ from the previously reported measurement to be reported to the routing engine.  

If a relative value is not configured, the threshold is disabled.

Range1 to 500
Unitspercent
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
Contextconfigure test-oam link-measurement measurement-template string sample-window window-integrity number
Treewindow-integrity

Description

This command configures the percentage value that is used to determine whether the sample window has enough samples to be considered representative for that window (integrity), by comparing the number of samples received from the sample window to the percentage configured. 

The configured percentage considers the interval of probes and the length of the sample window to determine the number of packets required in the sample:

(window-integrity (%)) x ((sample-window length (s)) / pps per test (interval))

If the count is less than the computed number of required samples, the sample window does not have integrity and the sample window results are not compared to configured sample window thresholds.

If the count is equal to or greater than the computed number of required samples, the sample window has integrity and the aggregate sample window result is compared to the configured sample window thresholds.

If the count is less than the computed number of required samples, the sample window does not have integrity and the value is not considered as representative. In this case the sample window results are not compared to the configured sample window thresholds.  

If this parameter is not configured, integrity checking is disabled and all results are compared to the configured thresholds.

Range1 to 100
Unitspercent
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 configure test-oam link-measurement measurement-template string twamp-light
Treetwamp-light

Description

Commands in this context configure TWAMP Light attributes that are used with the measurement template when assigned to IP interfaces.

Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string twamp-light allow-egress-remark-dscp boolean
Treeallow-egress-remark-dscp

Description

When configured to true, the egress QoS process is able to modify the DSCP based on the egress QoS configuration and expose the DSCP to egress DSCP processing rules. 

When configured to false, the egress QoS process uses the DSCP as configured and bypasses egress QoS DSCP marking.

If the configure qos network egress remark-trusted force-egress-marking command is configured for the network egress QoS profile, the egress QoS process is applied and the DSCP can be overwritten regardless of the allow-egress-remark-dscp configuration.  

Defaultfalse
Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string twamp-light allow-ipv6-udp-checksum-zero boolean
Treeallow-ipv6-udp-checksum-zero

Description

When configured to true, processing of IPv6 packets that arrive with a UDP checksum of zero is allowed. The destination UDP ports that are registered as TWAMP Test packets in the template allow this behavior. 

When configured to false, IPv6 packets that arrive with a UDP checksum of zero are discarded.

Defaultfalse
Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string twamp-light dest-udp-port number
Treedest-udp-port

Description

This command configures the destination UDP port on outbound TWAMP Light measurement packets sent from the session controller. The destination UDP port must match the UDP port value configured on the TWAMP Light reflector that responds to this specific TWAMP Light test.

Range1 to 65535
Default862
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
Contextconfigure test-oam link-measurement measurement-template string twamp-light dscp keyword
Treedscp

Description

This command configures the DSCP to be copied into the IP header of each TWAMP Light echo request packet launched for the test.

Optionsbe, 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
Default nc1
Introduced21.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 packets
Contextconfigure test-oam link-measurement measurement-template string twamp-light fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default h1
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv6-destination-discovery
Synopsis Enter the ipv6-destination-discovery context
Contextconfigure test-oam link-measurement measurement-template string twamp-light ipv6-destination-discovery
Treeipv6-destination-discovery

Description

Commands in this context configure IPv6 discovery of a directly-connected IPv6 peer address.

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

discovery-interval number
Synopsis Transmission frequency for discovery packets
Contextconfigure test-oam link-measurement measurement-template string twamp-light ipv6-destination-discovery discovery-interval number
Treediscovery-interval

Description

This command configures transmission frequency of the discovery packet to the all-routers multicast group (ff02::2) to discover the link-local address of the peer. This frequency is used during the discover-timer interval.

Range1 to 10
Unitsseconds
Default 10
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

discovery-timer number
Synopsis Maximum time to remain in the discovery phase
Contextconfigure test-oam link-measurement measurement-template string twamp-light ipv6-destination-discovery discovery-timer number
Treediscovery-timer

Description

This command configures the amount of time to transmit peer discovery packets at the discovery-interval.

The timer starts when the IPv6 protocols is enabled under the configure router interface if-attribute delay dynamic twamp-light ipv6 context. At the expiration of the discovery-interval or when a peer is discovered, whichever comes first, the probe interval changes to the value configured for the update-interval.

Range1 to 1800
Unitsseconds
Default 60
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

pad-tlv-size number
Synopsis Optional PAD TLV size
Context configure test-oam link-measurement measurement-template string twamp-light pad-tlv-size number
Treepad-tlv-size

Description

This command enables a STAMP PDU to include the PAD TLV. This increases the size of the STAMP PDU by the size of the added TLV. The PAD TLV includes an all zeros pattern.

Range4 to 9714
Unitsbytes
Introduced 22.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
Contextconfigure test-oam link-measurement measurement-template string twamp-light profile keyword
Treeprofile

Description

This command specifies if the packets should be treated as in or out of profile as they move through the local node.

Optionsin, out
Default in
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

return-path
Synopsis Enter the return-path context
Context configure test-oam link-measurement measurement-template string twamp-light return-path
Treereturn-path

Description

Commands in this context configure the return-path TLV carried in the STAMP PDU.  

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

link boolean
Synopsis The Return Path sub-TLV specifying link
Contextconfigure test-oam link-measurement measurement-template string twamp-light return-path link boolean
Treelink

Description

When configured to true, the system includes the return-path TLV link. The link sub-tlv instructs a Session-Reflector configured for type stamp to use the receiving logical IP interface for the transmission of the response packet from the reflector to the session-sender. The destination of the reflected packet must be installed in the forwarding table and reachable out the IP interface or the packet is dropped by the Session-Reflector. When there are parallel non-equal cost return paths between the Session-Reflector and the Session-Sender the response packet can only be returned on the lowest cost path.

When configured to false, the Return Path TLV carried in the STAMP PDU is not included with the test packet.

Defaultfalse
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

src-udp-port number
Synopsis Fixed source UDP port for link measurement tests
Contextconfigure test-oam link-measurement measurement-template string twamp-light src-udp-port number
Treesrc-udp-port

Description

This command specifies a source UDP port for link measurement tests.

Unless required, Nokia suggests that the link measurement dynamically select an available source UDP port from the dynamic range. Before a UDP port in the configurable range can be configured as a source it must be owned by the application. Use the configure test-oam twamp twamp-light source-udp-port-pools port pool-type command to map the port range to the application.

By default a source UDP port allocates from the dynamic range. The configuration of the source port should only be configured when required for interoperability. When the source IP, destination IP, and destination UPD port are the same for a test, the source UDP port must be different in order to uniquely identify the session.

Range64374 to 64383
Introduced22.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
Contextconfigure test-oam link-measurement measurement-template string twamp-light timestamp-format keyword
Treetimestamp-format

Description

This command configures the format of the timestamp used in the TWAMP Light PDU and places the requested timestamp format in the packet using the appropriate epoch. This is unrelated to any time distribution protocol used to synchronize time between clocks.

Optionsntp, ptp
Default ntp
Introduced21.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
Contextconfigure test-oam link-measurement measurement-template string unidirectional-measurement keyword
Treeunidirectional-measurement

Description

This command specifies the unidirectional delay computation method as the actual forward delay (calculated using T2-T1 timestamps) or as derived using the round-trip delay divided by two (required if nodal clocks are not synchronized using an accurate time-synchronization method or protocol such as PTP).

Optionsderived, actual
Default derived
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

mpls

Synopsis Enter the mpls context
Context configure test-oam mpls
Treempls
Introduced23.7.R1

Platforms

All

echo-request-downstream-map keyword
Synopsis Format of the downstream mapping TLV
Context configure test-oam mpls echo-request-downstream-map keyword
Treeecho-request-downstream-map

Description

This command specifies the format of the downstream mapping TLV to use in all LSP trace packets and LDP tree trace packets originated on this node.

The following downstream mapping TLVs are supported: the original Downstream Mapping (DSMAP) TLV, defined in RFC 4379 (obsoleted by RFC 8029) and the Downstream Detailed Mapping (DDMAP) TLV, defined in RFC 6424.

See the "DDMAP TLV" section in the 7450 ESS, 7750 SR, 7950 XRS, and VSR OAM and Diagnostics Guide for more information.

Optionsdsmap, ddmap
Default dsmap
Introduced23.7.R1

Platforms

All

timestamp-format keyword
Synopsis Timestamp format for MPLS ping request and reply PDUs
Contextconfigure test-oam mpls timestamp-format keyword
Treetimestamp-format
Optionsrfc4379, unix
Default unix
Introduced23.7.R1

Platforms

All

mpls-dm

Synopsis Enter the mpls-dm context
Context configure test-oam mpls-dm
Treempls-dm
Introduced16.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
Contextconfigure test-oam mpls-dm admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R6

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

service-activation-testhead

Synopsis Enter the service-activation-testhead context
Contextconfigure test-oam service-activation-testhead
Treeservice-activation-testhead

Description

Commands in this context configure service activation launch parameters for the testhead function.

This functionality is supported on FP4 and later platforms.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

acceptance-criteria-template [ac-template-name] string
Synopsis Enter the acceptance-criteria-template list instance
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string
Treeacceptance-criteria-template

Description

Commands in this context configure the test acceptance criteria policy that the service test testhead OAM tool uses to determine the test result after test completion.

The “default” value of this command is attached to every service-stream created under the service-test context for which no explicit acceptance criteria template policy is configured by the user.

The default acceptance criteria template is not user-configurable.

The default template does not set thresholds and only reports the end-of-run values.

Max. Instances100
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

cir-threshold number
Synopsis CIR threshold
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string cir-threshold number
Treecir-threshold

Description

This command configures a CIR value that is compared to the measured results for the CIR test types. If the measured value is equal to or greater than the configured value, the test passes; otherwise, it fails. For more information, see the m-factor command.

Range1 to 400000000
Unitskilobps
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

delay-threshold number
Synopsis Delay threshold configuration for acceptance criteria template
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string delay-threshold number
Treedelay-threshold

Description

This command configures a delay value that is compared to the measured delay at the end of the test to declare the test result. If the measured value is greater than the configured value, the test fails; otherwise, it passes. A measured delay value of zero also causes the test to fail.

Range1 to 100000000
Unitsmicroseconds
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

delay-var-threshold number
Synopsis Delay variation threshold configuration for acceptance criteria template
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string delay-var-threshold number
Treedelay-var-threshold

Description

This command configures a delay variation value that is compared to the measured delay variation at the end of the test to declare the test result. If the measured value is greater than the configured value, the test fails; otherwise, it passes.

Range1 to 100000000
Unitsmicroseconds
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

loss-threshold decimal-number
Synopsis Loss threshold for acceptance criteria template
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string loss-threshold decimal-number
Treeloss-threshold

Description

This command configures a frame loss ratio (FLR) value that is compared to the measured FLR at the end of the test to determine the test result. If the measured value is greater than the configured value, the test fails; otherwise, it passes. Thresholds must be explicitly configured to use them for the comparison.

The FLR is computed as a ratio of the difference of the number of received frames to the number of injected or sent frames divided by the number of sent frames.

Range0.0000 to 100.0000
Unitspercent
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

loss-threshold-policing decimal-number
Synopsis Frame loss ratio for a policing test
Context configure test-oam service-activation-testhead acceptance-criteria-template string loss-threshold-policing decimal-number
Treeloss-threshold-policing

Description

This command configures a frame loss ratio (FLR) value for a policing test. The value is compared to the measured FLR at the end of the test to determine the test result. If the measured value is greater than the configured value, the test fails; otherwise, it passes.

Thresholds must be explicitly configured before they can be used for comparison. The FLR is computed as a ratio of the difference of the number of received frames to the number of injected or sent frames divided by the number of sent frames.

Range0.0000 to 100.0000
Unitspercent
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

m-factor number
Synopsis Throughput margin configuration
Context configure test-oam service-activation-testhead acceptance-criteria-template string m-factor number
Treem-factor

Description

This command configures the margin by which the observed throughput is off from the configured throughput to determine whether a service test passes or fails.

The M-factor is used with the CIR threshold and PIR threshold values for different test types to determine whether a test passes or fails.

type cir

  • If the measured throughput is less than the difference of the configured CIR threshold and the M-factor, the test fails.

type cir-pir

  • If the measured throughput is less than the difference of the configured PIR threshold and the M-factor, the test fails.

type policing

  • If the measured throughput is less than the difference of the configured PIR threshold and the M-factor, the test fails.

  • If the measured throughput is greater than the sum of the configured PIR threshold and the M-factor, the test fails.

type performance

  • If the measured throughput is less than the difference of the configured PIR threshold and the M-factor, the test fails.

Range1 to 400000000
Unitskilobps
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

pir-threshold number
Synopsis PIR threshold
Contextconfigure test-oam service-activation-testhead acceptance-criteria-template string pir-threshold number
Treepir-threshold

Description

This command configures a PIR value that is compared to the measured results for the cir-pir, policing, and performance test types. If the measured value is equal to or greater than the configured value, the test passes; otherwise, it fails. For more information, see the m-factor command.

Range1 to 400000000
Unitskilobps
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

frame-size-template [fs-template-name] string
Synopsis Enter the frame-size-template list instance
Contextconfigure test-oam service-activation-testhead frame-size-template string
Treeframe-size-template

Description

Commands in this context create a template to configure frames of different sizes for use with a test stream configured under the service-test command. The ITU-T Y.1564 methodology designates the letters “a” to “h” for a default frame size. The default frame size can be overwritten.

Max. Instances100
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

service-test [test-name] string
Synopsis Enter the service-test list instance
Contextconfigure test-oam service-activation-testhead service-test string
Treeservice-test

Description

Commands in this context configure the service test parameters.

Max. Instances500
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

accounting-policy reference
Synopsis Accounting policy to record service test results
Contextconfigure test-oam service-activation-testhead service-test string accounting-policy reference
Treeaccounting-policy

Description

This command creates a link to an accounting policy for the specified service test. The record of the accounting policy must be set to complete-service-activation-test.

Reference

configure log accounting-policy number

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

service-stream [stream-id] number
Synopsis Enter the service-stream list instance
Contextconfigure test-oam service-activation-testhead service-test string service-stream number
Treeservice-stream

Description

Commands in this context configure a service stream profile for the specified service test.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

acceptance-criteria-template reference
WARNING:

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

SynopsisAcceptance criteria association to a service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number acceptance-criteria-template reference
Treeacceptance-criteria-template

Description

This command creates a link to an acceptance criteria template policy configured by the user for the specified service stream.

Assign the "default" acceptance criteria template to remove the existing template in a service stream.

Reference

configure test-oam service-activation-testhead acceptance-criteria-template string

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

frame-mix
WARNING:

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

SynopsisEnter the frame-mix context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-mix
Treeframe-mix

Description

Commands in this context configure frame mixing for the specified service stream by referencing the frame size template.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

frame-size-template reference
WARNING:

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

SynopsisFrame size template for the service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-mix frame-size-template reference
Treeframe-size-template

Description

This command configures the frame size template for the specified service stream.

The user can assign the default frame-size-tmpl-name “default” to remove the existing template in a service stream.

Reference

configure test-oam service-activation-testhead frame-size-template string

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

sequence string
WARNING:

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

SynopsisSequence of frame sizes for the service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-mix sequence string
Treesequence

Description

This command configures the frame sequence for the specified service stream by referencing the frame-size-template configuration.

String Length1 to 16
Defaulta
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

frame-payload
WARNING:

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

SynopsisEnter the frame-payload context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload
Treeframe-payload

Description

Commands in this context configure packet header information used in frames generated by the testhead function.

Only the specified header information is included in the frame. At a minimum, the user must configure the Ethernet destination MAC address and ETH-CFM information to include in the frame payload configuration.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

data-pattern
WARNING:

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

SynopsisEnter the data-pattern context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload data-pattern
Treedata-pattern

Description

Commands in this context configure the data pattern to populate the payload portion of the frame generated by the service activation testhead.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

repeat (hex-string | number)
WARNING:

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

SynopsisRepeated 4-byte pattern to pad each packet sent
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload data-pattern repeat (hex-string | number)
Treerepeat

Description

This command configures the data pattern padding bytes for the frames launched for the service stream.

The specified data pattern value is repeated as many times as required to fill the remaining length of the payload for the highest level of the specified PDU. If only the Ethernet and ETH-CFM information is added, the data pattern is included in the data TLV of the ETH-CFM frame.

String Length10
Max. Range0 to 4294967295
Default0x00000000
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

ethernet
WARNING:

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

SynopsisEnter the ethernet context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet
Treeethernet

Description

Commands in this context configure the Ethernet header parameters and ETH-CFM information used by the testhead tool.

Only the specified header information is included in the frame. At a minimum, Ethernet MAC address and ETH-CFM information must be included.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

c-tag
WARNING:

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

SynopsisEnter the c-tag context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet c-tag
Treec-tag

Description

Commands in this context configure the customer VLAN tag (c-tag) information.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

discard-eligible boolean
WARNING:

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

SynopsisEnable marking of the DEI bit in the VLAN header
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet c-tag discard-eligible boolean
Treediscard-eligible

Description

When configured to true, the frame is discard eligible.

Defaultfalse
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

dot1p number
WARNING:

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

SynopsisPCP of Ethernet frames for service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet c-tag dot1p number
Treedot1p

Description

This command configures the priority code point (dot1p) value for the VLAN.

Range0 to 7
Default7
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

dst-mac string
WARNING:

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

SynopsisDestination MAC address of Ethernet frames
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet dst-mac string
Treedst-mac

Description

This command configures the unicast destination MAC address to use in the frame generated by the service activation testhead.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

eth-cfm
WARNING:

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

SynopsisEnter the eth-cfm context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet eth-cfm
Treeeth-cfm

Description

Commands in this context configure ETH-CFM source MEP, destination MAC, and the ETH-CFM PDU type to carry the service activation stream.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

source
WARNING:

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

SynopsisEnter the source context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet eth-cfm source
Treesource

Description

Commands in this context define the source launch maintenance association end point (MEP) for service activation. If a MEP that matches this configuration does not exist, the service activation test does not start.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

ma-admin-name reference
WARNING:

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

SynopsisSource Ethernet maintenance association name
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet eth-cfm source ma-admin-name reference
Treema-admin-name

Reference

configure eth-cfm domain string association string

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

s-tag
WARNING:

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

SynopsisEnter the s-tag context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet s-tag
Trees-tag

Description

Commands in this context configure service VLAN tag (s-tag) information specification.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

discard-eligible boolean
WARNING:

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

SynopsisEnable marking of the DEI bit in the VLAN header
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet s-tag discard-eligible boolean
Treediscard-eligible

Description

When configured to true, the frame is discard eligible.

Defaultfalse
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

dot1p number
WARNING:

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

SynopsisPCP of Ethernet frames for service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number frame-payload ethernet s-tag dot1p number
Treedot1p

Description

This command configures the priority code point (dot1p) value for the VLAN.

Range0 to 7
Default7
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

rate-cir number
WARNING:

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

SynopsisCIR packet transmit rate for the service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number rate-cir number
Treerate-cir

Description

This command configures the CIR that must be validated for a specific stream. If configured, the PIR value must be equal to or greater than the CIR value.

When specified, the CIR rate overrides the default CIR value. The configured value must be a positive integer; fractional values are not allowed. If this command is not executed, or the CIR parameter is not explicitly specified, the default CIR value applies.

The service activation testhead generates traffic up to the specified rate based on the test-types command, as follows.

  • For type cir, traffic is generated at a rate up to the configured CIR.

  • For type cir-pir, traffic is generated at a rate up to the configured PIR.

  • For type policing, traffic is generated at a rate up to 125% of the configured PIR.

  • For type performance, traffic is generated at a rate up to the configured PIR.

Range0 to 400000000
Unitskilobps
Default 0
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

rate-pir number
WARNING:

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

SynopsisPIR packet transmit rate for the service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number rate-pir number
Treerate-pir

Description

This command specifies the PIR rate, which overrides the default administrative PIR value. The configured value must be a positive integer; fractional values are not allowed. If this command is not executed or the PIR parameter is not explicitly specified, the default PIR value applies.

The service activation testhead generates traffic up to the specified rate based on the test-types command, as follows.

  • For type cir, traffic is generated at a rate up to the configured CIR.

  • For type cir-pir, traffic is generated at a rate up to the configured PIR.

  • For type policing, traffic is generated at a rate up to 125% of the configured PIR.

  • For type performance, traffic is generated at a rate up to the configured PIR.

Range0 to 400000000
Unitskilobps
Default 0
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

test-types
WARNING:

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

SynopsisEnter the test-types context
Contextconfigure test-oam service-activation-testhead service-test string service-stream number test-types
Treetest-types

Description

Commands in this context configure the types of tests to perform on a specific service stream.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

cir boolean
WARNING:

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

SynopsisEnable running a CIR test for the service stream
Contextconfigure test-oam service-activation-testhead service-test string service-stream number test-types cir boolean
Treecir
Defaultfalse
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

test-duration
Synopsis Enter the test-duration context
Contextconfigure test-oam service-activation-testhead service-test string test-duration
Treetest-duration

Description

Commands in this context configure the test duration for the various functional test types.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

cir
Synopsis Enter the cir context
Context configure test-oam service-activation-testhead service-test string test-duration cir
Treecir

Description

Commands in this context configure the duration for the CIR test type.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

cir-pir
Synopsis Enter the cir-pir context
Context configure test-oam service-activation-testhead service-test string test-duration cir-pir
Treecir-pir

Description

Commands in this context configure the duration for the CIR-PIR test type.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

performance
Synopsis Enter the performance context
Context configure test-oam service-activation-testhead service-test string test-duration performance
Treeperformance

Description

Commands in this context configure the duration for the performance test type.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

policing
Synopsis Enter the policing context
Context configure test-oam service-activation-testhead service-test string test-duration policing
Treepolicing

Description

Commands in this context configure the duration for the policing test type.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

twamp

Synopsis Enter the twamp context
Context configure test-oam twamp
Treetwamp
Introduced16.0.R4

Platforms

All

server
Synopsis Enter the server context
Context configure test-oam twamp server
Treeserver
Introduced16.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
Contextconfigure test-oam twamp server admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

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 a zero UDP checksum
Contextconfigure test-oam twamp server allow-ipv6-udp-checksum-zero boolean
Treeallow-ipv6-udp-checksum-zero

Description

When configured to true, this command configures the acceptance of IPv6 packets with UDP checksums of 0. This optional configuration allows the router to process arriving IPv6 TWAMP Test packets that contain IPv6 UDP checksum of 0x0000. The UDP port specific to this TWAMP Light test bypasses the default discard IPv6 UDP checksum 0x0000. If this optional command is not configured, IPv6 UDP checksum 0x000 arriving packets are discarded.

When configured to false, packets that arrive with an IPv6 UDP checksum of 0x0000 are discarded.

Defaultfalse
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

enforce-test-session-start-time boolean
Synopsis Discard TWAMP packets before test-session start time
Contextconfigure test-oam twamp server enforce-test-session-start-time boolean
Treeenforce-test-session-start-time

Description

When configured to true, the router checks the signalled test-session start time against the server time and discards TWAMP test packets that arrive before the negotiated test-session start time.

When configured to false, the router processes all TWAMP test packets without checking the test-session start time against the server time.

Defaulttrue
Introduced23.3.R1

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.

SynopsisInactivity timeout for TWAMP control connections
Contextconfigure test-oam twamp server inactivity-timeout number
Treeinactivity-timeout
Range60 to 3600
Unitsseconds
Default 900
Introduced16.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.

SynopsisLimit of concurrent TWAMP server control connections
Contextconfigure test-oam twamp server max-connections number
Treemax-connections
Range0 to 64
Default32
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.

SynopsisMaximum number of concurrent TWAMP server test sessions
Contextconfigure test-oam twamp server max-sessions number
Treemax-sessions
Range0 to 128
Default32
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
Contextconfigure test-oam twamp server prefix (ipv4-prefix | ipv6-prefix)
Treeprefix
Max. Instances100
Introduced16.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
Contextconfigure test-oam twamp server prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is part of a list key.

Introduced16.0.R4

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 twamp server prefix (ipv4-prefix | ipv6-prefix) description string
Treedescription
String Length1 to 80
Introduced16.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
Contextconfigure test-oam twamp server prefix (ipv4-prefix | ipv6-prefix) max-connections number
Treemax-connections
Range0 to 64
Default32
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
Contextconfigure test-oam twamp server prefix (ipv4-prefix | ipv6-prefix) max-sessions number
Treemax-sessions
Range0 to 128
Default32
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 configure test-oam twamp twamp-light
Treetwamp-light
Introduced16.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
Contextconfigure test-oam twamp twamp-light inactivity-timeout number
Treeinactivity-timeout
Range10 to 100
Unitsseconds
Default 100
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

source-udp-port-pools
Synopsis Enter the source-udp-port-pools context
Contextconfigure test-oam twamp twamp-light source-udp-port-pools
Treesource-udp-port-pools
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

port [port-number] number
Synopsis Enter the port list instance
Context configure test-oam twamp twamp-light source-udp-port-pools port number
Treeport
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

[port-number] number
Synopsis Source UDP port pools port number
Context configure test-oam twamp twamp-light source-udp-port-pools port number
Treeport
Range64374 to 64383

Notes

This element is part of a list key.

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

pool-type keyword
Synopsis Pool type of an application pool
Context configure test-oam twamp twamp-light source-udp-port-pools port number pool-type keyword
Treepool-type

Description

This command maps the specified source UDP port to the TWAMP Light application allowed to configure the source UDP port. OAM-PM IP tests can only configure the source UDP port when the port pool UDP source port is configured with a pool-type oam-pm. The test-oam link-measurement measurement-template can only configure the src-udp-port when the port pool UDP source port is configured with pool-type link-measurement.

A pool type cannot be changed if its current application is a test (either an oam-pm session or link-measurement template) and is configured to use the specified port, regardless of the administrative or operational state. The configuration reference linking to the source UDP prevents the change.

Optionsoam-pm, link-measurement
Defaultoam-pm
Introduced 22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS