Virtnet CLI Commands

To communicate with the virtio-net-controller backend service, a user frontend program, virtnet, is installed on the BlueField which is based on r emote procedure call (RPC) protocol with JSON format output. Run the following command to check its usage:

            

            
# virtnet -h usage: virtnet [-h] [-v]
               {hotplug,unplug,list,query,modify,log,version,validate,update,debug,stats} ...
 
NVIDIA virtio-net-controller command line interface v24.07.04
 
positional arguments:
  {hotplug,unplug,list,query,modify,log,version,update,debug}
                        ** Use -h for sub-command usage
    hotplug             hotplug virtnet device
    unplug              unplug virtnet device
    list                list all virtnet devices
    query               query all or individual virtnet device(s)
    modify              modify virtnet device
    log                 set log level
    version             show virtio net controller version info
    validate            validate configurations
    update              update controller
    debug               For debug purpose, cmds can be changed without notice
    stats               stats of virtnet device
 
optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
        

Virtnet supports command line autocomplete by inputting one command with tab.

To check the currently running controller version:

            

            
# virtnet -v
v24.07.09
        

This command hotplugs a virtio-net PCIe PF device exposed to the host side.

Syntax

            

            
virtnet hotplug -i IB_DEVICE -m MAC -t MTU -n MAX_QUEUES -s MAX_QUEUE_SIZE [-h] [-u SF_NUM] [-f FEATURES] [-l]
        

Output

    
bdf    

    
vuid    

    
id    

    
transitional    

    
sf_rep_net_device    

    
mac    

Example

Hotplug one device with MAC address 0C:C4:7A:FF:22:93, MTU 1500, and 3 virtio queues (1 tx, 1 rx, 1 ctrl) with a depth of 1024 entries. The device is created on the physical port of mlx5_0.

            

            
# virtnet hotplug -i mlx5_0 -f 0x80000 -m 0C:C4:7A:FF:22:93 -t 1500 -n 3 -s 1024
{
  "bdf": "15:00.0",
  "vuid": "MT2151X03152VNETS1D0F0",
  "id": 0,
  "transitional": 0,
  "sf_rep_net_device": "en3f0pf0sf2000",
  "mac": "0C:C4:7A:FF:22:93",
  "errno": 0,
  "errstr": "Success"
}
        

This command unplugs a virtio-net PCIe PF device.

Syntax

            

            
virtnet unplug [-h] [-p PF | -u VUID]
        

Only one of --pf and --vuid is needed to unplug the device.

Output

Example

Unplug-hotplug device using the PF ID:

            

            
# virtnet unplug -p 0
{'id': '0x1'}
{
  "errno": 0,
  "errstr": "Success"
}
        

This command lists all existing virtio-net devices, with global information and individual information for each device.

Syntax

            

            
virtnet list [-h]
        

Output

The output has two main sections. The first section wrapped by the controller are global configurations and capabilities.

    
max_hotplug_devices    

    
max_virt_net_devices    

    
max_virt_queues    

    
max_tunnel_descriptors    

    
supported_features    

    
supported_virt_queue_types    

Each device has its own section under devices.

    
transitional    

    
vuid    

    
pci_bdf    

    
enabled_vfs    

    
msix_num_pool_size    

    
min_msix_num    

    
max_msix_num    

    
min_num_of_qp    

    
max_num_of_qp    

    
qp_pool_size    

    
max_queues_size    

    
msix_config_vector    

    
mac    

    
mtu    

    
speed    

    
rss_max_key_size    

    
supported_hash_types    

    
ctrl_mac    

    
sf_parent_device_pci_addr    

    
sf_rep_net_device    

    
sf_rep_net_ifindex    

    
sf_rdma_device    

Example

