Global commands

Global commands are used for operational functions, such as entering configuration sessions, navigating the CLI, executing OAM commands, and logging into remote hosts.

back number
bof 
exclusive 
private 
read-only 
configure 
exclusive 
global 
private 
read-only 
debug 
exclusive 
private 
read-only 
delete string
edit-config 
bof 
debug 
exclusive 
global 
li 
private 
read-only 
enable 
exec string
echo 
exit 
all 
history 
info keyword
[cli-path] string
converted 
depth number
detail 
differences 
flat 
full-context 
inheritance 
json 
model keyword
units 
values 
xml 
li 
exclusive 
private 
read-only 
logout 
oam 
efm 
local-loopback 
[action] keyword
port-id string
remote-loopback 
[action] keyword
port-id string
eth-cfm 
eth-test 
data-length number
[destination] (mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
linktrace 
[destination] (mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
ttl number
loopback 
[destination] (mac-unicast-address-no-zero | keyword | number)
interval number
lbm-padding number
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
send-count number
size number
timeout number
one-way-delay-test 
[destination] (mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
two-way-delay-test 
[destination] (mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
two-way-slm-test 
[destination] (mac-unicast-address-no-zero | number)
interval (number | decimal-number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
send-count number
size number
timeout number
lsp-ping 
bgp-label 
fc keyword
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
ldp 
fc keyword
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
rsvp-te 
fc keyword
interval number
lsp-name reference
path reference
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
sr-isis 
fc keyword
flex-algo number
igp-instance number
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
sr-ospf 
fc keyword
flex-algo number
igp-instance number
interface reference
interval number
next-hop string
path-destination string
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
size number
source-ip-address string
timeout number
ttl number
sr-ospf3 
fc keyword
igp-instance number
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
sr-policy 
color number
endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
fc keyword
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
profile keyword
segment-list number
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
sr-te 
fc keyword
interface reference
interval number
lsp-name reference
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path reference
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
profile keyword
send-count number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ttl number
lsp-trace 
bgp-label 
downstream-map-tlv keyword
fc keyword
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
ldp 
downstream-map-tlv keyword
fc keyword
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
rsvp-te 
downstream-map-tlv keyword
fc keyword
interval number
lsp-name reference
max-fail number
max-ttl number
min-ttl number
output-format keyword
path reference
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
sr-isis 
downstream-map-tlv keyword
fc keyword
flex-algo number
igp-instance number
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
sr-ospf 
downstream-map-tlv keyword
fc keyword
flex-algo number
igp-instance number
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop string
output-format keyword
path-destination string
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
profile keyword
size number
source-ip-address string
timeout number
sr-ospf3 
downstream-map-tlv keyword
fc keyword
igp-instance number
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
sr-policy 
color number
downstream-map-tlv keyword
endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
fc keyword
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
probe-count number
profile keyword
segment-list number
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
sr-te 
downstream-map-tlv keyword
fc keyword
interface reference
interval number
lsp-name reference
max-fail number
max-ttl number
min-ttl number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
path reference
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
probe-count number
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
timeout number
oam-pm 
action keyword
session reference
test-type keyword
saa 
owner reference test reference
start 
accounting boolean
stop 
accounting boolean
service-activation-testhead 
service-test reference
start 
stop 
password 
ping 
bypass-routing 
candidate-path 
color number
count number
[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
distinguisher number
do-not-fragment 
endpoint string
fc keyword
interface (reference | reference | reference | reference | reference)
interval (number | decimal-number)
next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
pattern (keyword | number)
preference number
protocol-owner keyword
router-instance (reference | reference)
segment-list number
size number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
srv6-policy 
subscriber string
timeout number
tos number
ttl number
pwc 
[path-type] keyword
previous 
pyexec (string | string)
[argument-01] string
[argument-02] string
[argument-03] string
[argument-04] string
[argument-05] string
[argument-06] string
[argument-07] string
[argument-08] string
[argument-09] string
[argument-10] string
quit-config 
ssh 
[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
key-re-exchange 
mbytes (number | keyword)
minutes (number | keyword)
login-name string
router-instance (string | string)
telnet 
[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
port number
router-instance (string | string)
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
top 
traceroute 
candidate-path 
color number
decode keyword
dest-port number
dest-port-udp-fixed 
[destination] (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
detail 
distinguisher number
endpoint string
min-ttl number
numeric 
preference number
probe-count number
protocol keyword
protocol-owner keyword
router-instance string
segment-list number
size number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
srv6-policy 
tos number
ttl number
wait number
tree 
[cli-path] string
detail 
flat 

Global command descriptions

back [levels] number

Synopsis Move back one or more levels
Context back number
Treeback
Introduced16.0.R1

Platforms

All

[levels] number

Synopsis Number of levels to move up
Context back number
Treeback
Range1 to 4294967295
MD-CLI Default1

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

bof

Synopsis Enter a candidate configuration mode
Context bof
Tree bof
Introduced20.10.R1

Platforms

All

exclusive

Synopsis Enter exclusive configuration mode
Context bof exclusive
Treeexclusive
Introduced20.10.R1

Platforms

All

private

Synopsis Enter private configuration mode
Context bof private
Treeprivate
Introduced20.10.R1

Platforms

All

read-only

Synopsis Enter read-only configuration mode
Context bof read-only
Treeread-only
Introduced20.10.R1

Platforms

All

configure

Synopsis Enter a candidate configuration mode
Context configure
Treeconfigure
Introduced16.0.R2

Platforms

All

global

Synopsis Enter global configuration mode
Context configure global
Treeglobal
Introduced16.0.R2

Platforms

All

private

Synopsis Enter private configuration mode
Context configure private
Treeprivate
Introduced16.0.R4

Platforms

All

debug

Synopsis Enter a candidate configuration mode
Context debug
Tree debug
Introduced21.5.R1

Platforms

All

exclusive

Synopsis Enter exclusive configuration mode
Context debug exclusive
Treeexclusive
Introduced21.5.R1

Platforms

All

private

Synopsis Enter private configuration mode
Context debug private
Treeprivate
Introduced21.5.R1

Platforms

All

read-only

Synopsis Enter read-only configuration mode
Context debug read-only
Treeread-only
Introduced21.5.R1

Platforms

All

delete [cli-path] string

Synopsis Delete an element
Context delete string
Treedelete
Introduced16.0.R1

Platforms

All

[cli-path] string

Synopsis Absolute path or relative path from pwc
Contextdelete string
Treedelete

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

edit-config

Synopsis Enter a configuration mode
Context edit-config
Treeedit-config
Introduced16.0.R1

Platforms

All

bof

Synopsis Enter the bof configuration context
Context edit-config bof
Treebof
Introduced20.10.R1

Platforms

All

debug

Synopsis Enter the debug configuration context
Contextedit-config debug
Treedebug
Introduced21.5.R1

Platforms

All

global

Synopsis Enter global configuration mode
Context edit-config global
Treeglobal
Introduced16.0.R1

Platforms

All

li

Synopsis Enter the li configuration context
Context edit-config li
Treeli
Introduced19.10.R1

Platforms

All

enable

Synopsis Enable administrative mode
Context enable
Tree enable
Introduced20.2.R1

Platforms

All

exec [url] string

Synopsis Execute commands from a file
Context exec string
Treeexec
Introduced16.0.R1

Platforms

All

[url] string

Synopsis Location of the file to be executed
Context exec string
Treeexec

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

echo

Synopsis Display the commands as they are being executed
Contextexec string echo
Treeecho
Introduced16.0.R1

Platforms

All

exit

Synopsis Return to the previous context or to operational root
Contextexit
Treeexit
Introduced16.0.R1

Platforms

All

all

Synopsis Return to the root context
Context exit all
Treeall
Introduced16.0.R1

Platforms

All

history

Synopsis Show the command history
Context history
Tree history
Introduced16.0.R1

Platforms

All

info [from] keyword

Synopsis Show the information under the present working context
Contextinfo keyword
Treeinfo
Introduced16.0.R1

Platforms

All

[from] keyword

Synopsis Source datastore
Context info keyword
Treeinfo

Description

This command specifies the source datastore. This option is not supported for state elements.

Options

candidate – The candidate datastore

running – The running datastore

baseline – The baseline candidate configuration

intended – The intended datastore

MD-CLI Defaultcandidate

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

[cli-path] string

Synopsis Absolute path or relative path from pwc
Contextinfo keyword [cli-path] string
Tree[cli-path]
Introduced20.10.R1

Platforms

All

converted

Synopsis Include converted third-party model configuration from the running datastore
Contextinfo keyword converted
Treeconverted

Description

This option specifies the inclusion of converted configuration values from third party models in the output and is only available when configure system management-interface yang-modules openconfig-modules is set to true.

This option should only be used in the configure region when third party models are used. The output with this option is the same as info when used in other configuration regions.

This option is not supported for state elements.

Introduced16.0.R1

Platforms

All

depth number

Synopsis Depth limit from the pwc
Context info keyword depth number
Treedepth
Range1 to 4294967040
Introduced23.10.R1

Platforms

All

detail

Synopsis Include default and unconfigured values
Contextinfo keyword detail
Treedetail
Introduced16.0.R1

Platforms

All

differences

Synopsis Show the different values each model tries to set
Contextinfo keyword differences
Treedifferences

Description

When specified, this command shows only the values that are different when multiple models set the same configuration element.

Notes

The following elements are part of a choice: differences, model, or values.

Introduced23.3.R1

Platforms

All

flat

Synopsis Show the context from the pwc on each line
Contextinfo keyword flat
Treeflat

Description

This option shows the hierarchy on each line starting from the present working context.

Notes

The following elements are part of a choice: flat, json, or xml.

Introduced16.0.R1

Platforms

All

inheritance

Synopsis Include configuration inherited from configuration groups
Contextinfo keyword inheritance
Treeinheritance

Description

This option specifies the inclusion of configuration inherited from configuration groups in the output.

This option should only be used in the configure region when configuration groups are used. The output with this option is the same as info when used in other configuration regions.

This option is not supported for state elements.

Introduced16.0.R1

Platforms

All

json

Synopsis Show the output in indented JSON IETF format
Contextinfo keyword json
Treejson

Notes

The following elements are part of a choice: flat, json, or xml.

Introduced19.10.R1

Platforms

All

model keyword

Synopsis Data model for which to display converted output
Contextinfo keyword model keyword
Treemodel

Description

This option specifies the data model for which to display the converted output.

This option is only supported with the converted option and is only available when configure system management-interface yang-modules openconfig-modules is set to true.

Options

all – All models

openconfig – OpenConfig models

Defaultall

Notes

The following elements are part of a choice: differences, model, or values.

Introduced20.7.R1

Platforms

All

units

Synopsis Include unit types for applicable elements
Contextinfo keyword units
Treeunits
Introduced20.5.R1

Platforms

All

values

Synopsis Show all the values each model tries to set
Contextinfo keyword values
Treevalues

Description

When specified, this command shows all the values that each model tries to set.

Notes

The following elements are part of a choice: differences, model, or values.

Introduced23.3.R1

Platforms

All

xml

Synopsis Show the output in indented XML format
Contextinfo keyword xml
Treexml

Notes

The following elements are part of a choice: flat, json, or xml.

Introduced20.7.R1

Platforms

All

li

Synopsis Enter a candidate configuration mode
Context li
Tree li
Introduced19.10.R1

Platforms

All

exclusive

Synopsis Enter exclusive configuration mode
Context li exclusive
Treeexclusive
Introduced19.10.R1

Platforms

All

private

Synopsis Enter private configuration mode
Context li private
Treeprivate
Introduced19.10.R1

Platforms

All

read-only

Synopsis Enter read-only configuration mode
Context li read-only
Treeread-only
Introduced19.10.R1

Platforms

All

logout

Synopsis Exit the CLI session
Context logout
Tree logout
Introduced16.0.R1

Platforms

All

oam

Synopsis Perform OAM tests
Context oam
Tree oam
Introduced20.2.R1

Platforms

All

efm

Synopsis Enter the efm context
Context oam efm
Treeefm
Introduced20.2.R1

Platforms

All

local-loopback
Synopsis Start or stop local loopback test on a port
Contextoam efm local-loopback
Treelocal-loopback
Introduced20.2.R1

Platforms

All

[action] keyword
Synopsis Action type for the test
Context oam efm local-loopback [action] keyword
Tree[action]
Optionsstart, stop

Notes

This element is mandatory.

Introduced 20.2.R1

Platforms

All

remote-loopback
Synopsis Start or stop remote loopback test on a port
Contextoam efm remote-loopback
Treeremote-loopback
Introduced20.2.R1

Platforms

All

[action] keyword
Synopsis Action type for the test
Context oam efm remote-loopback [action] keyword
Tree[action]
Optionsstart, stop

Notes

This element is mandatory.

Introduced 20.2.R1

Platforms

All

eth-cfm

Synopsis Initiate an Ethernet Connectivity Fault Management test
Contextoam eth-cfm
Treeeth-cfm
Introduced20.2.R1

Platforms

All

eth-test
Synopsis Initiate an OAM ETH-CFM test
Context oam eth-cfm eth-test
Treeeth-test
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm eth-test [destination] (mac-unicast-address-no-zero | number)
Tree[destination]
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

ma-admin-name reference
Synopsis Association name
Context oam eth-cfm eth-test ma-admin-name reference
Treema-admin-name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm eth-test mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

priority number
Synopsis Frame priority that can be manipulated by QoS policies
Contextoam eth-cfm eth-test priority number
Treepriority
Range0 to 7
Default7
Introduced 20.2.R1

Platforms

All

linktrace
Synopsis Initiate a linktrace test
Context oam eth-cfm linktrace
Treelinktrace
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm linktrace [destination] (mac-unicast-address-no-zero | number)
Tree[destination]
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

ma-admin-name reference
Synopsis Association name
Context oam eth-cfm linktrace ma-admin-name reference
Treema-admin-name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm linktrace mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

ttl number
Synopsis Time to live for a returned linktrace
Contextoam eth-cfm linktrace ttl number
Treettl
Range0 to 255
Default64
Introduced 20.2.R1

Platforms

All

loopback
Synopsis Initiate a loopback test
Context oam eth-cfm loopback
Treeloopback
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | keyword | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm loopback [destination] (mac-unicast-address-no-zero | keyword | number)
Tree[destination]
Range1 to 8191
Options

multicast – Class one destination multicast address based on the level of the local MEP

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

interval number
Synopsis Time between probes within the test run
Contextoam eth-cfm loopback interval number
Treeinterval
Range0 to 600
Unitsdeciseconds
Default 0
Introduced20.2.R1

Platforms

All

lbm-padding number
Synopsis Data portion size of the data TLV, no octet string
Contextoam eth-cfm loopback lbm-padding number
Treelbm-padding

Description

This command specifies the size of the data portion of the data TLV which does not allow for an optional octet string.

MSDU is not processed when setting is in use. A value of 0 means that no data TLV is added to the packet. This is specified with an octet string. This parameter and size are mutually exclusive.

Range0 | 3 to 9778
Default0
Introduced 20.2.R1

Platforms

All

ma-admin-name reference
Synopsis Association name
Context oam eth-cfm loopback ma-admin-name reference
Treema-admin-name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm loopback mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

priority number
Synopsis Frame priority that can be manipulated by QoS policies
Contextoam eth-cfm loopback priority number
Treepriority
Range0 to 7
Introduced20.2.R1

Platforms

All

size number
Synopsis Data portion size of the data TLV, octet string allowed
Contextoam eth-cfm loopback size number
Treesize

Description

This command specifies the size of the data portion of the data TLV allowing for an optional octet string to be included.

A value of 0 means that no data TLV is added to the packet. This parameter and lbm-padding are mutually exclusive.

Range0 to 1500
Unitsbytes
Default 0
Introduced20.2.R1

Platforms

All

timeout number
Synopsis Wait time for a reply to a sent message request
Contextoam eth-cfm loopback timeout number
Treetimeout

Description

This command specifies the time the router waits for a message reply after sending a message request.

Upon expiration of the timeout, the router assumes that the message response is not received. Any response received after the timeout is silently discarded.

Range1 to 10
Unitsseconds
Default 5
Introduced20.2.R1

Platforms

All

one-way-delay-test
Synopsis Initiate a one-way delay test
Context oam eth-cfm one-way-delay-test
Treeone-way-delay-test
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm one-way-delay-test [destination] (mac-unicast-address-no-zero | number)
Tree[destination]
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm one-way-delay-test mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

two-way-delay-test
Synopsis Initiate a two-way delay test
Context oam eth-cfm two-way-delay-test
Treetwo-way-delay-test
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm two-way-delay-test [destination] (mac-unicast-address-no-zero | number)
Tree[destination]
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm two-way-delay-test mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

two-way-slm-test
Synopsis Initiate a two-way SLM test in SAA
Context oam eth-cfm two-way-slm-test
Treetwo-way-slm-test
Introduced20.2.R1

Platforms

All

[destination] (mac-unicast-address-no-zero | number)
Synopsis Destination MAC address or remote MEP ID of the peer
Contextoam eth-cfm two-way-slm-test [destination] (mac-unicast-address-no-zero | number)
Tree[destination]
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

interval (number | decimal-number)
Synopsis Time between probes within the test run
Contextoam eth-cfm two-way-slm-test interval (number | decimal-number)
Treeinterval
Range1 to 10
Unitsseconds
Default 5
Introduced20.2.R1

Platforms

All

mep-id number
Synopsis Local Maintenance Association Endpoint (MEP) ID
Contextoam eth-cfm two-way-slm-test mep-id number
Treemep-id
Range1 to 8191

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

size number
Synopsis Data portion size of the data TLV, octet string allowed
Contextoam eth-cfm two-way-slm-test size number
Treesize

Description

This command specifies the size of the data portion of the data TLV allowing for an optional octet string to be included.

Range0 to 1500
Unitsbytes
Default 0
Introduced20.2.R1

Platforms

All

timeout number
Synopsis Wait time for a reply to a sent message request
Contextoam eth-cfm two-way-slm-test timeout number
Treetimeout

Description

This command specifies the time the router waits for a message reply after sending a message request.

Upon expiration of the timeout, the router assumes that the message response is not received. Any response received after the timeout is silently discarded.

Range1 to 10
Unitsseconds
Default 5
Introduced20.2.R1

Platforms

All

lsp-ping

Synopsis Perform a Label Switched Path (LSP) ping test
Contextoam lsp-ping
Treelsp-ping
Introduced23.3.R1

Platforms

All

bgp-label
Synopsis Perform a BGP-label LSP trace test
Context oam lsp-ping bgp-label
Treebgp-label

Description

This command option performs a Border Gateway Protocol (BGP-label) LSP trace test using Target FEC Stack code point "BGP labeled IPv4 prefix".

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping bgp-label fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping bgp-label interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping bgp-label interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping bgp-label 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.

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-ping bgp-label prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping bgp-label profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping bgp-label size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping bgp-label timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping bgp-label ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

ldp
Synopsis Perform Label Distribution Protocal (LDP) LSP ping test
Contextoam lsp-ping ldp
Treeldp
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping ldp fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping ldp interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping ldp interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping ldp 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.

Introduced23.3.R1

Platforms

All

path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the path destination
Context oam lsp-ping ldp path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Treepath-destination
Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-ping ldp prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping ldp profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

send-count number
Synopsis Number of echo request packets to send
Contextoam lsp-ping ldp send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping ldp size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping ldp timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping ldp ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

rsvp-te
Synopsis Perform an RSVP-TE LSP ping test
Context oam lsp-ping rsvp-te
Treersvp-te
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping rsvp-te fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping rsvp-te interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

lsp-name reference
Synopsis Name of the LSP to test
Context oam lsp-ping rsvp-te lsp-name reference
Treelsp-name

Reference

state router string mpls lsp string

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

path reference
Synopsis Name of the MPLS path to test
Context oam lsp-ping rsvp-te path reference
Treepath

Reference

state router string mpls path string

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping rsvp-te profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

send-count number
Synopsis Number of echo request packets to send
Contextoam lsp-ping rsvp-te send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping rsvp-te size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping rsvp-te timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping rsvp-te ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

sr-isis
Synopsis Perform an SR-ISIS LSP ping test
Context oam lsp-ping sr-isis
Treesr-isis
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping sr-isis fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

flex-algo number
Synopsis Segment Routing Flexible Algorithm for the test
Contextoam lsp-ping sr-isis flex-algo number
Treeflex-algo
Range128 to 255
Introduced23.7.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping sr-isis interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping sr-isis interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping sr-isis 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.

Introduced23.3.R1

Platforms

All

path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the path destination
Context oam lsp-ping sr-isis path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Treepath-destination
Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-ping sr-isis prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping sr-isis profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

send-count number
Synopsis Number of echo request packets to send
Contextoam lsp-ping sr-isis send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping sr-isis size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping sr-isis timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping sr-isis ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

sr-ospf
Synopsis Perform an SR-OSPF LSP ping test
Context oam lsp-ping sr-ospf
Treesr-ospf
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping sr-ospf fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

flex-algo number
Synopsis Segment Routing Flexible Algorithm for the test
Contextoam lsp-ping sr-ospf flex-algo number
Treeflex-algo
Range128 to 255
Introduced23.7.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping sr-ospf interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping sr-ospf interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop string
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping sr-ospf next-hop string
Treenext-hop

Notes

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

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-ping sr-ospf prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping sr-ospf profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

send-count number
Synopsis Number of echo request packets to send
Contextoam lsp-ping sr-ospf send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping sr-ospf size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping sr-ospf timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping sr-ospf ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

sr-ospf3
Synopsis Perform an SR-OSPFv3 LSP ping test
Context oam lsp-ping sr-ospf3
Treesr-ospf3
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping sr-ospf3 fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping sr-ospf3 interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping sr-ospf3 interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping sr-ospf3 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.

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-ping sr-ospf3 prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping sr-ospf3 profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping sr-ospf3 size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping sr-ospf3 timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping sr-ospf3 ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

sr-policy
Synopsis Perform an SR policy LSP ping test
Context oam lsp-ping sr-policy
Treesr-policy
Introduced23.3.R1

Platforms

All

color number
Synopsis Segment Routing color for the test
Context oam lsp-ping sr-policy color number
Treecolor
Max. Range0 to 4294967295

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Segment Routing endpoint for the test
Contextoam lsp-ping sr-policy endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Treeendpoint

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping sr-policy fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping sr-policy interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping sr-policy interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping sr-policy 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.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping sr-policy profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping sr-policy size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping sr-policy timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping sr-policy ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

sr-te
Synopsis Perform an SR-TE LSP ping test
Context oam lsp-ping sr-te
Treesr-te
Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-ping sr-te fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-ping sr-te interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-ping sr-te interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

lsp-name reference
Synopsis Name of the LSP to test
Context oam lsp-ping sr-te lsp-name reference
Treelsp-name

Reference

state router string mpls lsp string

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-ping sr-te 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.

Introduced23.3.R1

Platforms

All

path reference
Synopsis Name of the MPLS path to test
Context oam lsp-ping sr-te path reference
Treepath

Reference

state router string mpls path string

Introduced23.3.R1

Platforms

All

path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the path destination
Context oam lsp-ping sr-te path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Treepath-destination
Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-ping sr-te profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

send-count number
Synopsis Number of echo request packets to send
Contextoam lsp-ping sr-te send-count number
Treesend-count
Range1 to 100
Unitspackets
Default 1
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-ping sr-te size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-ping sr-te timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ttl number
Synopsis TTL value for the MPLS label of the echo request
Contextoam lsp-ping sr-te ttl number
Treettl
Range1 to 255
Default255
Introduced 23.3.R1

Platforms

All

lsp-trace

Synopsis Perform a Label Switched Path (LSP) trace test
Contextoam lsp-trace
Treelsp-trace
Introduced23.3.R1

Platforms

All

bgp-label
Synopsis Perform a BGP-label LSP trace test
Context oam lsp-trace bgp-label
Treebgp-label

Description

This option performs an LSP trace test using Target FEC Stack sub-type "BGP labeled IPv4 prefix".

Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace bgp-label downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace bgp-label fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace bgp-label interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace bgp-label interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace bgp-label max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace bgp-label 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.

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-trace bgp-label prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace bgp-label profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace bgp-label size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace bgp-label timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

ldp
Synopsis Perform an LDP LSP trace test
Context oam lsp-trace ldp
Treeldp
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace ldp downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace ldp fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace ldp interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace ldp interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace ldp max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

min-ttl number
Synopsis Initial TTL for the test
Context oam lsp-trace ldp min-ttl number
Treemin-ttl
Range1 to 255
Default1
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace ldp 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.

Introduced23.3.R1

Platforms

All

path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the path destination
Context oam lsp-trace ldp path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Treepath-destination
Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-trace ldp prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace ldp profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace ldp size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace ldp timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

rsvp-te
Synopsis Perform an RSVP-TE LSP trace test
Context oam lsp-trace rsvp-te
Treersvp-te
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace rsvp-te downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace rsvp-te fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace rsvp-te interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

lsp-name reference
Synopsis Name of the LSP to test
Context oam lsp-trace rsvp-te lsp-name reference
Treelsp-name

Reference

state router string mpls lsp string

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace rsvp-te max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

path reference
Synopsis Name of the MPLS path to test
Context oam lsp-trace rsvp-te path reference
Treepath

Reference

state router string mpls path string

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace rsvp-te profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace rsvp-te size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace rsvp-te timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

sr-isis
Synopsis Perform an SR-ISIS LSP trace test
Context oam lsp-trace sr-isis
Treesr-isis
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace sr-isis downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace sr-isis fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace sr-isis interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace sr-isis interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace sr-isis max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace sr-isis 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.

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-trace sr-isis prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace sr-isis profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace sr-isis size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace sr-isis timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

sr-ospf
Synopsis Perform an SR-OSPF LSP trace test
Context oam lsp-trace sr-ospf
Treesr-ospf
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace sr-ospf downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace sr-ospf fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace sr-ospf interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace sr-ospf interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace sr-ospf max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

next-hop string
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace sr-ospf next-hop string
Treenext-hop

Notes

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

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-trace sr-ospf prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace sr-ospf profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace sr-ospf size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace sr-ospf timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

sr-ospf3
Synopsis Perform an SR-OSPFv3 LSP trace test
Context oam lsp-trace sr-ospf3
Treesr-ospf3
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace sr-ospf3 downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace sr-ospf3 fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace sr-ospf3 interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace sr-ospf3 interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace sr-ospf3 max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace sr-ospf3 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.

Introduced23.3.R1

Platforms

All

prefix (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP prefix for the test
Context oam lsp-trace sr-ospf3 prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace sr-ospf3 profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace sr-ospf3 size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace sr-ospf3 timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

sr-policy
Synopsis Perform an SR policy LSP trace test
Context oam lsp-trace sr-policy
Treesr-policy
Introduced23.3.R1

Platforms

All

color number
Synopsis Segment Routing color for the test
Context oam lsp-trace sr-policy color number
Treecolor
Max. Range0 to 4294967295

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace sr-policy downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Segment Routing endpoint for the test
Contextoam lsp-trace sr-policy endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Treeendpoint

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace sr-policy fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace sr-policy interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace sr-policy interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace sr-policy max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace sr-policy 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.

Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace sr-policy profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace sr-policy size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace sr-policy timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

sr-te
Synopsis Perform an SR-TE LSP trace test
Context oam lsp-trace sr-te
Treesr-te
Introduced23.3.R1

Platforms

All

downstream-map-tlv keyword
Synopsis Type of downstream mapping TLV in MPLS echo request PDU
Contextoam lsp-trace sr-te downstream-map-tlv keyword
Treedownstream-map-tlv
Options

dsmap – Downstream mapping TLV

ddmap – Detailed downstream mapping TLV

none – No mapping TLV

Introduced23.3.R1

Platforms

All

fc keyword
Synopsis QoS forwarding class for the sent echo request packet
Contextoam lsp-trace sr-te fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced23.3.R1

Platforms

All

interface reference
Synopsis Egress router interface to use with path destination
Contextoam lsp-trace sr-te interface reference
Treeinterface

Reference

state router string interface string

Notes

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

Introduced23.3.R1

Platforms

All

interval number
Synopsis Minimum time to expire before next echo request is sent
Contextoam lsp-trace sr-te interval number
Treeinterval
Range1 to 10
Unitsseconds
Default 1
Introduced23.3.R1

Platforms

All

lsp-name reference
Synopsis Name of the LSP to test
Context oam lsp-trace sr-te lsp-name reference
Treelsp-name

Reference

state router string mpls lsp string

Notes

This element is mandatory.

Introduced23.3.R1

Platforms

All

max-fail number
Synopsis Maximum consecutive timeouts before terminating test
Contextoam lsp-trace sr-te max-fail number
Treemax-fail
Range1 to 255
Default5
Introduced 23.3.R1

Platforms

All

min-ttl number
Synopsis Initial TTL for the test
Context oam lsp-trace sr-te min-ttl number
Treemin-ttl
Range1 to 255
Default1
Introduced 23.3.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Egress IP next hop address to use with path destination
Contextoam lsp-trace sr-te 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.

Introduced23.3.R1

Platforms

All

path reference
Synopsis Name of the MPLS path to test
Context oam lsp-trace sr-te path reference
Treepath

Reference

state router string mpls path string

Introduced23.3.R1

Platforms

All

path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the path destination
Context oam lsp-trace sr-te path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
Treepath-destination
Introduced23.3.R1

Platforms

All

profile keyword
Synopsis QoS profile for the transmitted echo request packets
Contextoam lsp-trace sr-te profile keyword
Treeprofile
Optionsin, out
Default out
Introduced23.3.R1

Platforms

All

size number
Synopsis Echo request packet pad size
Context oam lsp-trace sr-te size number
Treesize
Range1 to 9786
Unitsbytes
Default 1
Introduced23.3.R1

Platforms

All

timeout number
Synopsis Time to wait for a reply after sending an echo request
Contextoam lsp-trace sr-te timeout number
Treetimeout
Range1 to 10
Unitsseconds
Default 5
Introduced23.3.R1

Platforms

All

oam-pm

Synopsis Initiate an on-demand OAM Performance Monitoring test
Contextoam oam-pm
Treeoam-pm
Introduced20.2.R1

Platforms

All

action keyword
Synopsis OAM-PM test action
Context oam oam-pm action keyword
Treeaction
Optionsstart, stop

Notes

This element is mandatory.

Introduced 20.2.R1

Platforms

All

session reference
Synopsis OAM-PM session name
Context oam oam-pm session reference
Treesession

Reference

state oam-pm session string

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

test-type keyword
Synopsis Test type
Contextoam oam-pm test-type keyword
Treetest-type
Optionsdm, dmm, lmm, slm, twamp-light

Notes

This element is mandatory.

Introduced20.2.R1

Platforms

All

saa

Synopsis Enter the saa context
Context oam saa
Treesaa
Introduced22.10.R1

Platforms

All

owner [owner-name] reference test reference
Synopsis SAA owner name
Contextoam saa owner reference test reference
Treeowner
Introduced22.10.R1

Platforms

All

[owner-name] reference
Synopsis Name of the owner of SAA test to be stopped or started
Contextoam saa owner reference test reference
Treeowner
MD-CLI DefaultTiMOS CLI

Reference

state saa owner string test string

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

All

test reference
Synopsis Name of the SAA test to be stopped or started
Contextoam saa owner reference test reference
Treeowner

Reference

state saa owner string test string

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

All

start
Synopsis Start the SAA test
Context oam saa owner reference test reference start
Treestart
Introduced22.10.R1

Platforms

All

accounting boolean
Synopsis Disable recording results in accounting policy
Contextoam saa owner reference test reference start accounting boolean
Treeaccounting
Defaulttrue
Introduced22.10.R1

Platforms

All

stop
Synopsis Stop the SAA test
Context oam saa owner reference test reference stop
Treestop
Introduced22.10.R1

Platforms

All

accounting boolean
Synopsis Disable recording results in accounting policy
Contextoam saa owner reference test reference stop accounting boolean
Treeaccounting
Defaulttrue
Introduced22.10.R1

Platforms

All

service-activation-testhead

Synopsis Start or stop Service Activation Testhead service test
Contextoam service-activation-testhead
Treeservice-activation-testhead
Introduced23.10.R1

Platforms

All

service-test [service-test-name] reference
Synopsis Service test name
Context oam service-activation-testhead service-test reference
Treeservice-test
Introduced23.10.R1

Platforms

All

[service-test-name] reference
Synopsis Name of the service test to be started or stopped
Contextoam service-activation-testhead service-test reference
Treeservice-test

Reference

state test-oam service-activation-testhead service-test string

Notes

This element is part of a list key.

Introduced23.10.R1

Platforms

All

start
Synopsis Start OAM SATH service test
Context oam service-activation-testhead service-test reference start
Treestart

Description

This command starts an OAM Service Activtation Testhead (SATH) service test.

Only one instance of a service test is allowed for the specified service-test-name. If the user attempts to start another instance of a service test for the same service-test-name while the current instance is still running, an error is generated.

Introduced23.10.R1

Platforms

All

stop
Synopsis Stop OAM SATH service test
Context oam service-activation-testhead service-test reference stop
Treestop

Description

This command stops an OAM Service Activtation Testhead (SATH) service test.

If the user attempts to stop a service test that is already complete, an error is generated.

Introduced23.10.R1

Platforms

All

password

Synopsis Change the local user password
Context password
Treepassword
Introduced20.10.R1

Platforms

All

ping

Synopsis Ping an IP address or DNS name
Context ping
Tree ping
Introduced19.10.R1

Platforms

All

bypass-routing

Synopsis Bypass routing table when sending ping request to host
Contextping bypass-routing
Treebypass-routing

Notes

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

Introduced19.10.R1

Platforms

All

candidate-path

Synopsis Ping candidate path of the SRv6 policy
Contextping candidate-path
Treecandidate-path

Description

When configured, this command allows the user to specify a candidate path of the SRv6 policy to ping. The candidate path does not need to be the currently active candidate path.

Introduced23.10.R1

Platforms

All

color number

Synopsis Color identifier of the Segment Routing IPv6 policy
Contextping color number
Treecolor
Max. Range0 to 4294967295

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.7.R1

Platforms

All

count number

Synopsis Number of ping requests to send to the remote host
Contextping count number
Treecount
Range1 to 100000
Unitspackets
Default 5
Introduced19.10.R1

Platforms

All

[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

Synopsis Destination IP address or DNS name
Context ping [destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
Tree[destination]
String Length1 to 128

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

distinguisher number

Synopsis SRv6 policy candidate path distinguisher
Contextping distinguisher number
Treedistinguisher

Description

This command specifies the distinguisher of the SRv6 policy candidate path to send the ping probe on.

This command must be configured if the protocol-owner command is configured to bgp.

Range1 to 4294967295
Introduced23.10.R1

Platforms

All

do-not-fragment

Synopsis Do not fragment the request frame
Context ping do-not-fragment
Treedo-not-fragment

Description

This command sets the do-not-fragment bit in the IPv4 header. This prevents packet fragmentation along the path when there is an MTU mismatch. 

Introduced19.10.R1

Platforms

All

endpoint string

Synopsis Endpoint identifier of the Segment Routing IPv6 policy to be pinged
Contextping endpoint string
Treeendpoint

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.7.R1

Platforms

All

fc keyword

Synopsis Forwarding class option for the transmitted packet
Contextping fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default nc
Introduced19.10.R1

Platforms

All

interface (reference | reference | reference | reference | reference)

Synopsis Sending interface name
Context ping interface (reference | reference | reference | reference | reference)
Treeinterface

Reference

state router string interface string

state service ies string interface string

state service ies string subscriber-interface string

state service vprn string interface string

state service vprn string subscriber-interface string

Notes

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

Introduced19.10.R1

Platforms

All

interval (number | decimal-number)

Synopsis Time between consecutive ping requests
Contextping interval (number | decimal-number)
Treeinterval
Range1 to 10000
Unitsseconds
Default 1
Introduced19.10.R1

Platforms

All

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

Synopsis Next-hop address to send packet, ignoring routing table
Contextping 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, next-hop-address, or subscriber.

Introduced19.10.R1

Platforms

All

output-format keyword

Synopsis Output format
Contextping output-format keyword
Treeoutput-format
Optionssummary, detail
Default detail
Introduced19.10.R1

Platforms

All

pattern (keyword | number)

Synopsis Pattern string to include in the packet
Contextping pattern (keyword | number)
Treepattern
Range0 to 65535
Optionssequential
Defaultsequential
Introduced19.10.R1

Platforms

All

preference number

Synopsis SRv6 policy candidate path preference
Contextping preference number
Treepreference

Description

This command specifies the preference of the SRv6 policy candidate path to send the ping probe on.

Max. Range0 to 4294967295
Default100
Introduced23.10.R1

Platforms

All

protocol-owner keyword

Synopsis Protocol owner
Contextping protocol-owner keyword
Treeprotocol-owner

Description

This command specifies the protocol owner of the SRv6 policy candidate path to ping.

The bgp option specifies a BGP SRv6 policy.

The static option specifies a locally configured static SRv6 policy.

Optionsbgp, static
Introduced 23.10.R1

Platforms

All

router-instance (reference | reference)

Synopsis Router name or VPRN service name
Context ping router-instance (reference | reference)
Treerouter-instance
DefaultBase

Reference

state router string

state service vprn string

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

segment-list number

Synopsis Segment Routing IPv6 segment list to be pinged
Contextping segment-list number
Treesegment-list
Range1 to 32

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.7.R1

Platforms

All

size number

Synopsis Request packet size including ICMP header and payload
Contextping size number
Treesize
Range0 to 16384
Unitsbytes
Default 56
Introduced19.10.R1

Platforms

All

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

Synopsis Source IP address used in the ICMP Echo Request packet
Contextping source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treesource-address

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

srv6-policy

Synopsis Ping a Segment Routing IPv6 policy
Context ping srv6-policy
Treesrv6-policy

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.7.R1

Platforms

All

subscriber string

Synopsis Subscriber ID for sending ICMP Echo Request packets
Contextping subscriber string
Treesubscriber
String Length1 to 64

Notes

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

Introduced19.10.R1

Platforms

All

timeout number

Synopsis Wait time for the ICMP Echo Reply packet
Contextping timeout number
Treetimeout

Description

This command specifies the time to wait for the ICMP Echo Reply packet. The timer is started when the last ICMP Echo Request is sent.

Range1 to 10
Unitsseconds
Default 5
Introduced19.10.R2

Platforms

All

tos number

Synopsis Type of Service (ToS) bits in the IP header
Contextping tos number
Treetos
Range0 to 255
Default0
Introduced 19.10.R1

Platforms

All

ttl number

Synopsis Time to Live (TTL) included in the request packet
Contextping ttl number
Treettl
Range1 to 128
Default64
Introduced 19.10.R1

Platforms

All

pwc

Synopsis Show the present working context
Context pwc
Tree pwc
Introduced16.0.R1

Platforms

All

[path-type] keyword

Synopsis Alternative format to display the path
Contextpwc [path-type] keyword
Tree[path-type]

Description

This command provides alternative formats to display the present working context.

The gnmi-path option replaces the xpath option.

Options

model-path – YANG-modeled format for RESTCONF

gnmi-path – gNMI format for streaming telemetry

cli-path – MD-CLI format on a single line for copying and pasting

json-instance-path – YANG-modeled format for pySROS

Introduced19.10.R1

Platforms

All

previous

Synopsis Display previous working context
Context pwc previous
Treeprevious
Introduced16.0.R1

Platforms

All

pyexec [url] (string | string)

Synopsis Execute a Python application
Context pyexec (string | string)
Treepyexec
Introduced21.7.R1

Platforms

All

[url] (string | string)

Synopsis Location of the script to be executed
Contextpyexec (string | string)
Treepyexec

Notes

This element is part of a list key.

Introduced21.7.R1

Platforms

All

quit-config

Synopsis Exit the candidate configuration mode
Contextquit-config
Treequit-config
Introduced16.0.R1

Platforms

All

ssh

Synopsis SSH to an IP address or DNS name
Context ssh
Tree ssh
Introduced20.7.R1

Platforms

All

[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

Synopsis Destination IP address or DNS name
Context ssh [destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
Tree[destination]
String Length1 to 128

Notes

This element is mandatory.

Introduced20.7.R1

Platforms

All

key-re-exchange

Synopsis Enter the key-re-exchange context
Contextssh key-re-exchange
Treekey-re-exchange
Introduced20.7.R1

Platforms

All

mbytes (number | keyword)
Synopsis Maximum bytes before initiating key re-exchange
Contextssh key-re-exchange mbytes (number | keyword)
Treembytes

Description

This command specifies the number of bytes transmitted on an SSH session, after which the SSH client initiates the key re-exchange.

Range1 to 64000
Unitsmegabytes
Options infinite
Default1024
Introduced 20.7.R1

Platforms

All

minutes (number | keyword)
Synopsis Time after which SSH client initiates key re-exchange
Contextssh key-re-exchange minutes (number | keyword)
Treeminutes
Range1 to 1440
Unitsminutes
Options infinite
Default60
Introduced 20.7.R1

Platforms

All

login-name string

Synopsis SSH login username
Context ssh login-name string
Treelogin-name
String Length1 to 32
Introduced20.7.R1

Platforms

All

router-instance (string | string)

Synopsis Router name or VPRN service name
Context ssh router-instance (string | string)
Treerouter-instance
DefaultBase
Introduced20.7.R1

Platforms

All

telnet

Synopsis Telnet to an IP address or DNS name
Context telnet
Tree telnet

Description

This command opens a Telnet session to a remote host. In SR-series networks, the Telnet servers limit Telnet clients to three login attempts; if unsuccessful, the Telnet client session disconnects. The number is not user configurable. 

Introduced20.7.R1

Platforms

All

[destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

Synopsis Destination IP address or DNS name
Context telnet [destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
Tree[destination]

Description

This command specifies the IP address or DNS name (if DNS name resolution is configured) of the remote host for the Telnet session.

String Length1 to 128

Notes

This element is mandatory.

Introduced20.7.R1

Platforms

All

port number

Synopsis Remote host TCP port for the Telnet connection
Contexttelnet port number
Treeport
Range1 to 65535
Default23
Introduced 20.7.R1

Platforms

All

router-instance (string | string)

Synopsis Router name or VPRN service name
Context telnet router-instance (string | string)
Treerouter-instance
DefaultBase
Introduced20.7.R1

Platforms

All

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

Synopsis Source IP address of the Telnet packets
Contexttelnet source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treesource-address
Introduced20.7.R1

Platforms

All

top

Synopsis Move to the top level of the context
Context top
Tree top
Introduced16.0.R1

Platforms

All

traceroute

Synopsis Show the route taken to an IP address or DNS name
Contexttraceroute
Treetraceroute
Introduced19.10.R1

Platforms

All

candidate-path

Synopsis Trace route of the candidate path of the SRv6 policy
Contexttraceroute candidate-path
Treecandidate-path

Description

When configured, this command allows the user to specify a candidate path of the SRv6 policy to traceroute. The candidate path does not need to be the currently active candidate path.

Introduced23.10.R1

Platforms

All

color number

Synopsis Color ID of the SRv6 policy to trace
Context traceroute color number
Treecolor

Description

This command launches a traceroute of an SRv6 policy that matches a specific color.

Max. Range0 to 4294967295

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.3.R1

Platforms

All

decode keyword

Synopsis Perform original datagram parsing functions
Contexttraceroute decode keyword
Treedecode
Optionsnone, original-datagram
Defaultnone
Introduced 22.7.R1

Platforms

All

dest-port number

Synopsis Transport protocol destination port number
Contexttraceroute dest-port number
Treedest-port
Range1 to 65535
Default33434
Introduced 20.10.R1

Platforms

All

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

Synopsis Destination IP address or DNS name
Context traceroute [destination] (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
Tree[destination]
String Length1 to 128

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

detail

Synopsis Display MPLS label stack information or TCP port status
Contexttraceroute detail
Treedetail
Introduced19.10.R1

Platforms

All

distinguisher number

Synopsis SRv6 policy candidate path distinguisher
Contexttraceroute distinguisher number
Treedistinguisher

Description

This command specifies the distinguisher of the SRv6 policy candidate path to send the traceroute probe on.

This command must be configured if the protocol-owner command is configured to bgp.

Range1 to 4294967295
Introduced23.10.R1

Platforms

All

endpoint string

Synopsis Endpoint of the SRv6 policy to trace
Context traceroute endpoint string
Treeendpoint

Description

This command configures an IPv6 endpoint address for an SRv6 policy as the target of the traceroute.

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.3.R1

Platforms

All

min-ttl number

Synopsis First hop traceroute probes using the TTL value
Contexttraceroute min-ttl number
Treemin-ttl

Description

This command specifies the first hop traceroute probes, using the ttl value.

Range1 to 255
Default1
Introduced 21.10.R1

Platforms

All

numeric

Synopsis Display IP addresses instead of DNS names
Contexttraceroute numeric
Treenumeric
Introduced19.10.R1

Platforms

All

preference number

Synopsis SRv6 policy candidate path preference
Contexttraceroute preference number
Treepreference

Description

This command specifies the preference of the SRv6 policy candidate path to send the traceroute probe on.

Max. Range0 to 4294967295
Default100
Introduced23.10.R1

Platforms

All

probe-count number

Synopsis Number of probes to send per hop
Context traceroute probe-count number
Treeprobe-count
Range1 to 10
Default3
Introduced 20.10.R1

Platforms

All

protocol keyword

Synopsis Packet type to send
Context traceroute protocol keyword
Treeprotocol

Description

This command sets the transport protocol, UDP or TCP, for the traceroute packet. A targeted VPRN service silently discards TCP traceroutes and only responds to UDP traceroutes.

Optionsudp, tcp
Default udp
Introduced21.10.R1

Platforms

All

protocol-owner keyword

Synopsis Protocol owner
Contexttraceroute protocol-owner keyword
Treeprotocol-owner

Description

This command specifies the protocol owner of the SRv6 policy candidate path to traceroute.

The bgp option specifies a BGP SRv6 policy.

The static option specifies a locally configured static SRv6 policy.

Optionsbgp, static
Introduced 23.10.R1

Platforms

All

router-instance string

Synopsis Router name or VPRN service name
Context traceroute router-instance string
Treerouter-instance
DefaultBase

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

segment-list number

Synopsis SR IPv6 segment list to trace
Context traceroute segment-list number
Treesegment-list

Description

This command configures the traceroute probe to target a specific segment list of an SRv6 policy. When the segment list is not specified, the traceroute probe is sent on the lowest available segment list.

Range1 to 32

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.3.R1

Platforms

All

size number

Synopsis Number of pad bytes in each transmitted packet
Contexttraceroute size number
Treesize
Range0 to 9786
Unitsbytes
Default 0
Introduced21.10.R1

Platforms

All

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

Synopsis Source address of the probe packets
Context traceroute source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treesource-address

Description

This command specifies the source address of the probe packets. If the IP address is not one of the interfaces of the device, the system returns an error.

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced19.10.R1

Platforms

All

srv6-policy

Synopsis Trace an SRv6 policy
Context traceroute srv6-policy
Treesrv6-policy

Description

This command launches a traceroute of a Segment Routing IPv6 (SRv6) policy.

Notes

The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy).

Introduced23.3.R1

Platforms

All

tos number

Synopsis Type of Service (ToS) bits in the IP header
Contexttraceroute tos number
Treetos
Range0 to 255
Default0
Introduced 19.10.R1

Platforms

All

ttl number

Synopsis Maximum number of hops (TTL) to probe
Contexttraceroute ttl number
Treettl
Range1 to 255
Default30
Introduced 19.10.R1

Platforms

All

wait number

Synopsis Time to wait for a response to the probe
Contexttraceroute wait number
Treewait
Range10 to 60000
Unitsmilliseconds
Default 5000
Introduced19.10.R1

Platforms

All

tree

Synopsis Show the command tree under the present working context
Contexttree
Treetree
Introduced16.0.R1

Platforms

All

[cli-path] string

Synopsis Absolute path or relative path from pwc
Contexttree [cli-path] string
Tree[cli-path]
Introduced20.10.R1

Platforms

All

detail

Synopsis Display the tree with keys and field values
Contexttree detail
Treedetail
Introduced16.0.R1

Platforms

All

flat

Synopsis Show the context from the pwc on each line
Contexttree flat
Treeflat
Introduced16.0.R1

Platforms

All