xrt-smi Utility - xrt-smi Utility - 2026.1 English

Vitis Reference Guide (UG1702)

Document ID
UG1702
Release Date
2026-06-23
Version
2026.1 English

The xrt-smi utility is a standalone command line utility that comes with the Xilinx Runtime (XRT) installation package. See details of the xrt-smi command at https://xilinx.github.io/XRT/master/html/xrt-smi.html.

xrt-smi includes multiple commands to validate and identify the installed accelerator card(s). xrt-smi also includes card details that has on card memory, host interface, target platform name, and system information. This information is useful for card administration and application debugging.

Accelerator cards partition into a user function and a management function for different levels of card access. The user function lets you load and run applications, while the management function is for system administrators to manage the card. The xrt-smi utility interacts with the user function. The xbmgmt utility, which requires root privilege, is for interacting with the management function. The reason for splitting the function access between the two utilities is to provide some security for the management features of the tool.

You can use the help command to list the available xrt-smi commands and options:
xrt-smi --help

Set up the xrt-smi command as part of the XRT installation using the following scripts:

  • For csh shell:
    $ source /opt/xilinx/xrt/setup.csh
  • For bash shell:
    $ source /opt/xilinx/xrt/setup.sh