Global commands

   —  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 
      —  detail 
      —  flat 
      —  full-context 
      —  inheritance 
      —  json 
      —  model keyword
      —  units 
      —  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
      —  oam-pm
         —  action keyword
         —  session reference
         —  test-type keyword
   —  password
   —  ping
      —  bypass-routing 
      —  count number
      —  [destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
      —  do-not-fragment 
      —  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)
      —  router-instance (reference | reference)
      —  size number
      —  source-address (ipv4-address-no-zone | ipv6-address-no-zone)
      —  subscriber string
      —  timeout number
      —  tos number
      —  ttl number
   —  pwc
      —  [path-type] keyword
      —  previous 
   —  pyexec (string | reference)
      —  [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 (reference | reference)
      —  version keyword
   —  telnet
      —  [destination] (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
      —  port number
      —  router-instance (reference | reference)
      —  source-address (ipv4-address-no-zone | ipv6-address-no-zone)
   —  top
   —  traceroute
      —  dest-port number
      —  dest-port-udp-fixed 
      —  [destination] (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
      —  detail 
      —  min-ttl number
      —  numeric 
      —  probe-count number
      —  protocol keyword
      —  router-instance (reference | reference)
      —  size number
      —  source-address (ipv4-address-no-zone | ipv6-address-no-zone)
      —  tos number
      —  ttl number
      —  wait number
   —  tree
      —  [cli-path] string
      —  detail 
      —  flat
Parent topic: Operational commands

Global command descriptions

back [levels] number

  Synopsis Move back one or more levels
  Context back number
  Tree back
  Introduced 16.0.R1
 

Platforms

All

[levels] number

  Synopsis Number of levels to move up
  Context back number
  Range 1 to 4294967295
  Default 1
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All

bof

  Synopsis Enter a candidate configuration mode
  Context bof
  Tree bof
  Introduced 20.10.R1
 

Platforms

All

exclusive

  Synopsis Enter exclusive configuration mode
  Context bof exclusive
  Tree exclusive
  Introduced 20.10.R1
 

Platforms

All

private

  Synopsis Enter private configuration mode
  Context bof private
  Tree private
  Introduced 20.10.R1
 

Platforms

All

read-only

  Synopsis Enter read-only configuration mode
  Context bof read-only
  Tree read-only
  Introduced 20.10.R1
 

Platforms

All

configure

  Synopsis Enter a candidate configuration mode
  Context configure
  Tree configure
  Introduced 16.0.R2
 

Platforms

All

exclusive

  Synopsis Enter exclusive configuration mode
  Context configure exclusive
  Tree exclusive
  Introduced 16.0.R2
 

Platforms

All

global

  Synopsis Enter global configuration mode
  Context configure global
  Tree global
  Introduced 16.0.R2
 

Platforms

All

private

  Synopsis Enter private configuration mode
  Context configure private
  Tree private
  Introduced 16.0.R4
 

Platforms

All

read-only

  Synopsis Enter read-only configuration mode
  Context configure read-only
  Tree read-only
  Introduced 16.0.R2
 

Platforms

All

debug

  Synopsis Enter a candidate configuration mode
  Context debug
  Tree debug
  Introduced 21.5.R1
 

Platforms

All

exclusive

  Synopsis Enter exclusive configuration mode
  Context debug exclusive
  Tree exclusive
  Introduced 21.5.R1
 

Platforms

All

private

  Synopsis Enter private configuration mode
  Context debug private
  Tree private
  Introduced 21.5.R1
 

Platforms

All

read-only

  Synopsis Enter read-only configuration mode
  Context debug read-only
  Tree read-only
  Introduced 21.5.R1
 

Platforms

All

delete [cli-path] string

  Synopsis Delete an element
  Context delete string
  Tree delete
  Introduced 16.0.R1
 

Platforms

All

[cli-path] string

  Synopsis Absolute path or relative path from pwc
  Context delete string
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All

edit-config

  Synopsis Enter a configuration context
  Context edit-config
  Tree edit-config
  Introduced 16.0.R1
 

Platforms

All

bof

  Synopsis Enter the bof configuration context
  Context edit-config bof
  Tree bof
  Introduced 20.10.R1
 

Platforms

All

debug

  Synopsis Enter the debug configuration context
  Context edit-config debug
  Tree debug
  Introduced 21.5.R1
 

Platforms

All

exclusive

  Synopsis Enter exclusive configuration mode
  Context edit-config exclusive
  Tree exclusive
  Introduced 16.0.R1
 

Platforms

All

global

  Synopsis Enter global configuration mode
  Context edit-config global
  Tree global
  Introduced 16.0.R1
 

Platforms

All

li

  Synopsis Enter the li configuration context
  Context edit-config li
  Tree li
  Introduced 19.10.R1
 

Platforms

All

private

  Synopsis Enter private configuration mode
  Context edit-config private
  Tree private
  Introduced 16.0.R4
 

Platforms

All

read-only

  Synopsis Enter read-only configuration mode
  Context edit-config read-only
  Tree read-only
  Introduced 16.0.R1
 

Platforms

All

enable

  Synopsis Enable administrative mode
  Context enable
  Tree enable
  Introduced 20.2.R1
 

Platforms

All

exec [url] string

  Synopsis Execute commands from a file
  Context exec string
  Tree exec
  Introduced 16.0.R1
 

Platforms

All

[url] string

  Synopsis Location of the file to be executed
  Context exec string
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All

echo

  Synopsis Display the commands as they are being executed
  Context exec string echo
  Tree echo
  Introduced 16.0.R1
 

Platforms

All

exit

  Synopsis Return to the previous context or to operational root
  Context exit
  Tree exit
  Introduced 16.0.R1
 

Platforms

All

all

  Synopsis Return to the root context
  Context exit all
  Tree all
  Introduced 16.0.R1
 

Platforms

All

history

  Synopsis Show the command history
  Context history
  Tree history
  Introduced 16.0.R1
 

Platforms

All

info [from] keyword

  Synopsis Show the information under the present working context
  Context info keyword
  Tree info
  Introduced 16.0.R1
 

Platforms

All

[from] keyword

  Synopsis Source datastore
  Context info keyword
 

Description

This command specifies the source datastore. This option is not supported for state elements.
  Options candidate, running, baseline, intended
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All

[cli-path] string

  Synopsis Absolute path or relative path from pwc
  Context info keyword [cli-path] string
  Tree [cli-path]
  Introduced 20.10.R1
 

Platforms

All

converted

  Synopsis Include converted third party model configuration from the running datastore
  Context info keyword converted
  Tree converted
 

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.
  Introduced 16.0.R1
 

Platforms

All

detail

  Synopsis Include default and unconfigured values
  Context info keyword detail
  Tree detail
  Introduced 16.0.R1
 

Platforms

All

flat

  Synopsis Show the context from the pwc on each line
  Context info keyword flat
  Tree flat
 

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.
  Introduced 16.0.R1
 

Platforms

All

full-context

  Synopsis Show the full context on each line
  Context info keyword full-context
  Tree full-context
  Introduced 16.0.R1
 

Platforms

All

inheritance

  Synopsis Include configuration inherited from configuration groups
  Context info keyword inheritance
  Tree inheritance
 

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.
  Introduced 16.0.R1
 

Platforms

All

json

  Synopsis Show the output in indented JSON IETF format
  Context info keyword json
  Tree json
 

Notes

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

Platforms

All

model keyword

  Synopsis Model for which to display converted output
  Context info keyword model keyword
  Tree model
 

Description

This option specifies the model which displays 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.
  Default all
  Options all, openconfig
  Introduced 20.7.R1
 

Platforms

All

units

  Synopsis Include unit types for applicable elements
  Context info keyword units
  Tree units
  Introduced 20.5.R1
 

Platforms

All

xml

  Synopsis Show the output in indented XML format
  Context info keyword xml
  Tree xml
 

Notes

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

Platforms

All

li

  Synopsis Enter a candidate configuration mode
  Context li
  Tree li
  Introduced 19.10.R1
 

Platforms

All

exclusive

  Synopsis Enter exclusive configuration mode
  Context li exclusive
  Tree exclusive
  Introduced 19.10.R1
 

Platforms

All

private

  Synopsis Enter private configuration mode
  Context li private
  Tree private
  Introduced 19.10.R1
 

Platforms

All

read-only

  Synopsis Enter read-only configuration mode
  Context li read-only
  Tree read-only
  Introduced 19.10.R1
 

Platforms

All

logout

  Synopsis Exit the CLI session
  Context logout
  Tree logout
  Introduced 16.0.R1
 

Platforms

All

oam

  Synopsis Perform OAM tests
  Context oam
  Tree oam
  Introduced 20.2.R1
 

Platforms

All

efm

  Synopsis Enter the efm context
  Context oam efm
  Tree efm
  Introduced 20.2.R1
 

Platforms

All
local-loopback
  Synopsis Start or stop local loopback test on a port
  Context oam efm local-loopback
  Tree local-loopback
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
port-id string
  Synopsis Port ID for the test
  Context oam efm local-loopback port-id string
  Tree port-id
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
remote-loopback
  Synopsis Start or stop remote loopback test on a port
  Context oam efm remote-loopback
  Tree remote-loopback
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
port-id string
  Synopsis Port ID for the test
  Context oam efm remote-loopback port-id string
  Tree port-id
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All

eth-cfm

  Synopsis Initiate an Ethernet Connectivity Fault Management test
  Context oam eth-cfm
  Tree eth-cfm
  Introduced 20.2.R1
 

Platforms

All
eth-test
  Synopsis Initiate an OAM ETH-CFM test
  Context oam eth-cfm eth-test
  Tree eth-test
  Introduced 20.2.R1
 

Platforms

All
data-length number
  Synopsis Size of the padding to be added to the frame
  Context oam eth-cfm eth-test data-length number
  Tree data-length
  Range 64 to 1500
  Default 64
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

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

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm eth-test md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm eth-test mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
priority number
  Synopsis Frame priority that can be manipulated by QoS policies
  Context oam eth-cfm eth-test priority number
  Tree priority
  Range 0 to 7
  Default 7
  Introduced 20.2.R1
 

Platforms

All
linktrace
  Synopsis Initiate a linktrace test
  Context oam eth-cfm linktrace
  Tree linktrace
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

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

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm linktrace md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm linktrace mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
ttl number
  Synopsis Time to live for a returned linktrace
  Context oam eth-cfm linktrace ttl number
  Tree ttl
  Range 0 to 255
  Default 64
  Introduced 20.2.R1
 

Platforms

All
loopback
  Synopsis Initiate a loopback test
  Context oam eth-cfm loopback
  Tree loopback
  Introduced 20.2.R1
 

Platforms

All
[destination] (mac-unicast-address-no-zero | keyword | number)
  Synopsis Destination MAC address or remote MEP ID of the peer
  Context oam eth-cfm loopback [destination] (mac-unicast-address-no-zero | keyword | number)
  Tree [destination]
  Range 1 to 8191
  Options multicast
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
interval number
  Synopsis Time between probes within the test run
  Context oam eth-cfm loopback interval number
  Tree interval
  Range 0 to 600
  Default 0
  Units deciseconds
  Introduced 20.2.R1
 

Platforms

All
lbm-padding number
  Synopsis Data portion size of the data TLV, no octet string
  Context oam eth-cfm loopback lbm-padding number
  Tree lbm-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.
  Range 0 | 3 to 9778
  Default 0
  Introduced 20.2.R1
 

Platforms

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

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm loopback md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm loopback mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
priority number
  Synopsis Frame priority that can be manipulated by QoS policies
  Context oam eth-cfm loopback priority number
  Tree priority
  Range 0 to 7
  Introduced 20.2.R1
 

Platforms

All
send-count number
  Synopsis Number of loopback messages to send
  Context oam eth-cfm loopback send-count number
  Tree send-count
  Range 1 to 1024
  Default 1
  Introduced 20.2.R1
 

Platforms

All
size number
  Synopsis Data portion size of the data TLV, octet string allowed
  Context oam eth-cfm loopback size number
  Tree size
 

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.
  Range 0 to 1500
  Default 0
  Units bytes
  Introduced 20.2.R1
 

Platforms

All
timeout number
  Synopsis Wait time for a reply to a sent message request
  Context oam eth-cfm loopback timeout number
  Tree timeout
 

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.
  Range 1 to 10
  Default 5
  Units seconds
  Introduced 20.2.R1
 

Platforms

All
one-way-delay-test
  Synopsis Initiate a one-way delay test
  Context oam eth-cfm one-way-delay-test
  Tree one-way-delay-test
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
ma-admin-name reference
  Synopsis Association name
  Context oam eth-cfm one-way-delay-test ma-admin-name reference
  Tree ma-admin-name
 

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm one-way-delay-test md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm one-way-delay-test mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
priority number
  Synopsis Frame priority that can be manipulated by QoS policies
  Context oam eth-cfm one-way-delay-test priority number
  Tree priority
  Range 0 to 7
  Default 7
  Introduced 20.2.R1
 

Platforms

All
two-way-delay-test
  Synopsis Initiate a two-way delay test
  Context oam eth-cfm two-way-delay-test
  Tree two-way-delay-test
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
ma-admin-name reference
  Synopsis Association name
  Context oam eth-cfm two-way-delay-test ma-admin-name reference
  Tree ma-admin-name
 

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm two-way-delay-test md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm two-way-delay-test mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
priority number
  Synopsis Frame priority that can be manipulated by QoS policies
  Context oam eth-cfm two-way-delay-test priority number
  Tree priority
  Range 0 to 7
  Default 7
  Introduced 20.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
  Tree two-way-slm-test
  Introduced 20.2.R1
 

Platforms

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

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
interval (number | decimal-number)
  Synopsis Time between probes within the test run
  Context oam eth-cfm two-way-slm-test interval (number | decimal-number)
  Tree interval
  Range 1 to 10
  Default 5
  Units seconds
  Introduced 20.2.R1
 

Platforms

All
ma-admin-name reference
  Synopsis Association name
  Context oam eth-cfm two-way-slm-test ma-admin-name reference
  Tree ma-admin-name
 

Reference

state eth-cfm domain association [ma-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
md-admin-name reference
  Synopsis Domain name
  Context oam eth-cfm two-way-slm-test md-admin-name reference
  Tree md-admin-name
 

Reference

state eth-cfm domain [md-admin-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
mep-id number
  Synopsis Local Maintenance Association Endpoint (MEP) ID
  Context oam eth-cfm two-way-slm-test mep-id number
  Tree mep-id
  Range 1 to 8191
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
priority number
  Synopsis Frame priority that can be manipulated by QoS policies
  Context oam eth-cfm two-way-slm-test priority number
  Tree priority
  Range 0 to 7
  Default 7
  Introduced 20.2.R1
 

Platforms

All
send-count number
  Synopsis Number of two-way SLM test messages to send
  Context oam eth-cfm two-way-slm-test send-count number
  Tree send-count
  Range 1 to 1000
  Default 1
  Introduced 20.2.R1
 

Platforms

All
size number
  Synopsis Data portion size of the data TLV, octet string allowed
  Context oam eth-cfm two-way-slm-test size number
  Tree size
 

Description

This command specifies the size of the data portion of the data TLV allowing for an optional octet string to be included.
  Range 0 to 1500
  Default 0
  Units bytes
  Introduced 20.2.R1
 

Platforms

All
timeout number
  Synopsis Wait time for a reply to a sent message request
  Context oam eth-cfm two-way-slm-test timeout number
  Tree timeout
 

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.
  Range 1 to 10
  Default 5
  Units seconds
  Introduced 20.2.R1
 

Platforms

All

oam-pm

  Synopsis Initiate an on-demand OAM Performance Monitoring test
  Context oam oam-pm
  Tree oam-pm
  Introduced 20.2.R1
 

Platforms

All
action keyword
  Synopsis OAM-PM test action
  Context oam oam-pm action keyword
  Tree action
  Options start, 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
  Tree session
 

Reference

state oam-pm session [session-name] string
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All
test-type keyword
  Synopsis Test type
  Context oam oam-pm test-type keyword
  Tree test-type
  Options dm, dmm, lmm, slm, twamp-light
 

Notes

This element is mandatory.
  Introduced 20.2.R1
 

Platforms

All

password

  Synopsis Change the local user password
  Context password
  Tree password
  Introduced 20.10.R1
 

Platforms

All

ping

  Synopsis Ping an IP address or DNS name
  Context ping
  Tree ping
  Introduced 19.10.R1
 

Platforms

All

bypass-routing

  Synopsis Bypass routing table when sending ping request to host
  Context ping bypass-routing
  Tree bypass-routing
 

Description

When configured, the system bypasses the routing table when sending the ping request to a host on a directly-attached network. If the host is not on a directly-attached network, an error is returned.
 

Notes

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

Platforms

All

count number

  Synopsis Number of ping requests to send to the remote host
  Context ping count number
  Tree count
  Range 1 to 100000
  Default 5
  Units packets
  Introduced 19.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 Length 1 to 128
 

Notes

This element is mandatory.
  Introduced 19.10.R1
 

Platforms

All

do-not-fragment

  Synopsis Do not fragment the request frame
  Context ping do-not-fragment
  Tree do-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. 
  Introduced 19.10.R1
 

Platforms

All

fc keyword

  Synopsis Forwarding class option for the transmitted packet
  Context ping fc keyword
  Tree fc
  Default nc
  Options be, l2, af, l1, h2, ef, h1, nc
  Introduced 19.10.R1
 

Platforms

All

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

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

Reference

state router interface [interface-name] string

state service ies interface [interface-name] string

state service ies subscriber-interface [interface-name] string

state service vprn interface [interface-name] string

state service vprn subscriber-interface [interface-name] string
 

Notes

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

Platforms

All

interval (number | decimal-number)

  Synopsis Time between consecutive ping requests
  Context ping interval (number | decimal-number)
  Tree interval
  Range 1 to 10000
  Default 1
  Units seconds
  Introduced 19.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
  Context ping next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
  Tree next-hop-address
 

Description

This command specifies the next-hop address. The system does not use the routing table and the address must be on an adjacent router attached to a common subnet.
 

Notes

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

Platforms

All

output-format keyword

  Synopsis Output format
  Context ping output-format keyword
  Tree output-format
  Default detail
  Options summary, detail
  Introduced 19.10.R1
 

Platforms

All

pattern (keyword | number)

  Synopsis Pattern string to include in the packet
  Context ping pattern (keyword | number)
  Tree pattern
  Range 0 to 65535
  Default sequential
  Options sequential
  Introduced 19.10.R1
 

Platforms

All

router-instance (reference | reference)

  Synopsis Router name or VPRN service name
  Context ping router-instance (reference | reference)
  Tree router-instance
  Default Base
 

Reference

state router [router-name] string

state service vprn [service-name] string
  Introduced 19.10.R1
 

Platforms

All

size number

  Synopsis Request packet size including ICMP header and payload
  Context ping size number
  Tree size
  Range 0 to 16384
  Default 56
  Units bytes
  Introduced 19.10.R1
 

Platforms

All

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

  Synopsis Source IP address used in the ICMP Echo Request message
  Context ping source-address (ipv4-address-no-zone | ipv6-address-no-zone)
  Tree source-address
  Introduced 19.10.R1
 

Platforms

All

subscriber string

  Synopsis Subscriber ID for sending ICMP Echo Request packets
  Context ping subscriber string
  Tree subscriber
  String Length 1 to 64
 

Notes

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

Platforms

All

timeout number

  Synopsis Wait time for the ICMP Echo Reply packet
  Context ping timeout number
  Tree timeout
 

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.
  Range 1 to 10
  Default 5
  Units seconds
  Introduced 19.10.R2
 

Platforms

All

tos number

  Synopsis Type-of-Service (ToS) bits in the IP header
  Context ping tos number
  Tree tos
  Range 0 to 255
  Default 0
  Introduced 19.10.R1
 

Platforms

All

ttl number

  Synopsis Time To Live (TTL) included in the request packet
  Context ping ttl number
  Tree ttl
  Range 1 to 128
  Default 64
  Introduced 19.10.R1
 

Platforms

All

pwc

  Synopsis Show the present working context
  Context pwc
  Tree pwc
  Introduced 16.0.R1
 

Platforms

All

[path-type] keyword

  Synopsis Alternative format to display the path
  Context pwc [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, gnmi-path, cli-path, json-instance-path
  Introduced 19.10.R1
 

Platforms

All

previous

  Synopsis Display previous working context
  Context pwc previous
  Tree previous
  Introduced 16.0.R1
 

Platforms

All

pyexec [url] (string | reference)

  Synopsis Execute a Python application
  Context pyexec (string | reference)
  Tree pyexec
  Introduced 21.7.R1
 

Platforms

All

[url] (string | reference)

  Synopsis Location of the script to be executed
  Context pyexec (string | reference)
 

Reference

state python python-script [name] string
 

Notes

This element is part of a list key.
  Introduced 21.7.R1
 

Platforms

All

[argument-01] string

  Synopsis First argument
  Context pyexec (string | reference) [argument-01] string
  Tree [argument-01]
  Introduced 21.7.R1
 

Platforms

All

[argument-02] string

  Synopsis Second argument
  Context pyexec (string | reference) [argument-02] string
  Tree [argument-02]
  Introduced 21.7.R1
 

Platforms

All

[argument-03] string

  Synopsis Third argument
  Context pyexec (string | reference) [argument-03] string
  Tree [argument-03]
  Introduced 21.7.R1
 

Platforms

All

[argument-04] string

  Synopsis Fourth argument
  Context pyexec (string | reference) [argument-04] string
  Tree [argument-04]
  Introduced 21.7.R1
 

Platforms

All

[argument-05] string

  Synopsis Fifth argument
  Context pyexec (string | reference) [argument-05] string
  Tree [argument-05]
  Introduced 21.7.R1
 

Platforms

All

[argument-06] string

  Synopsis Sixth argument
  Context pyexec (string | reference) [argument-06] string
  Tree [argument-06]
  Introduced 21.7.R1
 

Platforms

All

[argument-07] string

  Synopsis Seventh argument
  Context pyexec (string | reference) [argument-07] string
  Tree [argument-07]
  Introduced 21.7.R1
 

Platforms

All

[argument-08] string

  Synopsis Eight argument
  Context pyexec (string | reference) [argument-08] string
  Tree [argument-08]
  Introduced 21.7.R1
 

Platforms

All

[argument-09] string

  Synopsis Ninth argument
  Context pyexec (string | reference) [argument-09] string
  Tree [argument-09]
  Introduced 21.7.R1
 

Platforms

All

[argument-10] string

  Synopsis Tenth argument
  Context pyexec (string | reference) [argument-10] string
  Tree [argument-10]
  Introduced 21.7.R1
 

Platforms

All

quit-config

  Synopsis Exit the candidate configuration mode
  Context quit-config
  Tree quit-config
  Introduced 16.0.R1
 

Platforms

All

ssh

  Synopsis SSH to an IP address or DNS name
  Context ssh
  Tree ssh
  Introduced 20.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 Length 1 to 128
 

Notes

This element is mandatory.
  Introduced 20.7.R1
 

Platforms

All

key-re-exchange

  Synopsis Enter the key-re-exchange context
  Context ssh key-re-exchange
  Tree key-re-exchange
  Introduced 20.7.R1
 

Platforms

All
mbytes (number | keyword)
  Synopsis Maximum bytes before initiating key re-exchange
  Context ssh key-re-exchange mbytes (number | keyword)
  Tree mbytes
 

Description

This command specifies the number of bytes transmitted on an SSH session, after which the SSH client initiates the key re-exchange.
  Range 1 to 64000
  Default 1024
  Units megabytes
  Options infinite
  Introduced 20.7.R1
 

Platforms

All
minutes (number | keyword)
  Synopsis Time after which SSH client initiates key re-exchange
  Context ssh key-re-exchange minutes (number | keyword)
  Tree minutes
  Range 1 to 1440
  Default 60
  Units minutes
  Options infinite
  Introduced 20.7.R1
 

Platforms

All

login-name string

  Synopsis SSH login username
  Context ssh login-name string
  Tree login-name
  String Length 1 to 32
  Introduced 20.7.R1
 

Platforms

All

router-instance (reference | reference)

  Synopsis Router name or VPRN service name
  Context ssh router-instance (reference | reference)
  Tree router-instance
  Default Base
 

Reference

state router [router-name] string

state service vprn [service-name] string
  Introduced 20.7.R1
 

Platforms

All

version keyword

  Synopsis SSH protocol version supported by the SSH server
  Context ssh version keyword
  Tree version
  Default 2
  Options 1, 2, 1-2
  Introduced 20.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. 
  Introduced 20.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 Length 1 to 128
 

Notes

This element is mandatory.
  Introduced 20.7.R1
 

Platforms

All

port number

  Synopsis Remote host TCP port for the Telnet connection
  Context telnet port number
  Tree port
  Range 1 to 65535
  Default 23
  Introduced 20.7.R1
 

Platforms

All

router-instance (reference | reference)

  Synopsis Router name or VPRN service name
  Context telnet router-instance (reference | reference)
  Tree router-instance
  Default Base
 

Reference

state router [router-name] string

state service vprn [service-name] string
  Introduced 20.7.R1
 

Platforms

All

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

  Synopsis Source IP address of the Telnet packets
  Context telnet source-address (ipv4-address-no-zone | ipv6-address-no-zone)
  Tree source-address
  Introduced 20.7.R1
 

Platforms

All

top

  Synopsis Move to the top level of the context
  Context top
  Tree top
  Introduced 16.0.R1
 

Platforms

All

traceroute

  Synopsis Show the route taken to an IP address or DNS name
  Context traceroute
  Tree traceroute
  Introduced 19.10.R1
 

Platforms

All

dest-port number

  Synopsis Transport protocol destination port number
  Context traceroute dest-port number
  Tree dest-port
  Range 1 to 65535
  Default 33434
  Introduced 20.10.R1
 

Platforms

All

dest-port-udp-fixed

  Synopsis Avoid increment of destination port number for UDP test
  Context traceroute dest-port-udp-fixed
  Tree dest-port-udp-fixed
  Introduced 21.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 Length 1 to 128
 

Notes

This element is mandatory.
  Introduced 19.10.R1
 

Platforms

All

detail

  Synopsis Display MPLS label stack information or TCP port status
  Context traceroute detail
  Tree detail
  Introduced 19.10.R1
 

Platforms

All

min-ttl number

  Synopsis First hop traceroute probes using the ttl value
  Context traceroute min-ttl number
  Tree min-ttl
 

Description

This command specifies the first hop traceroute probes, using the ttl value.
  Range 1 to 255
  Default 1
  Introduced 21.10.R1
 

Platforms

All

numeric

  Synopsis Display IP addresses instead of DNS names
  Context traceroute numeric
  Tree numeric
  Introduced 19.10.R1
 

Platforms

All

probe-count number

  Synopsis Number of probes to send per hop
  Context traceroute probe-count number
  Tree probe-count
  Range 1 to 10
  Default 3
  Introduced 20.10.R1
 

Platforms

All

protocol keyword

  Synopsis Packet type to send
  Context traceroute protocol keyword
  Tree protocol
 

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.
  Default udp
  Options udp, tcp
  Introduced 21.10.R1
 

Platforms

All

router-instance (reference | reference)

  Synopsis Router name or VPRN service name
  Context traceroute router-instance (reference | reference)
  Tree router-instance
  Default Base
 

Reference

state router [router-name] string

state service vprn [service-name] string
  Introduced 19.10.R1
 

Platforms

All

size number

  Synopsis Number of pad bytes in each transmitted packet
  Context traceroute size number
  Tree size
  Range 0 to 9786
  Default 0
  Units bytes
  Introduced 21.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)
  Tree source-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.
  Introduced 19.10.R1
 

Platforms

All

tos number

  Synopsis Type-of-Service (ToS) bits in the IP header
  Context traceroute tos number
  Tree tos
  Range 0 to 255
  Default 0
  Introduced 19.10.R1
 

Platforms

All

ttl number

  Synopsis Maximum number of hops (time-to-live) traceroute probes
  Context traceroute ttl number
  Tree ttl
  Range 1 to 255
  Default 30
  Introduced 19.10.R1
 

Platforms

All

wait number

  Synopsis Time to wait for a response to the probe
  Context traceroute wait number
  Tree wait
  Range 10 to 60000
  Default 5000
  Units milliseconds
  Introduced 19.10.R1
 

Platforms

All

tree

  Synopsis Show the command tree under the present working context
  Context tree
  Tree tree
  Introduced 16.0.R1
 

Platforms

All

[cli-path] string

  Synopsis Absolute path or relative path from pwc
  Context tree [cli-path] string
  Tree [cli-path]
  Introduced 20.10.R1
 

Platforms

All

detail

  Synopsis Display the tree with keys and field values
  Context tree detail
  Tree detail
  Introduced 16.0.R1
 

Platforms

All

flat

  Synopsis Show the context from the pwc on each line
  Context tree flat
  Tree flat
  Introduced 16.0.R1
 

Platforms

All