3.2.1. cmd¶

Execute remote commands on the NETCONF server.

cmd reboot¶

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

Schedule a system reboot after a grace period.

Input Parameters¶

delay <uint32>: The number of seconds to wait before reboot. During that time, it is possible to cancel the reboot.
cancel: If defined, cancel a pending reboot.
force: If defined, force reboot even if startup configuration is different than running configuration.

cmd poweroff¶

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

Schedule a system poweroff after a grace period.

Input Parameters¶

delay <uint32>: The number of seconds to wait before poweroff. During that time, it is possible to cancel the poweroff.
cancel: If defined, cancel a pending poweroff.
force: If defined, force poweroff even if startup configuration is different than running configuration.

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 NAME [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¶

NAME (mandatory)

The port name.

NAME	PCI port name.

duration <uint16>

Length of time to perform the identification, in seconds.

cmd system-image¶

vrouter> cmd system-image install-on-disk [backup-url BACKUP-URL] <device>
vrouter> cmd system-image import [name <name>] [vrf <string>] 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 [backup-url BACKUP-URL] <device>

Install the system on a specific device.

backup-url BACKUP-URL

The URL where the backup files are stored.

`BACKUP-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.
<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.

<device> (mandatory)

The device on which to install the currently booted image.

import [name <name>] [vrf <string>] URL

Import a new system image from a remote URL.

name <name>

The custom name to assign of the image.

vrf <string>

The VRF in which remote access is done. By default, they are sent in the ‘main’ vrf.

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 backup¶

vrouter> cmd backup import [vrf <string>] url URL
vrouter> cmd backup export [vrf <string>] url URL

Import/export backup archives containing configurations, keys, certificates, licenses.

Input Parameters¶

import [vrf <string>] url URL

Import backup archive from a remote server. WARNING: it will overwrite current configurations.

vrf <string>

The VRF in which remote access is done. By default, they are sent in the ‘main’ vrf.

url URL (mandatory)

The source 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.
<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.

export [vrf <string>] url URL

Export backup archive to a remote server.

vrf <string>

The VRF in which remote access is done. By default, they are sent in the ‘main’ vrf.

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.

cmd license file¶

vrouter> cmd license file import [url URL] [content <string>] serial <string>
vrouter> cmd license file list
vrouter> cmd license file delete <string>

Manage license files.

Input Parameters¶

import [url URL] [content <string>] serial <string>

Import a license file.

url URL

The URL from which to download the license file.

`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.

content <string>

The raw contents of the license file.

serial <string> (mandatory)

The serial number associated with the license file. It will be used as reference in the configuration.

list

List downloaded license files.

delete <string>

Delete a license file.

<string> (mandatory): The name of license file to delete.

cmd license refresh¶

vrouter> cmd license refresh

Refresh the license.

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 [vrf <string>] 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 [vrf <string>] url URL <name>

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

vrf <string>

The VRF in which remote access is done. By default, they are sent in the ‘main’ vrf.

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.

3.2.1. cmd¶

cmd banner¶

Input Parameters¶

cmd reboot¶

Input Parameters¶

cmd poweroff¶

Input Parameters¶

cmd ping¶

Input Parameters¶

cmd traceroute¶

Input Parameters¶

cmd show-traffic¶

Input Parameters¶

cmd identify-port¶

Input Parameters¶

cmd system-image¶

Input Parameters¶

cmd backup¶

Input Parameters¶

cmd license file¶

Input Parameters¶

cmd license refresh¶

cmd troubleshooting-report¶

Input Parameters¶

cmd dns proxy clear-cache¶

Input Parameters¶