6. Global commands

back number
global
private
delete string
bof
debug
li
global
private
enable
exec string
echo
exit
all
history
info keyword
string
detail
flat
json
model keyword
units
xml
insert string
after
string
before
string
end
logout
oam
efm
keyword
port-id string
keyword
port-id string
eth-cfm
(mac-unicast-address-no-zero | number)
data-length number
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
(mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
ttl number
(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
(mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
(mac-unicast-address-no-zero | number)
ma-admin-name reference
md-admin-name reference
mep-id number
priority number
(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
ping
(ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
count number
fc keyword
interface string
interval (number | decimal-number)
next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
output-format keyword
pattern (keyword | number)
router-instance string
size number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
subscriber string
timeout number
tos number
ttl number
pwc
keyword
pyexec (string | string)
ssh
(ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)
mbytes (number | keyword)
minutes (number | keyword)
login-name string
router-instance (string | string)
version keyword
telnet
(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
(ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
dest-port number
detail
min-ttl number
numeric
probe-count number
protocol keyword
router-instance string
size number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
tos number
ttl number
wait number
tree
string
detail
flat

6.1. Global command descriptions

back [levels] number

Synopsis

Move back one or more levels

Context

back number

Tree
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

configure

Synopsis

Enter a candidate configuration mode

Context
Tree
Introduced

16.0.R3

Platforms

All

exclusive

Synopsis

Enter exclusive configuration mode

Tree
Introduced

16.0.R3

Platforms

All

global

Synopsis

Enter global configuration mode

Context
Tree
Introduced

16.0.R3

Platforms

All

private

Synopsis

Enter private configuration mode

Tree
Introduced

16.0.R4

Platforms

All

read-only

Synopsis

Enter read-only configuration mode

Tree
Introduced

16.0.R3

Platforms

All

delete [cli-path] string

Synopsis

Delete an element

Context

delete string

Tree
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 candidate configuration mode

Context
Introduced

16.0.R1

Platforms

All

bof

Synopsis

Enter the bof candidate configuration mode

Context
Tree
Introduced

16.0.R1

Platforms

All

debug

Synopsis

Enter the debug candidate configuration mode

Tree
Introduced

21.5.R1

Platforms

All

li

Synopsis

Enter the li candidate configuration mode

Context
Tree
Introduced

19.10.R1

Platforms

All

exclusive

Synopsis

Enter exclusive configuration mode

Tree
Introduced

16.0.R1

Platforms

All

global

Synopsis

Enter global configuration mode

Tree
Introduced

16.0.R1

Platforms

All

private

Synopsis

Enter private configuration mode

Tree
Introduced

16.0.R4

Platforms

All

read-only

Synopsis

Enter read-only configuration mode

Tree
Introduced

16.0.R1

Platforms

All

enable

Synopsis

Enable administrative mode

Context
Tree
Introduced

20.2.R1

Platforms

All

exec [url] string

Synopsis

Execute commands from a file

Context

exec string

Tree
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
Introduced

16.0.R1

Platforms

All

exit

Synopsis

Return to the previous context or to operational root

Context
Tree
Introduced

16.0.R1

Platforms

All

all

Synopsis

Return to the root context

Context
Tree
Introduced

16.0.R1

Platforms

All

history

Synopsis

Show the command history

Context
Tree
Introduced

16.0.R1

Platforms

All

info [from] keyword

Synopsis

Show the information under the present working context

Context

info keyword

Tree
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 string

Introduced

20.10.R1

Platforms

All

converted

Synopsis

Include converted third party model configuration from the running datastore

Context

info keyword converted

Tree
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
Introduced

16.0.R1

Platforms

All

flat

Synopsis

Show the context from the pwc on each line

Context

info keyword flat

Tree
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
Introduced

16.0.R1

Platforms

All

inheritance

Synopsis

Include configuration inherited from configuration groups

Context

info keyword 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
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
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
Introduced

20.5.R1

Platforms

All

xml

Synopsis

Show the output in indented XML format

Context

info keyword xml

Tree
Notes

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

Introduced

20.7.R1

Platforms

All

insert [new-entry] string

Synopsis

Insert an element into a user-ordered list

Context

insert string

Tree
Introduced

19.10.R1

Platforms

All

[new-entry] string

Synopsis

Identification of the new entry

Context

insert string

Notes

This element is part of a list key.

Introduced

19.10.R1

Platforms

All

after

Synopsis

Insert an entry after the specified entry

Context

insert string after

Tree
Notes

The following elements are part of a choice: after, before, beginning, or end.

Introduced

19.10.R1

Platforms

All

[entry-name] string

Synopsis

Absolute path or relative path from pwc

Context

insert string after string

Introduced

19.10.R1

Platforms

All

before

Synopsis

Insert an entry before the specified entry

Context

insert string before

Tree
Notes

The following elements are part of a choice: after, before, beginning, or end.

Introduced

19.10.R1

Platforms

All

[named-entry] string

Synopsis

Absolute path or relative path from pwc

Context

insert string before string

Introduced

19.10.R1

Platforms

All

beginning

Synopsis

Insert the new entry at the beginning of the list

Context
Tree
Notes

The following elements are part of a choice: after, before, beginning, or end.

Introduced

19.10.R1

Platforms

All

end

Synopsis

Insert the new entry at the end of the list

Context

insert string end

Tree
Notes

This element is the default part of a choice.

The following elements are part of a choice: after, before, beginning, or end.

Introduced

19.10.R1

Platforms

All

logout

Synopsis

Exit the CLI session

Context
Tree
Introduced

16.0.R1

Platforms

All

oam

Synopsis

Perform OAM tests

Context
Tree
Introduced

20.2.R1

Platforms

All

efm

Synopsis

Enter the efm context

Context
Tree
Introduced

20.2.R1

Platforms

All

local-loopback

Synopsis

Start or stop local loopback test on a port

Introduced

20.2.R1

Platforms

All

[action] keyword

Synopsis

Action type for the test

Context
Tree
Options

start, stop

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

port-id string

Synopsis

Port ID for the test

Context
Tree
Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

remote-loopback

Synopsis

Start or stop remote loopback test on a port

Introduced

20.2.R1

Platforms

All

[action] keyword

Synopsis

Action type for the test

Context
Options

start, stop

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

port-id string

Synopsis

Port ID for the test

Tree
Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

eth-cfm

Synopsis

Initiate an Ethernet Connectivity Fault Management test

Context
Tree
Introduced

20.2.R1

Platforms

All

eth-test

Synopsis

Initiate an OAM ETH-CFM test

Tree
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 (mac-unicast-address-no-zero | number)

Range

1 to 8191

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

data-length number

Synopsis

Size of the padding to be added to the frame

Range

64 to 1500

Default

64

Introduced

20.2.R1

Platforms

All

ma-admin-name reference

Synopsis

Association name

Context
Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Context
Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Context
Tree
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
Tree
Range

0 to 7

Default

7

Introduced

20.2.R1

Platforms

All

linktrace

Synopsis

Initiate a linktrace test

Tree
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)

Range

1 to 8191

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

ma-admin-name reference

Synopsis

Association name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Context
Tree
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
Tree
Range

0 to 255

Default

64

Introduced

20.2.R1

Platforms

All

loopback

Synopsis

Initiate a loopback test

Tree
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 (mac-unicast-address-no-zero | keyword | number)

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
Tree
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

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
Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Context
Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Context
Tree
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
Tree
Range

0 to 7

Introduced

20.2.R1

Platforms

All

send-count number

Synopsis

Number of loopback messages to send

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
Tree
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
Tree
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

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 (mac-unicast-address-no-zero | number)

Range

1 to 8191

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

ma-admin-name reference

Synopsis

Association name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Tree
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

Tree
Range

0 to 7

Default

7

Introduced

20.2.R1

Platforms

All

two-way-delay-test

Synopsis

Initiate a 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 (mac-unicast-address-no-zero | number)

Range

1 to 8191

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

ma-admin-name reference

Synopsis

Association name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Tree
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

Tree
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

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 (mac-unicast-address-no-zero | number)

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
Range

1 to 10 | 0.1 to 0.9

Default

5

Units

seconds

Introduced

20.2.R1

Platforms

All

ma-admin-name reference

Synopsis

Association name

Reference

state eth-cfm domain string association string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

md-admin-name reference

Synopsis

Domain name

Reference

state eth-cfm domain string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

mep-id number

Synopsis

Local Maintenance Association Endpoint (MEP) ID

Tree
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

Tree
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

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

Tree
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

Tree
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
Tree
Introduced

20.2.R1

Platforms

All

action keyword

Synopsis

OAM-PM test action

Context

oam oam-pm action keyword

Tree
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
Reference

state oam-pm session string

Notes

This element is mandatory.

Introduced

20.2.R1

Platforms

All

test-type keyword

Synopsis

Test type

Context
Tree
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
Tree
Introduced

20.10.R1

Platforms

All

ping

Synopsis

Ping an IP address or DNS name

Context
Tree
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 (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

String Length

1 to 128

Notes

This element is mandatory.

Introduced

19.10.R1

Platforms

All

bypass-routing

Synopsis

Bypass routing table when sending ping request to host

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
Range

1 to 100000

Default

5

Units

packets

Introduced

19.10.R1

Platforms

All

do-not-fragment

Synopsis

Do not fragment the request frame

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
Default

nc

Options

be, l2, af, l1, h2, ef, h1, nc

Introduced

19.10.R1

Platforms

All

interface string

Synopsis

Sending interface name

Context
Tree
Reference

state router string interface string

state router ies string interface string

state router ies string subscriber-interface string

state router vprn string interface string

state router vprn string subscriber-interface string

String Length

1 to 32

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
Range

1 to 10000 | 0.01 to 100.0

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)

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
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
Range

0 to 65535

Default

sequential

Options

sequential

Introduced

19.10.R1

Platforms

All

router-instance string

Synopsis

Router name or VPRN service name

Context
Reference

state router string

state router vprn string

Default

Base

Introduced

19.10.R1

Platforms

All

size number

Synopsis

Request packet size including ICMP header and payload

Context

ping size number

Tree
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)

Introduced

19.10.R1

Platforms

All

subscriber string

Synopsis

Subscriber ID for sending ICMP Echo Request packets

Context
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
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
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
Range

1 to 128

Default

64

Introduced

19.10.R1

Platforms

All

pwc

Synopsis

Show the present working context

Context
Tree
Introduced

16.0.R1

Platforms

All

[path-type] keyword

Synopsis

Alternative format to display the path

Context

pwc keyword

Options

model-path, xpath, cli-path, json-instance-path

Introduced

19.10.R1

Platforms

All

previous

Synopsis

Display previous working context

Context
Tree
Introduced

16.0.R1

Platforms

All

pyexec [url] (string | string)

Synopsis

Execute a Python application

Context

pyexec (string | string)

Tree
Introduced

21.7.R1

Platforms

All

[url] (string | string)

Synopsis

Location of the script to be executed

Context

pyexec (string | string)

Notes

This element is part of a list key.

Introduced

21.7.R1

Platforms

All

quit-config

Synopsis

Exit the candidate configuration mode

Context
Introduced

16.0.R1

Platforms

All

ssh

Synopsis

SSH to an IP address or DNS name

Context
Tree
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 (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

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

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
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
Range

1 to 1440

Default

60

Units

minutes

Options

infinite

Introduced

20.7.R1

Platforms

All

login-name string

Synopsis

SSH login username

Context
String Length

1 to 32

Introduced

20.7.R1

Platforms

All

router-instance (string | string)

Synopsis

Router name or VPRN service name

Context

ssh router-instance (string | string)

Default

Base

Reference

state router string

state router vprn string

Introduced

20.7.R1

Platforms

All

version keyword

Synopsis

SSH protocol version supported by the SSH server

Context

ssh version keyword

Tree
Default

2

Options

1, 2, 1-2

Introduced

20.7.R1

Platforms

All

telnet

Synopsis

Telnet to an IP address or DNS name

Context
Tree
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 (ipv4-address-with-zone | ipv6-address-with-zone | string-not-all-spaces)

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
Range

1 to 65535

Default

23

Introduced

20.7.R1

Platforms

All

router-instance (string | string)

Synopsis

Router name or VPRN service name

Context

telnet router-instance (string | string)

Default

Base

Reference

state router string

state router vprn 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)

Introduced

20.7.R1

Platforms

All

top

Synopsis

Move to the top level of the context

Context
Tree
Introduced

16.0.R1

Platforms

All

traceroute

Synopsis

Show the route taken to an IP address or DNS name

Context
Introduced

19.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 (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)

String Length

1 to 128

Notes

This element is mandatory.

Introduced

19.10.R1

Platforms

All

dest-port number

Synopsis

Transport protocol destination port number

Context
Tree
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

Introduced

21.10.R1

Platforms

All

detail

Synopsis

Display MPLS label stack information or TCP port status

Tree
Introduced

19.10.R1

Platforms

All

min-ttl number

Synopsis

First hop traceroute probes using the ttl value

Context
Tree
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

Tree
Introduced

19.10.R1

Platforms

All

probe-count number

Synopsis

Number of probes to send per hop

Context
Range

1 to 10

Default

3

Introduced

20.10.R1

Platforms

All

protocol keyword

Synopsis

Packet type to send

Context
Tree
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

20.10.R1

Platforms

All

router-instance string

Synopsis

Router name or VPRN service name

Default

Base

Reference

state router string

state router vprn string

Introduced

19.10.R1

Platforms

All

size number

Synopsis

Number of pad bytes in each transmitted packet

Context
Tree
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)

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
Tree
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
Tree
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
Tree
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
Introduced

16.0.R1

Platforms

All

[cli-path] string

Synopsis

Absolute path or relative path from pwc

Context

tree cli-path string

Tree
Introduced

20.10.R1

Platforms

All

detail

Synopsis

Display the tree with keys and field values

Context
Tree
Introduced

16.0.R1

Platforms

All

flat

Synopsis

Show the context from the pwc on each line

Context
Tree
Introduced

16.0.R1

Platforms

All