Returns all cluster configuration objects
Syntax
get_cluster_configurations [‑filter <arg>] [‑regexp] [‑nocase] [‑quiet]
[‑verbose] [<patterns>]
Usage
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: * |
Categories
Description
Gets a list of cluster configurations that includes 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)
Arguments
-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.
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 http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
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.
Examples
The following example gets the list of all cluster configurations.
get_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}