open_hw_platform - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Open the Xilinx Shell Archive


open_hw_platform [‑no_auto_upgrade] [‑quiet] [‑verbose] [<file>]


The name of the shell file.


Name Description
[-no_auto_upgrade] Disable BD auto upgrade
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<file>] Xilinx Shell Archive file Values: A filename with alphanumeric characters and .dsa/.xsa extension.


Vitis, Platform, FileIO


Open a Xilinx support archive (XSA) file and extract the AMD Vivado™ project, block design, and IP from the archive. This will create a project directory and project file (.xpr) from the XSA.

Note: The project will be created in the current working directory, or the directory from which the Vivado tool was launched.

This command returns a transcript of its actions, or returns an error if it fails.


-no_auto_upgrade - (Optional) Do not upgrade the IP used in the Block Design to the latest version. By default, the original IP from the XSA will be auto-upgraded if possible. Use the report_ip_status command to identify out-of-date IP.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<file> - (Required) Specify the path and file name of the XSA file.

Note: If the path is not specified as part of the file name, the tool will search for the specified file in the current working directory and then in the directory from which the tool was launched.


The following example opens the specified XSA, automatically upgrading the IP as needed:

open_hw_platform C:/Data/zc706.xsa