xbmgmt Utility

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
UG1393
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

Xilinx® Board Management (xbmgmt) utility is a standalone command line tool that is included with the Xilinx Runtime (XRT) installation package. Details of the xbmgmt command can be found at https://xilinx.github.io/XRT/2021.2/html/xbmgmt.html.

Accelerator cards are partitioned into a user function and a management function to provide 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 xbutil 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.

The xbmgmt command is used for card installation and administration, and requires sudo privileges when running it. The xbmgmt supported tasks include flashing the card firmware, and scanning the current device configuration.

You can use the help command to list the available xbmgmt commands and options, and access help for individual commands by using the following:
xbmgmt --help <command>
For detailed help of each sub-command, use the following:
xbmgmt help <subcommand>

Set up the xbmgmt 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
Tip: An earlier version of the xbmgmt command can be accessed using xbmgmt --legacy as described in xbmgmt Utility - Legacy.