The following is an example of a list with 1 static PF created:

            

            
# virtnet list
{
  "controller": {
    "emulation_manager": "mlx5_0",
    "max_hotplug_devices": "0",
    "max_virt_net_devices": "1",
    "max_virt_queues": "256",
    "max_tunnel_descriptors": "6",
    "supported_features": {
      "value": "0x8b00037700ef982f",
      "    0": "VIRTIO_NET_F_CSUM",
      "    1": "VIRTIO_NET_F_GUEST_CSUM",
      "    2": "VIRTIO_NET_F_CTRL_GUEST_OFFLOADS",
      "    3": "VIRTIO_NET_F_MTU",
      "    5": "VIRTIO_NET_F_MAC",
      "   11": "VIRTIO_NET_F_HOST_TSO4",
      "   12": "VIRTIO_NET_F_HOST_TSO6",
      "   15": "VIRTIO_F_MRG_RX_BUFFER",
      "   16": "VIRTIO_NET_F_STATUS",
      "   17": "VIRTIO_NET_F_CTRL_VQ",
      "   18": "VIRTIO_NET_F_CTRL_RX",
      "   19": "VIRTIO_NET_F_CTRL_VLAN",
      "   21": "VIRTIO_NET_F_GUEST_ANNOUNCE",
      "   22": "VIRTIO_NET_F_MQ",
      "   23": "VIRTIO_NET_F_CTRL_MAC_ADDR",
      "   32": "VIRTIO_F_VERSION_1",
      "   33": "VIRTIO_F_IOMMU_PLATFORM",
      "   34": "VIRTIO_F_RING_PACKED",
      "   36": "VIRTIO_F_ORDER_PLATFORM",
      "   37": "VIRTIO_F_SR_IOV",
      "   38": "VIRTIO_F_NOTIFICATION_DATA",
      "   40": "VIRTIO_F_RING_RESET",
      "   41": "VIRTIO_F_ADMIN_VQ",
      "   56": "VIRTIO_NET_F_HOST_USO",
      "   57": "VIRTIO_NET_F_HASH_REPORT",
      "   59": "VIRTIO_NET_F_GUEST_HDRLEN",
      "   63": "VIRTIO_NET_F_SPEED_DUPLEX"
    },
    "supported_virt_queue_types": {
      "value": "0x1",
      "    0": "SPLIT"
    },
    "supported_event_modes": {
      "value": "0x5",
      "    0": "NO_MSIX_MODE",
      "    2": "MSIX_MODE"
    }
  },
  "devices": [
    {
      "pf_id": 0,
      "function_type": "static PF",
      "transitional": 0,
      "vuid": "MT2306XZ00BNVNETS0D0F2",
      "pci_bdf": "e2:00.2",
      "pci_vhca_id": "0x2",
      "pci_max_vfs": "0",
      "enabled_vfs": "0",
      "msix_num_pool_size": 0,
      "min_msix_num": 0,
      "max_msix_num": 256,
      "min_num_of_qp": 0,
      "max_num_of_qp": 127,
      "qp_pool_size": 0,
      "num_msix": "256",
      "num_queues": "255",
      "enabled_queues": "0",
      "max_queue_size": "256",
      "msix_config_vector": "0xFFFF",
      "mac": "16:B0:E0:41:B8:0D",
      "link_status": "1",
      "max_queue_pairs": "127",
      "mtu": "1500",
      "speed": "100000",
      "rss_max_key_size": "0",
      "supported_hash_types": "0x0",
      "ctrl_mac": "00:00:00:00:00:00",
      "ctrl_mq": "0",
      "sf_num": 1000,
      "sf_parent_device": "mlx5_0",
      "sf_parent_device_pci_addr": "0000:03:00.0",
      "sf_rep_net_device": "en3f0pf0sf1000",
      "sf_rep_net_ifindex": 10,
      "sf_rdma_device": "mlx5_3",
      "sf_cross_mkey": "0x12642",
      "sf_vhca_id": "0x124",
      "sf_rqt_num": "0x0",
      "aarfs": "disabled"
    }
  ]
}
        

This command queries detailed information for a given device, including all VQ information if created.

Syntax

            

            
virtnet query [-h] {[-a] | [-p PF] [-v VF] | [-u VUID]} [--dbg_stats] [-b] [--latency_stats] [-q QUEUE_ID] [--stats_clear]
        

Output

Output has two main sections.

• The first section, wrapped by devices, are configuration and capabilities on the device level, the majority of which are the same as the list command. This section only covers the differences between the two.

  Entry	Type	Description
  devices	String	Entries under this section is per-device information
  pci_dev_id	String	Virtio-net PCIe device ID. Default: 0x1041. Note This option will be depreciated in the future.
  pci_vendor_id	String	Virtio-net PCIe vendor ID. Default: 0x1af4. Note This option will be depreciated in the future.
  pci_class_code	String	Virtio-net PCIe device class code. Default: 0x20000. Note This option will be depreciated in the future.
  pci_subsys_id	String	Virtio-net PCIe vendor ID. Default: 0x1041. Note This option will be depreciated in the future.
  pci_subsys_vendor_id	String	Virtio-net PCIe subsystem vendor ID. Default: 0x1af4. Note This option will be depreciated in the future.
  pci_revision_id	String	Virtio-net PCIe revision ID. Default: 1. Note This option will be depreciated in the future.
  device_features	String	Enabled device feature bits according to the virtio spec. Refer to Virtio-net Feature Bits.
  driver_features	String	Enabled driver feature bits according to the virtio spec. Valid only when the driver probes the device. Refer to Virtio-net Feature Bits.
  status	String	Device status field bit masks according to the virtio spec: ACKNOWLEDGE (bit 0) DRIVER (bit 1) DRIVER_OK (bit 2) FEATURES_OK (bit 3) DEVICE_NEEDS_RESET (bit 6) FAILED (bit 7)
  reset	Number	Shows if the current virtio-net device undergoing reset: 0 – not undergoing reset 1 – undergoing reset
  enabled	Number	Shows if the current virtio-net device is enabled: 0 – disabled, likely FLR has occurred 1 – enabled

