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 SOURCE] [source-interface <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 SOURCE

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.

`SOURCE` values	Description
<A.B.C.D>	An IPv4 address.
<X:X::X:X>	An IPv6 address.

source-interface <string>

Specifies the interface through which traceroute should send packets. By default, the interface is selected according to the routing table.

<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 traffic-capture¶

vrouter> cmd traffic-capture [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 traffic-capture new¶

vrouter> cmd traffic-capture new [name <name>] [vrf <string>] [count <uint16>] [filter <pcap-expr>] \
...            <ifname>

Capture traffic flowing on a network interface.

Input Parameters¶

name <name>: The name of the capture file. If not set a unique name will be automatically chosen (in format YYYY-MM-DD_HH-MM-SS.<ifname>.pcap). otherwise, if the file already exists it will be overwritten.
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 traffic-capture list¶

vrouter> cmd traffic-capture list

List captured traffic flow.

cmd traffic-capture read¶

vrouter> cmd traffic-capture read <name>

Read a captured traffic flow.

Input Parameters¶

<name> (mandatory): The name of the capture to read.

cmd traffic-capture export¶

vrouter> cmd traffic-capture export [vrf <string>] url URL <name>

Export a captured traffic flow.

Input Parameters¶

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 capture to export.

cmd traffic-capture flush¶

vrouter> cmd traffic-capture flush

Flush all captured traffic flow.

cmd traffic-capture delete¶

vrouter> cmd traffic-capture delete <name>

Delete a captured traffic flow.

Input Parameters¶

<name> (mandatory): The name of the capture to delete.

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>]
vrouter> cmd system-image set-next [<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 .update image from a remote URL.

name <name>

The custom name to assign of the .update 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 .update image.

`URL` values	Description
<http[s]://[user:passwd@]host[:port]/path/to/file.update>	An HTTP(S) file URL.
<sftp://user:passwd@host[:port]/path/to/file.update>	An SFTP file URL.
<scp://user:passwd@host[:port]/path/to/file.update>	An SCP file URL.
<ftp://user:passwd@host[:port]/path/to/file.update>	An FTP file URL.
<tftp://host[:port]/path/to/file.update>	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.

set-next [<name>]

Set a system image as next boot image. If it does not boot, the system will reboot to the default image. This option is not available for LVM disks.

<name>: The name of the image to set as next.

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 set-next-boot-params¶

vrouter> cmd set-next-boot-params [intel-iommu true|false] [iommu-allow-unsafe-interrupts true|false] \
...            [ixgbe-allow-unsupported-sfp true|false]

Set boot parameters, taking effect at next reboot. Image must be installed on disk.

Input Parameters¶

intel-iommu true|false: Enable intel iommu driver. Control intel_iommu=on|off kernel option.
iommu-allow-unsafe-interrupts true|false: Enable PCI passthrough on hardware that does not support interrupt remapping, when VM are trusted. Control vfio_iommu_type1.allow_unsafe_interrupts=0|1 kernel option.
ixgbe-allow-unsupported-sfp true|false: Bypass SFPs types restrictions on Intel ixgbe NICs. Control ixgbe.allow_unsupported_sfp=0|1 kernel option.

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.

cmd dhcp-client renew-lease¶

vrouter> cmd dhcp-client renew-lease [vrf <string>] IFNAME

Renew DHCP client lease period.

Input Parameters¶

vrf <string>

Specify the VRF.

IFNAME (mandatory)

The interface name.

IFNAME

An interface name.

cmd bgp rpki ssh-key create¶

Note

requires a Turbo Router Network License.

vrouter> cmd bgp rpki ssh-key create type TYPE name <string>

Create SSH keys.

Input Parameters¶

type TYPE (mandatory)

SSH key type.

`TYPE` values	Description
rsa-1024	RSA in 1024 bits.
rsa-2048	RSA in 2048 bits.
rsa-4096	RSA in 4096 bits.
ecdsa-256	ECDSA in 256 bits.
ecdsa-384	ECDSA in 384 bits.
ecdsa-521	ECDSA in 521 bits.
ed25519	EDDSA in 25519 bits.

name <string> (mandatory)

Name of the new key pair.

cmd bgp rpki ssh-key list¶

Note

requires a Turbo Router Network License.

vrouter> cmd bgp rpki ssh-key list [detail]

List SSH keys.

Input Parameters¶

detail: Show public key.

cmd bgp rpki ssh-key delete¶

Note

requires a Turbo Router Network License.

vrouter> cmd bgp rpki ssh-key delete <string>

Delete SSH keys.

Input Parameters¶

<string> (mandatory): Delete an existing key pair.

cmd bgp rpki ssh-host add¶

Note

requires a Turbo Router Network License.

vrouter> cmd bgp rpki ssh-host add HOST [port PORT] [vrf VRF]

Add host to routing known hosts.

Input Parameters¶

HOST (mandatory)

Host name to add to known hosts.

HOST

The domain-name type represents a DNS domain name. Fully quallified left to the models which utilize this type. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be encoded in punycode as described in RFC 3492.

port PORT

Use a specific port to join the remote host.

PORT	A 16-bit port number used by a transport protocol such as TCP or UDP.

vrf VRF

Specify the VRF.

`VRF` values	Description
main	The main vrf.
<string>	The vrf name.

cmd bgp rpki ssh-host delete¶

Note

requires a Turbo Router Network License.

vrouter> cmd bgp rpki ssh-host delete HOST-NAME

Delete host from routing known hosts.

Input Parameters¶

HOST-NAME (mandatory)

Host name to remove from known hosts.

HOST-NAME

The domain-name type represents a DNS domain name. Fully quallified left to the models which utilize this type. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be encoded in punycode as described in RFC 3492.

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 traffic-capture¶

Input Parameters¶

cmd traffic-capture new¶

Input Parameters¶

cmd traffic-capture list¶

cmd traffic-capture read¶

Input Parameters¶

cmd traffic-capture export¶

Input Parameters¶

cmd traffic-capture flush¶

cmd traffic-capture delete¶

Input Parameters¶

cmd identify-port¶

Input Parameters¶

cmd system-image¶

Input Parameters¶

cmd backup¶

Input Parameters¶

cmd set-next-boot-params¶

Input Parameters¶

cmd license file¶

Input Parameters¶

cmd license refresh¶

cmd troubleshooting-report¶

Input Parameters¶

cmd dns proxy clear-cache¶

Input Parameters¶

cmd dhcp-client renew-lease¶

Input Parameters¶

cmd bgp rpki ssh-key create¶

Input Parameters¶

cmd bgp rpki ssh-key list¶

Input Parameters¶

cmd bgp rpki ssh-key delete¶

Input Parameters¶

cmd bgp rpki ssh-host add¶

Input Parameters¶

cmd bgp rpki ssh-host delete¶

Input Parameters¶