get_cluster_configurations - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Returns all cluster configuration objects


get_cluster_configurations [‑filter <arg>] [‑regexp] [‑nocase] [‑quiet]
    [‑verbose] [<patterns>]


Name Description
[-filter] Filter list with expression
[-regexp] Patterns are full regular expressions
[-nocase] Perform case-insensitive matching (valid only when -regexp specified)
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match cluster configuration against patterns Default: *


Gets a list of cluster configurations that includes AMD Vivado™ default cluster configurations and cluster configurations created using the create_cluster_configuration command.

Vivado supports the following cluster management tools.

  • Load Sharing Facility (LSF)
  • Sun Grid Engine (SGE)
  • Simple Linux Utility For Resource Management (SLURM)


-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_cluster_configurations based on property values on the cluster configurations. You can find the properties on an object with the report_property or list_property commands. Any property/value pair can be used as a filter. In the case of the cluster configurations object, "TYPE" and "IS_DEFAULT" are some of the properties that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".

For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||). The following gets a default cluster configurations with name lsf:

get_cluster_configurations * -filter {IS_DEFAULT == 1 && NAME =~ "lsf"} 

Boolean (bool) type properties can be directly evaluated in filter expressions as true or not true:

-filter {IS_DEFAULT} 
-regexp - (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.

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

<patterns> - (Optional) Match cluster configuration names against the specified patterns. The default pattern is the wildcard * which gets a list of all defined cluster configurations. More than one pattern can be specified to find multiple cluster configurations based on different search criteria.

Note: You must enclose multiple search patterns in braces, {}, or quotes, "", to present the list as a single element.


The following example gets the list of all cluster configurations.


The following example gets the cluster configuration with name 'lsf'.

get_cluster_configurations lsf

The following example gets the list of all default cluster configurations.

get_cluster_configurations -filter {IS_DEFAULT}