• The second section, wrapped by enabled-queues-info, provides per-VQ information:

  Entry	Type	Description
  index	Number	VQ index starting from 0 to enabled_queues
  size	Number	Driver VQ depth in bytes. It is bound by device max_queues_size .
  msix_vector	Number	The MSI-X vector number used for this VQ
  enable	Number	If current VQ is enabled or not 0 – disabled 1 – enabled
  notify_offset	Number	Driver reads this to calculate the offset from start of notification structure at which this virtqueue is located
  descriptor_address	Number	The physical address of the descriptor area
  driver_address	Number	The physical address of the driver area
  device_address	Number	The physical address of the device area
  received_desc	Number	Total number of received descriptors by the device on this VQ Note This option will be depreciated in the future.
  completed_desc	Number	Total number of completed descriptors by the device on this VQ Note This option will be depreciated in the future.
  bad_desc_errors	Number	Total number of bad descriptors received on this VQ Note This option will be depreciated in the future.
  error_cqes	Number	Total number of error CQ entries on this VQ Note This option will be depreciated in the future.
  exceed_max_chain	Number	Total number of chained descriptors received that exceed the maximum allowed chain by device Note This option will be depreciated in the future.
  invalid_buffer	Number	Total number of times the device tried to read or write buffer that is not registered to the device Note This option will be depreciated in the future.
  batch_number	Number	The number of RX descriptors for the last received packet. Relevant for BlueField-3 only. Note This option will be depreciated in the future.
  dma_q_used_number	Number	The DMA q index used for this VQ. Relevant for BlueField-3 only. Note This option will be depreciated in the future.
  handler_schd_number	Number	Scheduler number for this VQ. Relevant for BlueField-3 only. Note This option will be depreciated in the future.
  aux_handler_schd_number	Number	Aux scheduler number for this VQ. Relevant for BlueField-3 only. Note This option will be depreciated in the future.
  max_post_desc_number	Number	Maximum number of posted descriptors on this VQ. Relevant for DPA. Note This option will be depreciated in the future.
  total_bytes	Number	Total number of bytes handled by this VQ. Relevant for BlueField-3 only Note This option will be depreciated in the future.
  rq_cq_max_count	Number	Event generation moderation counter of the queue. Relevant for RQ. Note This option will be depreciated in the future.
  rq_cq_period	Number	Event generation moderation timer for the queue in 1 µ sec granularity. Relevant for RQ. Note This option will be depreciated in the future.
  rq_cq_period_mode	Number	Current period mode for RQ 0x0 – default_mode – use device best defaults 0x1 – upon_event – queue_period timer restarts upon event generation 0x2 – upon_cqe – queue_period timer restarts upon completion generation Note This option will be depreciated in the future.

Example

