3.2.1. cmd

Execute remote commands on the NETCONF server.

cmd banner

vrouter> cmd banner pre-login [message <string>] [reset]
vrouter> cmd banner post-login [message <string>] [reset]

Manage login banner.

Input Parameters

pre-login [message <string>] [reset]

Manage banner before a user logs in.

message <string>

Message to display.

reset

Reset message to factory defaults.

post-login [message <string>] [reset]

Manage banner after a user logs in.

message <string>

Message to display.

reset

Reset message to factory defaults.

cmd reboot

vrouter> cmd reboot [delay <uint32>] [cancel]

Schedule a system reboot after a grace period.

Input Parameters

delay <uint32>

The number of seconds to wait before rebooting. During that time, it is possible to cancel the reboot.

cancel

If defined, cancel a pending reboot.

Output Data

reboot-time <string>

The time at which the system will reboot.

cmd poweroff

vrouter> cmd poweroff [delay <uint32>] [cancel]

Schedule a system poweroff after a grace period.

Input Parameters

delay <uint32>

The number of seconds to wait before powering off. During that time, it is possible to cancel the poweroff.

cancel

If defined, cancel a pending poweroff.

Output Data

poweroff-time <string>

The time at which the system will be powered off.

cmd ping

vrouter> cmd ping [vrf <string>] [count <uint16>] [packetsize <uint16>] [nodns] \
...            [ipv6] [source <string>] [rate <uint16>] <destination>

Send ICMP ECHO_REQUEST messages to network hosts and print their responses.

Input Parameters

vrf <string>

The VRF in which to send the ICMP ECHO_REQUESTs. By default, they are sent in the ‘main’ vrf.

count <uint16>

Stop after sending count ECHO_REQUEST packets.

packetsize <uint16>

Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.

nodns

Numeric output only. No attempt will be made to lookup symbolic names for host addresses.

ipv6

Force IPv6 operation only. By default, it is detected from the destination. If destination is a host name, ipv4 is used by default unless this flag is set.

source <string>

Either an address, or an interface name. If interface is an address, it sets source address to specified interface address. If interface in an interface name, it sets source interface to specified interface. For IPv6, when doing ping to a link-local scope address, link specification (by the ‘%’-notation in destination, or by this option) is required.

rate <uint16>

The number of packets to send per second. By default, 1 packet is sent every second.

<destination> (mandatory)

The destination host (name or IP address).

cmd traceroute

vrouter> cmd traceroute [vrf <string>] [nodns] [ipv6] [source <string>] <host>

Display the route (path) that was used to connect to a certain IP address or hostname. It also measures the transit delays among hops.

Input Parameters

vrf <string>

The VRF in which the packets are sent by traceroute. By default, they are sent in the ‘main’ vrf.

nodns

Do not try to map IP addresses to host names when displaying them.

ipv6

Force IPv6 operation only. By default, it is detected from the destination. If destination is a host name, ipv4 is used by default unless this flag is set.

source <string>

Chooses an alternative source address. Note that an address of one of the interfaces must be selected. By default, the address of the outgoing interface is used.

<host> (mandatory)

The destination host (name or IP address).

cmd show-traffic

vrouter> cmd show-traffic [vrf <string>] [count <uint16>] [filter <pcap-expr>] <ifname>

Print traffic flowing on a network interface.

Input Parameters

vrf <string>

The VRF in which to capture traffic. This must be the VRF the interface belongs to. By default, the interface is assumed to be in the ‘main’ vrf.

count <uint16>

Stop after capturing count packets.

filter <pcap-expr>

Optional filter expression. This must be a valid PCAP filter. See https://www.tcpdump.org/manpages/pcap-filter.7.html for more details.

<ifname> (mandatory)

The name of the network interface on which to monitor traffic.

cmd identify-port

vrouter> cmd identify-port <port> [duration <uint16>]

Initiate adapter-specific action intended to enable an operator to easily identify a physical network interface by sight. Typically this involves blinking one or more LEDs on the specific network port.

Input Parameters

<port> (mandatory)

The port name.

duration <uint16>

Length of time to perform the identification, in seconds.

cmd system-image

vrouter> cmd system-image install-on-disk <device>
vrouter> cmd system-image import [name <name>] URL
vrouter> cmd system-image delete <name>
vrouter> cmd system-image list
vrouter> cmd system-image rename <name> new-name <string>
vrouter> cmd system-image set-default [<name>]

Manage system images.

Input Parameters

install-on-disk <device>

Install the system on a specific device.

<device> (mandatory)

The device on which to install the currently booted image.

import [name <name>] URL

Import a new system image from a remote URL.

name <name>

The custom name to assign of the image.

URL (mandatory)

The URL from which to download the image.

URL values

Description

<http[s]://[user:passwd@]host[:port]/path/to/file>

An HTTP(S) file URL.

<sftp://user:passwd@host[:port]/path/to/file>

An SFTP file URL.

<scp://user:passwd@host[:port]/path/to/file>

An SCP file URL.

<ftp://user:passwd@host[:port]/path/to/file>

An FTP file URL.

<tftp://host[:port]/path/to/file>

A TFTP file URL.
delete <name>

Delete an imported image.

<name> (mandatory)

The name of the image to delete.

list

Display a list of imported images.

rename <name> new-name <string>

Rename an image.

<name> (mandatory)

The current name of the image.

new-name <string> (mandatory)

The new name of the image.

set-default [<name>]

Set a system image as default boot image.

<name>

The name of the image to set as default.

cmd license

vrouter> cmd license import URL
vrouter> cmd license status

Manage license.

Input Parameters

import URL

Import a license file using an URL.

URL (mandatory)

The URL from which to download the license.

URL values

Description

<http[s]://[user:passwd@]host[:port]/path/to/file>

An HTTP(S) file URL.

<sftp://user:passwd@host[:port]/path/to/file>

An SFTP file URL.

<scp://user:passwd@host[:port]/path/to/file>

An SCP file URL.

<ftp://user:passwd@host[:port]/path/to/file>

An FTP file URL.

<tftp://host[:port]/path/to/file>

A TFTP file URL.
status

Display the license status.

cmd troubleshooting-report

vrouter> cmd troubleshooting-report list
vrouter> cmd troubleshooting-report delete <name>
vrouter> cmd troubleshooting-report flush
vrouter> cmd troubleshooting-report new
vrouter> cmd troubleshooting-report export url URL <name>

Manage troubleshooting reports.

Input Parameters

list

List existing troubleshooting reports.

delete <name>

Delete an existing troubleshooting report.

<name> (mandatory)

The name of the report to delete.

flush

Delete all existing troubleshooting reports.

new

Generate a new troubleshooting report.

export url URL <name>

Export an existing troubleshooting report to a remote server via SFTP.

url URL (mandatory)

The destination URL.

URL values

Description

<sftp://user:passwd@host[:port]/path/to/file>

An SFTP file URL.

<scp://user:passwd@host[:port]/path/to/file>

An SCP file URL.

<smtp[s]://[user:passwd@]host/email.addr@domain.tdl>

An SMTP(S) email URL.

<ftp://user:passwd@host[:port]/path/to/file>

An FTP file URL.

<tftp://host[:port]/path/to/file>

A TFTP file URL.

<http[s]://[user:passwd@]host[:port]/path/to/file>

An HTTP(S) file URL.
<name> (mandatory)

The name of the report to export.

cmd dns proxy clear-cache

vrouter> cmd dns proxy clear-cache [vrf <string>]

Clear DNS proxy cache.

Input Parameters

vrf <string>

Specify the VRF.