save_bd_design_as - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Save a copy of the existing IP subsystem design to specified disk file with a different name. Generated output products will not be saved.


save_bd_design_as [‑dir <arg>] [‑ignore_comments] [‑freeze_boundary]
    [‑force] [‑quiet] [‑verbose] [<name>]


TCL_OK, TCL_ERROR if failed.


Name Description
[-dir] Directory path for remote BD to be created and managed. This is required if a name is not specified
[-ignore_comments] Do not save user comments
[-freeze_boundary] Freeze the boundary for the new design
[-force] Overwrite existing file if present
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<name>] Name of the design to create. This is required if a directory is not specified




Save a copy of an existing block design from the IP integrator to a new location, or with a different name. The generated output products of the block design will not be saved to the new block design.

Note: You cannot create a copy of a block design that has locked IP. The IP must be unlocked or the command will return an error.


save_bd_design_as  [-dir <arg>] [-ignore_comments] [-force] [-quiet] [-verbose]

-dir <arg> - (Optional) The directory into which the new block design files are saved. The block design will be saved to the specified location, in a folder with same name as the block design. If you specify just the -dir option, the block design will be copied to the new location with the current name.

Important: Although -dir is optional, either the -dir or a <name> must be specified.

-ignore_comments - (Optional) Do not copy any user-defined comment blocks in the current block design.

-force - (Optional) Overwrite an existing block design of the same name if one exists.

-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.

<name> - Specify the name of the block design to save. If <name> is not specified, the -dir option must be specified. If you specify <name> without -dir, the block design will be saved to its current location with the new name.


The following example saves the current block design to the specified directory, and renames it to the specified name:

save_bd_design_as -dir C:/Data new_Block