The following is an example of querying the information of the first PF:

            

            
# virtnet query -p 0
{
  "devices": [
    {
      "pf_id": 0,
      "function_type": "static PF",
      "transitional": 0,
      "vuid": "MT2349X00018VNETS0D0F1",
      "pci_bdf": "23:00.1",
      "pci_vhca_id": "0x1",
      "pci_max_vfs": "0",
      "enabled_vfs": "0",
      "pci_dev_id": "0x1041",
      "pci_vendor_id": "0x1af4",
      "pci_class_code": "0x20000",
      "pci_subsys_id": "0x1041",
      "pci_subsys_vendor_id": "0x1af4",
      "pci_revision_id": "1",
       "device_feature": {
        "value": "0x8930032300e7182f",
        "    0": "VIRTIO_NET_F_CSUM",
        "    1": "VIRTIO_NET_F_GUEST_CSUM",
        "    2": "VIRTIO_NET_F_CTRL_GUEST_OFFLOADS",
        "    3": "VIRTIO_NET_F_MTU",
        "    5": "VIRTIO_NET_F_MAC",
        "   11": "VIRTIO_NET_F_HOST_TSO4",
        "   12": "VIRTIO_NET_F_HOST_TSO6",
        "   16": "VIRTIO_NET_F_STATUS",
        "   17": "VIRTIO_NET_F_CTRL_VQ",
        "   18": "VIRTIO_NET_F_CTRL_RX",
        "   21": "VIRTIO_NET_F_GUEST_ANNOUNCE",
        "   22": "VIRTIO_NET_F_MQ",
        "   23": "VIRTIO_NET_F_CTRL_MAC_ADDR",
        "   32": "VIRTIO_F_VERSION_1",
        "   33": "VIRTIO_F_IOMMU_PLATFORM",
        "   37": "VIRTIO_F_SR_IOV",
        "   40": "VIRTIO_F_RING_RESET",
        "   41": "VIRTIO_F_ADMIN_VQ",
        "   52": "VIRTIO_NET_F_VQ_NOTF_COAL",
        "   53": "VIRTIO_NET_F_NOTF_COAL",
        "   56": "VIRTIO_NET_F_HOST_USO",
        "   59": "VIRTIO_NET_F_GUEST_HDRLEN",
        "   63": "VIRTIO_NET_F_SPEED_DUPLEX"
      },
      "driver_feature": {
        "value": "0x8000002300e7182f",
        "    0": "VIRTIO_NET_F_CSUM",
        "    1": "VIRTIO_NET_F_GUEST_CSUM",
        "    2": "VIRTIO_NET_F_CTRL_GUEST_OFFLOADS",
        "    3": "VIRTIO_NET_F_MTU",
        "    5": "VIRTIO_NET_F_MAC",
        "   11": "VIRTIO_NET_F_HOST_TSO4",
        "   12": "VIRTIO_NET_F_HOST_TSO6",
        "   16": "VIRTIO_NET_F_STATUS",
        "   17": "VIRTIO_NET_F_CTRL_VQ",
        "   18": "VIRTIO_NET_F_CTRL_RX",
        "   21": "VIRTIO_NET_F_GUEST_ANNOUNCE",
        "   22": "VIRTIO_NET_F_MQ",
        "   23": "VIRTIO_NET_F_CTRL_MAC_ADDR",
        "   32": "VIRTIO_F_VERSION_1",
        "   33": "VIRTIO_F_IOMMU_PLATFORM",
        "   37": "VIRTIO_F_SR_IOV",
        "   63": "VIRTIO_NET_F_SPEED_DUPLEX"
      },
      "status": {
        "value": "0xf",
        "    0": "ACK",
        "    1": "DRIVER",
        "    2": "DRIVER_OK",
        "    3": "FEATURES_OK"
      },
      "reset": "0",
      "enabled": "1",
      "num_msix": "64",
      "num_queues": "63",
      "enabled_queues": "63",
      "max_queue_size": "256",
      "msix_config_vector": "0x0",
      "mac": "4E:6A:E1:41:D8:BE",
      "link_status": "1",
      "max_queue_pairs": "31",
      "mtu": "1500",
      "speed": "200000",
      "rss_max_key_size": "0",
      "supported_hash_types": "0x0",
      "ctrl_mac": "4E:6A:E1:41:D8:BE",
      "ctrl_mq": "31",
      "sf_num": 1000,
      "sf_parent_device": "mlx5_0",
      "sf_parent_device_pci_addr": "0000:03:00.0",
      "sf_rep_net_device": "en3f0pf0sf1000",
      "sf_rep_net_ifindex": 12,
      "sf_rdma_device": "mlx5_2",
      "sf_cross_mkey": "0xC042",
      "sf_vhca_id": "0x7E8",
      "sf_rqt_num": "0x0",
      "aarfs": "disabled"
      "enabled-queues-info": [
        {
          "index": "0",
          "size": "256",
          "msix_vector": "0x1",
          "enable": "1",
          "notify_offset": "0",
          "descriptor_address": "0x10cece000",
          "driver_address": "0x10cecf000",
          "device_address": "0x10cecf240",
          "received_desc": "256",
          "completed_desc": "0",
          "bad_desc_errors": "0",
          "error_cqes": "0",
          "exceed_max_chain": "0",
          "invalid_buffer": "0",
          "batch_number": "64",
          "dma_q_used_number": "6",
          "handler_schd_number": "4",
          "aux_handler_schd_number": "3",
          "max_post_desc_number": "0",
          "total_bytes": "0",
          "rq_cq_max_count": "0",
          "rq_cq_period": "0",
          "rq_cq_period_mode": "1"
        },
        ......
        }
      ]
    }
  ]
}
        

