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 instance-id
— edit-config
— bof
— debug
— exclusive
— global
— li
— private
— read-only
— enable
— exec string
— echo
— exit
— all
— history
— all
— commands-only
— info keyword
— [cli-path] cli-path-type
— 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 port
— remote-loopback
— [action] keyword
— port-id port
— 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 ipv4-address
— path-destination ipv4-address
— prefix (ipv4-prefix | ipv6-prefix)
— profile keyword
— send-count number
— size number
— source-ip-address ipv4-address
— 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 ipv4-address
— output-format keyword
— path-destination ipv4-address
— prefix (ipv4-prefix | ipv6-prefix)
— probe-count number
— profile keyword
— size number
— source-ip-address ipv4-address
— 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 ipv6-unicast-or-zero-address
— 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 subscriber-id
— 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-not-all-spaces
— port number
— private-key-file 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 ipv6-unicast-or-zero-address
— 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] cli-path-type
— detail
— flat
— [path-format] keyword
— vmhost
Global command descriptions
back [levels] number
[levels] number
bof
exclusive
private
read-only
configure
exclusive
global
private
read-only
debug
exclusive
private
read-only
delete [cli-path] instance-id
[cli-path] instance-id
edit-config
| Synopsis | Enter a configuration mode | |
| 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
exec [url] string
[url] string
echo
exit
all
history
all
commands-only
| Synopsis | Show only the commands in the command history | |
| Context | history commands-only | |
| Tree | commands-only | |
| Introduced | 24.7.R1 | |
Platforms | All |
info [from] keyword
[from] keyword
| Synopsis | Source datastore | |
| Context | info keyword | |
| Tree | info | |
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 default | candidate | |
Notes | This element is part of a list key. | |
| Introduced | 16.0.R1 | |
Platforms | All |
[cli-path] cli-path-type
| Synopsis | Absolute path or relative path from pwc | |
| Context | info keyword [cli-path] cli-path-type | |
| 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 |
depth number
detail
differences
| Synopsis | Show the different values each model tries to set | |
| Context | info keyword differences | |
| Tree | differences | |
Description | When specified, this command shows only the values that are different when multiple models try to set the same configuration element. This option is supported only with the converted option and is available only when configure system management-interface yang-modules openconfig-modules is set to true. This option is not supported for state elements. | |
Notes | The following elements are part of a choice: differences, model, or values. | |
| Introduced | 23.3.R1 | |
Platforms | All |
flat
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
model keyword
| Synopsis | Data model for which to display converted output | |
| Context | info keyword model keyword | |
| Tree | model | |
Description | This option specifies the data model for which to display the converted output. This option is supported only with the converted option and is available only when configure system management-interface yang-modules openconfig-modules is set to true. This option is not supported for state elements. | |
| Options | all – All models openconfig – OpenConfig models | |
| Default | all | |
Notes |
The following elements are part of a choice: differences, model, or values. | |
| Introduced | 20.7.R1 | |
Platforms | All |
units
values
| Synopsis | Show all the values each model tries to set | |
| Context | info keyword values | |
| Tree | values | |
Description | When specified, this command shows all the values that each model tries to set. This option is supported only with the converted option and is available only when configure system management-interface yang-modules openconfig-modules is set to true. This option is not supported for state elements. | |
Notes | The following elements are part of a choice: differences, model, or values. | |
| Introduced | 23.3.R1 | |
Platforms | All |
xml
li
exclusive
private
read-only
logout
oam
efm
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 | ||
Notes |
This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms |
All |
port-id port
| Synopsis | Port ID for the test | |
| Context | oam efm local-loopback port-id port | |
| 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 | ||
Notes |
This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms |
All |
port-id port
| Synopsis | Port ID for the test | |
| Context | oam efm remote-loopback port-id port | |
| Tree | port-id | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
eth-cfm
eth-test
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 | |
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 | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
mep-id number
priority number
linktrace
[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 | |
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 | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
mep-id number
ttl number
loopback
[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 – Class one destination multicast address based on the level of the local MEP | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
interval number
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 | |
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 | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
mep-id number
priority number
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 | |
| Units | bytes | |
| Default | 0 | |
| 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 | |
| Units | seconds | |
| Default | 5 | |
| 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 | |
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 | |
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 | |
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 | |
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 | |
| Units | seconds | |
| Default | 5 | |
| 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 | |
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 | |
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 | |
| Units | bytes | |
| Default | 0 | |
| 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 | |
| Units | seconds | |
| Default | 5 | |
| Introduced | 20.2.R1 | |
Platforms | All |
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)
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping bgp-label path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping bgp-label send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping bgp-label source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
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)
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping ldp path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping ldp send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping ldp source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ttl number
rsvp-te
fc keyword
interval number
lsp-name reference
path reference
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping rsvp-te send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping rsvp-te source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ttl number
sr-isis
fc keyword
flex-algo number
igp-instance number
| Synopsis | IGP instance for the SR-ISIS test | |
| Context | oam lsp-ping sr-isis igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 127 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
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) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping sr-isis send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping sr-isis source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ttl number
sr-ospf
fc keyword
flex-algo number
igp-instance number
| Synopsis | IGP instance for the SR-OSPF test | |
| Context | oam lsp-ping sr-ospf igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 31 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
interface reference
interval number
next-hop ipv4-address
path-destination ipv4-address
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping sr-ospf path-destination ipv4-address | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping sr-ospf send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address ipv4-address
| Synopsis | Source IP address | |
| Context | oam lsp-ping sr-ospf source-ip-address ipv4-address | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ttl number
sr-ospf3
fc keyword
igp-instance number
| Synopsis | IGP instance for the SR-OSPFv3 test | |
| Context | oam lsp-ping sr-ospf3 igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 31 | 64 to 95 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
interface reference
interval number
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping sr-ospf3 path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping sr-ospf3 send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping sr-ospf3 source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
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)
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping sr-policy path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
profile keyword
segment-list number
| Synopsis | Segment Routing segment list for the test | |
| Context | oam lsp-ping sr-policy segment-list number | |
| Tree | segment-list | |
| Range | 1 to 32 | |
| Introduced | 23.3.R1 | |
|
Platforms | All |
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping sr-policy send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping sr-policy source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
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)
| Synopsis | IP address of the path destination | |
| Context | oam lsp-ping sr-te path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
profile keyword
send-count number
| Synopsis | Number of echo request packets to send | |
| Context | oam lsp-ping sr-te send-count number | |
| Tree | send-count | |
| Range | 1 to 100 | |
| Units | packets | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-ping sr-te source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ttl number
lsp-trace
bgp-label
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace bgp-label downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace bgp-label output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.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 bgp-label path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace bgp-label probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace bgp-label source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
ldp
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace ldp downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace ldp output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.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) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace ldp probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace ldp source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
rsvp-te
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace rsvp-te downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
fc keyword
interval number
lsp-name reference
max-fail number
max-ttl number
min-ttl number
output-format keyword
| Synopsis | Output format for the result | |
| Context | oam lsp-trace rsvp-te output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.3.R1 | |
Platforms | All |
path reference
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace rsvp-te probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace rsvp-te source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
sr-isis
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace sr-isis downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
fc keyword
flex-algo number
igp-instance number
| Synopsis | IGP instance for the SR-ISIS test | |
| Context | oam lsp-trace sr-isis igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 127 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace sr-isis output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.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-isis path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace sr-isis probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace sr-isis source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
sr-ospf
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace sr-ospf downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
fc keyword
flex-algo number
igp-instance number
| Synopsis | IGP instance for the SR-OSPF test | |
| Context | oam lsp-trace sr-ospf igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 31 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
interface reference
interval number
max-fail number
max-ttl number
min-ttl number
next-hop ipv4-address
output-format keyword
| Synopsis | Output format for the result | |
| Context | oam lsp-trace sr-ospf output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.3.R1 | |
Platforms | All |
path-destination ipv4-address
| Synopsis | IP address of the path destination | |
| Context | oam lsp-trace sr-ospf path-destination ipv4-address | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace sr-ospf probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address ipv4-address
| Synopsis | Source IP address | |
| Context | oam lsp-trace sr-ospf source-ip-address ipv4-address | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
sr-ospf3
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace sr-ospf3 downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
fc keyword
igp-instance number
| Synopsis | IGP instance for the SR-OSPFv3 test | |
| Context | oam lsp-trace sr-ospf3 igp-instance number | |
| Tree | igp-instance | |
| Range | 0 to 31 | 64 to 95 | |
| Default | 0 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace sr-ospf3 output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.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-ospf3 path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
prefix (ipv4-prefix | ipv6-prefix)
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace sr-ospf3 probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace sr-ospf3 source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
sr-policy
color number
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace sr-policy downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace sr-policy output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.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-policy path-destination (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace sr-policy probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
segment-list number
| Synopsis | Segment Routing segment list for the test | |
| Context | oam lsp-trace sr-policy segment-list number | |
| Tree | segment-list | |
| Range | 1 to 32 | |
| Introduced | 23.3.R1 | |
|
Platforms | All |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace sr-policy source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
sr-te
downstream-map-tlv keyword
| Synopsis | Type of downstream mapping TLV in MPLS echo request PDU | |
| Context | oam lsp-trace sr-te downstream-map-tlv keyword | |
| Tree | downstream-map-tlv | |
| Options | dsmap – Downstream Mapping TLV ddmap – Downstream Detailed Mapping TLV none – No mapping TLV | |
| Introduced | 23.3.R1 | |
Platforms | All |
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
| Synopsis | Output format for the result | |
| Context | oam lsp-trace sr-te output-format keyword | |
| Tree | output-format | |
| Options | ||
| Default | summary | |
| Introduced | 23.3.R1 | |
Platforms | All |
path reference
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) | |
| Tree | path-destination | |
| Introduced | 23.3.R1 | |
Platforms | All |
probe-count number
| Synopsis | Number of OAM trace probes to send per TTL | |
| Context | oam lsp-trace sr-te probe-count number | |
| Tree | probe-count | |
| Range | 1 to 10 | |
| Default | 1 | |
| Introduced | 23.3.R1 | |
Platforms |
All |
profile keyword
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address | |
| Context | oam lsp-trace sr-te source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-ip-address | |
| Introduced | 23.3.R1 | |
Platforms | All |
timeout number
oam-pm
action keyword
session reference
test-type keyword
| Synopsis | Test type | |
| Context | oam oam-pm test-type keyword | |
| Tree | test-type | |
| Options | dm – MPLS Delay Measurement test dmm – Ethernet Delay Measurement Message test lmm – Ethernet Loss Measurement Message test slm – Ethernet Synthetic Loss Message test twamp-light – IP Two-Way Active Measurement Protocol (Light) test | |
Notes | This element is mandatory. | |
| Introduced | 20.2.R1 | |
Platforms | All |
saa
owner [owner-name] reference test reference
[owner-name] reference
test reference
start
accounting boolean
| Synopsis | Disable recording results in accounting policy | |
| Context | oam saa owner reference test reference start accounting boolean | |
| Tree | accounting | |
| Default | true | |
| Introduced | 22.10.R1 | |
|
Platforms | All |
stop
accounting boolean
| Synopsis | Disable recording results in accounting policy | |
| Context | oam saa owner reference test reference stop accounting boolean | |
| Tree | accounting | |
| Default | true | |
| Introduced | 22.10.R1 | |
|
Platforms | All |
service-activation-testhead
| Synopsis | Start or stop Service Activation Testhead service test | |
| Context | oam service-activation-testhead | |
| Tree | service-activation-testhead | |
| Introduced | 23.10.R1 | |
Platforms | All |
service-test [service-test-name] reference
| Synopsis | Service test name | |
| Context | oam service-activation-testhead service-test reference | |
| Tree | service-test | |
| Introduced | 23.10.R1 | |
Platforms | All |
[service-test-name] reference
| Synopsis | Name of the service test to be started or stopped | |
| Context | oam service-activation-testhead service-test reference | |
| Tree | service-test | |
Reference | state test-oam service-activation-testhead service-test test-name | |
Notes | This element is part of a list key. | |
| Introduced | 23.10.R1 | |
Platforms | All |
start
| Synopsis | Start OAM SATH service test | |
| Context | oam service-activation-testhead service-test reference start | |
| Tree | start | |
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. | |
| Introduced | 23.10.R1 | |
Platforms | All |
stop
| Synopsis | Stop OAM SATH service test | |
| Context | oam service-activation-testhead service-test reference stop | |
| Tree | stop | |
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. | |
| Introduced | 23.10.R1 | |
Platforms | All |
password
ping
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 |
candidate-path
| Synopsis | Ping candidate path of the SRv6 policy | |
| Context | ping candidate-path | |
| Tree | candidate-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. | |
| Introduced | 23.10.R1 | |
Platforms | All |
color number
| Synopsis | Color identifier of the Segment Routing IPv6 policy | |
| Context | ping color number | |
| Tree | color | |
| Max. range | 0 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). | |
| Introduced | 23.7.R1 | |
Platforms | All |
count number
[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 | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| Introduced | 19.10.R1 | |
Platforms | All |
distinguisher number
| Synopsis | SRv6 policy candidate path distinguisher | |
| Context | ping distinguisher number | |
| Tree | distinguisher | |
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. | |
| Range | 1 to 4294967295 | |
| Introduced | 23.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 |
endpoint ipv6-unicast-or-zero-address
| Synopsis | Endpoint identifier of the Segment Routing IPv6 policy to be pinged | |
| Context | ping endpoint ipv6-unicast-or-zero-address | |
| Tree | endpoint | |
Notes | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| Introduced | 23.7.R1 | |
Platforms | All |
fc keyword
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 state service ies interface interface-name state service ies subscriber-interface interface-name state service vprn interface interface-name state service vprn subscriber-interface interface-name | |
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)
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 | |
| Options | ||
| Default | detail | |
| Introduced | 19.10.R1 | |
Platforms | All |
pattern (keyword | number)
preference number
| Synopsis | SRv6 policy candidate path preference | |
| Context | ping preference number | |
| Tree | preference | |
Description | This command specifies the preference of the SRv6 policy candidate path to send the ping probe on. | |
| Max. range | 0 to 4294967295 | |
| Default | 100 | |
| Introduced | 23.10.R1 | |
|
Platforms | All |
protocol-owner keyword
| Synopsis | Protocol owner | |
| Context | ping protocol-owner keyword | |
| Tree | protocol-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. | |
| Options | ||
| Introduced | 23.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 state service vprn service-name | |
Notes | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| Introduced | 19.10.R1 | |
Platforms | All |
segment-list number
| Synopsis | Segment Routing IPv6 segment list to be pinged | |
| Context | ping segment-list number | |
| Tree | segment-list | |
| Range | 1 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). | |
| Introduced | 23.7.R1 | |
Platforms | All |
size number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
| Synopsis | Source IP address used in the ICMP Echo Request packet | |
| Context | ping source-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
| Tree | source-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). | |
| Introduced | 19.10.R1 | |
Platforms | All |
srv6-policy
| Synopsis | Ping a Segment Routing IPv6 policy | |
| Context | ping srv6-policy | |
| Tree | 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). | |
| Introduced | 23.7.R1 | |
Platforms | All |
subscriber subscriber-id
| Synopsis | Subscriber ID for sending ICMP Echo Request packets | |
| Context | ping subscriber subscriber-id | |
| 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
tos number
ttl number
pwc
[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 – 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 | |
| Introduced | 19.10.R1 | |
Platforms | All |
previous
pyexec [url] (string | string)
[url] (string | string)
[argument-01] string
| Synopsis | First argument | |
| Context | pyexec (string | string) [argument-01] string | |
| Tree | [argument-01] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-02] string
| Synopsis | Second argument | |
| Context | pyexec (string | string) [argument-02] string | |
| Tree | [argument-02] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-03] string
| Synopsis | Third argument | |
| Context | pyexec (string | string) [argument-03] string | |
| Tree | [argument-03] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-04] string
| Synopsis | Fourth argument | |
| Context | pyexec (string | string) [argument-04] string | |
| Tree | [argument-04] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-05] string
| Synopsis | Fifth argument | |
| Context | pyexec (string | string) [argument-05] string | |
| Tree | [argument-05] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-06] string
| Synopsis | Sixth argument | |
| Context | pyexec (string | string) [argument-06] string | |
| Tree | [argument-06] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-07] string
| Synopsis | Seventh argument | |
| Context | pyexec (string | string) [argument-07] string | |
| Tree | [argument-07] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-08] string
| Synopsis | Eight argument | |
| Context | pyexec (string | string) [argument-08] string | |
| Tree | [argument-08] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-09] string
| Synopsis | Ninth argument | |
| Context | pyexec (string | string) [argument-09] string | |
| Tree | [argument-09] | |
| Introduced | 21.7.R1 | |
Platforms | All |
[argument-10] string
| Synopsis | Tenth argument | |
| Context | pyexec (string | string) [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
[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 | |
| Units | megabytes | |
| Options | ||
| Default | 1024 | |
| 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 | |
| Units | minutes | |
| Options | ||
| Default | 60 | |
| Introduced | 20.7.R1 | |
Platforms |
All |
login-name string-not-all-spaces
| Synopsis | SSH login username | |
| Context | ssh login-name string-not-all-spaces | |
| Tree | login-name | |
| String length | 1 to 32 | |
| Introduced | 20.7.R1 | |
Platforms | All |
port number
private-key-file string
| Synopsis | File with SSH private key | |
| Context | ssh private-key-file string | |
| Tree | private-key-file | |
Description | This command configures the name of the file containing the private key for public-key authentication on the SR OS SSH client. (The public key must be provided to the SSH server.) If the file containing the private key is encrypted, the system asks for the password to decrypt the file. | |
| Introduced | 24.7.R1 | |
Platforms | All |
router-instance (string | string)
| Synopsis | Router name or VPRN service name | |
| Context | ssh router-instance (string | string) | |
| Tree | router-instance | |
| Default | Base | |
| 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 OS, 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
router-instance (string | string)
| Synopsis | Router name or VPRN service name | |
| Context | telnet router-instance (string | string) | |
| Tree | router-instance | |
| Default | Base | |
| 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
traceroute
| Synopsis | Show the route taken to an IP address or DNS name | |
| Context | traceroute | |
| Tree | traceroute | |
| Introduced | 19.10.R1 | |
Platforms | All |
candidate-path
| Synopsis | Trace route of the candidate path of the SRv6 policy | |
| Context | traceroute candidate-path | |
| Tree | candidate-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. | |
| Introduced | 23.10.R1 | |
Platforms | All |
color number
| Synopsis | Color ID of the SRv6 policy to trace | |
| Context | traceroute color number | |
| Tree | color | |
Description | This command launches a traceroute of an SRv6 policy that matches a specific color. | |
| Max. range | 0 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). | |
| Introduced | 23.3.R1 | |
Platforms | All |
decode keyword
| Synopsis | Perform original datagram parsing functions | |
| Context | traceroute decode keyword | |
| Tree | decode | |
| Options | ||
| Default | none | |
| Introduced | 22.7.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 | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| 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 |
distinguisher number
| Synopsis | SRv6 policy candidate path distinguisher | |
| Context | traceroute distinguisher number | |
| Tree | distinguisher | |
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. | |
| Range | 1 to 4294967295 | |
| Introduced | 23.10.R1 | |
Platforms | All |
endpoint ipv6-unicast-or-zero-address
| Synopsis | Endpoint of the SRv6 policy to trace | |
| Context | traceroute endpoint ipv6-unicast-or-zero-address | |
| Tree | endpoint | |
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). | |
| Introduced | 23.3.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 |
preference number
| Synopsis | SRv6 policy candidate path preference | |
| Context | traceroute preference number | |
| Tree | preference | |
Description | This command specifies the preference of the SRv6 policy candidate path to send the traceroute probe on. | |
| Max. range | 0 to 4294967295 | |
| Default | 100 | |
| Introduced | 23.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. | |
| Options | ||
| Default | udp | |
| Introduced | 21.10.R1 | |
Platforms | All |
protocol-owner keyword
| Synopsis | Protocol owner | |
| Context | traceroute protocol-owner keyword | |
| Tree | protocol-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. | |
| Options | ||
| Introduced | 23.10.R1 | |
Platforms |
All |
router-instance string
| Synopsis | Router name or VPRN service name | |
| Context | traceroute router-instance string | |
| Tree | router-instance | |
| Default | Base | |
Notes | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| Introduced | 19.10.R1 | |
Platforms | All |
segment-list number
| Synopsis | SR IPv6 segment list to trace | |
| Context | traceroute segment-list number | |
| Tree | segment-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. | |
| Range | 1 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). | |
| Introduced | 23.3.R1 | |
Platforms | All |
size number
| Synopsis | Number of pad bytes in each transmitted packet | |
| Context | traceroute size number | |
| Tree | size | |
| Range | 0 to 9786 | |
| Units | bytes | |
| Default | 0 | |
| 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. | |
Notes | The following elements are part of a mandatory choice: (destination, router-instance, and source-address) or (color, endpoint, segment-list, and srv6-policy). | |
| Introduced | 19.10.R1 | |
Platforms | All |
srv6-policy
| Synopsis | Trace an SRv6 policy | |
| Context | traceroute srv6-policy | |
| Tree | srv6-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). | |
| Introduced | 23.3.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 (TTL) to probe | |
| 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 | |
| Units | milliseconds | |
| Default | 5000 | |
| Introduced | 19.10.R1 | |
Platforms | All |
tree
[cli-path] cli-path-type
| Synopsis | Absolute path or relative path from pwc | |
| Context | tree [cli-path] cli-path-type | |
| Tree | [cli-path] | |
| Introduced | 20.10.R1 | |
Platforms | All |
detail
flat
[path-format] keyword
| Synopsis | Alternative format to display the path | |
| Context | tree [path-format] keyword | |
| Tree | [path-format] | |
Description | This option outputs the tree information in alternative YANG formats for use in external tools, such as pySROS, gNMI, or the Network Services Platform (NSP). | |
| Options | model-path – YANG-modeled format for RESTCONF gnmi-path – gNMI format for streaming telemetry json-instance-path – YANG-modeled format for pySROS | |
Notes | The following elements are part of a choice: (detail and flat) or path-format. | |
| Introduced | 24.7.R1 | |
Platforms | All |