current_bd_instance - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Set or get current cell instance.


current_bd_instance [‑quiet] [‑verbose] [<instance>]


The current cell instance object, "" if failed.


Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<instance>] Name of current cell instance to be set




Set or get the current hierarchical cell instance in the current IP integrator subsystem design, as defined by current_bd_design. The current instance is referenced from the top-level of the subsystem design hierarchy, or "/".

This command returns the current IP integrator cell instance object, or returns nothing if the command failed.


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

<instance> - (Optional) The name of the IP integrator hierarchical cell to be set as the current instance of the subsystem design.

  • The <instance> is specified relative to the presently defined current instance, using the defined hierarchy separator.
  • Use '..' to move up one level of the hierarchy relative to the current instance.
  • If the <instance> argument is omitted, the current instance is reset to the top module in the subsystem design hierarchy.
  • If the <instance> is specified as '.' then the name of the current instance is returned, and the instance is not changed.


The following example sets the current instance in the subsystem design to the specified module:

current_bd_instance module2

The following example returns the current instance:

current_bd_instance .

This example resets the current instance of the subsystem design to the top level of the hierarchy:

current_instance /