This command retrieves the packet counters for a specified device, including detailed information for all Rx and Tx virtqueues (VQs).

To enable/disable byte wise packet counters for each Rx queue, use the following command:

            

            
virtnet modify {[-p PF] [-v VF]} device -pkt_cnt {enable,disable}
        

• When enabled, byte-wise packet counters are initialized to zero.

• When disabled, the previous values are retained for debugging purposes. The command will still return these old, disabled counter values.

Syntax

            

            
virtnet stats [-h] {[-p PF] [-v VF] | [-u VUID]} [-q QUEUE_ID]
        

Output

The output has two sections.

• The first section wrapped by device are device details along with the packet counter statics enable state.

  Entry	Type	Description
  device	String	Entries under this section is per-device information
  pf_id	String	Physical function ID
  packet_counters	String	Indicates whether the packet counters feature is enabled or disabled

• The second section wrapped by queues-stats are information for each receive VQ.

  Entry	Type	Description
  VQ Index	Number	The VQ index starts at 0 (the first RQ) and continues up to the last SQ
  rx_64_or_less_octet_packets	Number	The number of packets received with a size of 0 to 64 bytes. Relevant for BlueField-3 RQ.
  rx_65_to_127_octet_packets	Number	The number of packets received with a size of 65 to 127 bytes. Relevant for BlueField-3 RQ.
  rx_128_to_255_octet_packets	Number	The number of packets received with a size of 128 to 255 bytes. Relevant for BlueField-3 RQ.
  rx_256_to_511_octet_packets	Number	The number of packets received with a size of 256 to 511 bytes. Relevant for BlueField-3 RQ.
  rx_512_to_1023_octet_packets	Number	The number of packets received with a size of 512 to 1023 bytes. Relevant for BlueField-3 RQ.
  rx_1024_to_1522_octet_packets	Number	The number of packets received with a size of 1024 to 1522 bytes. Relevant for BlueField-3 RQ.
  rx_1523_to_2047_octet_packets	Number	The number of packets received with a size of 1523 to 2047 bytes. Relevant for BlueField-3 RQ.
  rx_2048_to_4095_octet_packets	Number	The number of packets received with a size of 2048 to 4095 bytes. Relevant for BlueField-3 RQ.
  rx_4096_to_8191_octet_packets	Number	The number of packets received with a size of 4096 to 8191 bytes. Relevant for BlueField-3 RQ.
  rx_8192_to_9022_octet_packets	Number	The number of packets received with a size of 8192 to 9022 bytes. Relevant for BlueField-3 RQ.
  received_desc	Number	Total number of received descriptors by the device on this VQ
  completed_desc	Number	Total number of completed descriptors by the device on this VQ
  bad_desc_errors	Number	Total number of bad descriptors received on this VQ
  error_cqes	Number	Total number of error CQ entries on this VQ
  exceed_max_chain	Number	Total number of chained descriptors received that exceed the max allowed chain by device
  invalid_buffer	Number	Total number of times the device tried to read or write a buffer which is not registered to the device
  batch_number	Number	The number of RX descriptors for the last received packet. Relevant for BlueField-3.
  dma_q_used_number	Number	The DMA q index used for this VQ. Relevant for BlueField-3.
  handler_schd_number	Number	Scheduler number for this VQ. Relevant for BlueField-3.
  aux_handler_schd_number	Number	Aux scheduler number for this VQ. Relevant for BlueField-3.
  max_post_desc_number	Number	Maximum number of posted descriptors on this VQ. Relevant for DPA.
  total_bytes	Number	Total number of bytes handled by this VQ. Relevant for BlueField-3.
  rq_cq_max_count	Number	Event generation moderation counter of the queue. Relevant for RQ.
  rq_cq_period	Number	Event generation moderation timer for the queue in 1 µ sec granularity. Relevant for RQ.
  rq_cq_period_mode	Number	Current period mode for RQ 0x0 – default_mode – use device best defaults 0x1 – upon_event – queue_period timer restarts upon event generation 0x2 – upon_cqe – queue_period timer restarts upon completion generation

Example

The following is an example of querying the packet statistics information of PF 0 and VQ 0 (i.e., RQ):

            

            
# virtnet stats -p 0 -q 0
{'pf': '0x0', 'queue_id': '0x0'}
{
  "device": {
    "pf_id": 0,
    "packet_counters": "Enabled",
    "queues-stats": [
      {
        "VQ Index": 0,
        "rx_64_or_less_octet_packets": 0,
        "rx_65_to_127_octet_packets": 259,
        "rx_128_to_255_octet_packets": 0,
        "rx_256_to_511_octet_packets": 0,
        "rx_512_to_1023_octet_packets": 0,
        "rx_1024_to_1522_octet_packets": 0,
        "rx_1523_to_2047_octet_packets": 0,
        "rx_2048_to_4095_octet_packets": 199,
        "rx_4096_to_8191_octet_packets": 0,
        "rx_8192_to_9022_octet_packets": 0,
        "received_desc": "4096",
        "completed_desc": "0",
        "bad_desc_errors": "0",
        "error_cqes": "0",
        "exceed_max_chain": "0",
        "invalid_buffer": "0",
        "batch_number": "64",
        "dma_q_used_number": "0",
        "handler_schd_number": "44",
        "aux_handler_schd_number": "43",
        "max_post_desc_number": "0",
        "total_bytes": "0",
        "err_handler_schd_num": "0",
        "rq_cq_max_count": "0",
        "rq_cq_period": "0",
        "rq_cq_period_mode": "1"
      }
    ]
  }
}  
        

This command modifies the attributes of a given device.

Syntax

            

            
virtnet modify [-h] [-p PF] [-v VF] [-u VUID] [-a] {device,queue} ...
        

Device Options

            

            
virtnet modify device [-h] [-m MAC] [-t MTU] [-e SPEED] [-l LINK]
                           [-s STATE] [-f FEATURES]
                           [-o SUPPORTED_HASH_TYPES] [-k RSS_MAX_KEY_SIZE]
                           [-r RX_MODE] [-n MSIX_NUM] [-q MAX_QUEUE_SIZE]
                           [-d DST_PORT] [-b RX_DMA_Q_NUM]
                           [-dim {enable,disable}] [-dc {enable,disable}] [-pkt_cnt {enable,disable}]
                           [-aarfs {enable,disable}] [-qp MAX_QUEUE_PAIRS]
        

Queue Options

            

            
virtnet modify queue [-h] -e {event,cqe} -n PERIOD -c MAX_COUNT
        

Output

Example

To modify the link status of the first VF on the first PF to be down:

            

            
# virtnet modify -p 0 device -l 0
{'pf': '0x0', 'all': '0x0', 'subcmd': '0x0', 'link': '0x0'}
{
  "errno": 0,
  "errstr": "Success"
}
        

This command manages the log level of virtio-net-controller.

Syntax

            

            
virtnet log [-h] -l {info,err,debug}
        

Output

Example

To change the log level to info:

            

            
# virtnet log -l info
{'level': 'info'}
"Success"
        

To monitor current log output of the controller service with the latest 100 lines printed out:

            

            
$ journalctl -u virtio-net-controller -f -n 100
        

This command validates configurations of virtio-net-controller.

Syntax

            

            
virtnet validate [-h] -f PATH_TO_FILE
        

Output

Example

To check if virtnet.conf is a valid JSON file:

            

            
# virtnet validate -f /opt/mellanox/mlnx_virtnet/virtnet.conf
/opt/mellanox/mlnx_virtnet/virtnet.conf is valid
        

This command prints current and updated version of virtio-net-controller.

Syntax

            

            
virtnet version [-h]
        

Output

Example

Check current and next available controller version:

            

            
# virtnet version
[
  {
    "Original Controller": "v1.8.12"
  },
  {
    "Destination Controller": "v1.9.14"
  }
]
        

Live update minimizes network interface down time by performing online upgrade of the virtio-net controller without necessitating a full restart.

Syntax

            

            
virtnet update [-h] [-s | -t]
        

Output

Example

To start the live update process, run:

            

            
# virtnet update -s
{'start': '0x1'}
"Update started, use 'virtnet update -t' or check logs for status"
        

To check the update status during the update process:

            

            
# virtnet update -t
{'status': '0x1'}
{
  "current status": "inactive",
  "last status": "success",
  "time_used (s)": 0.604152
}
        

CLI commands will return non-0 error code upon failure. All error numbers are negative. When there is error happening from log, it could return error number as well.

If the error number is greater than -1000, it's standard error. Please refer to Linux error code at errno

If the error number is less or equal -1000, please refer to the table below for the explaination.