get_qor_checks - get_qor_checks - 2026.1 English

get_qor_checks - get_qor_checks - 2026.1 English - UG835

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document_ID

UG835

Release_Date

2026-06-23

Version

2026.1 English

Get a list of available QoR checks.

Syntax

get_qor_checks [‑type <arg>] [‑family <arg>] [‑filter <arg>]
    [‑of_objects <args>] [‑quiet] [‑verbose]

Returns

List of available qor checks.

Usage

Name	Description
`[-type]`	Report available QoR checks of given type ('suggestion' or 'assessment' Default: suggestion
`[-family]`	Reports available QoR checks for given family
`[-filter]`	Filter list with given expression
`[-of_objects]`	List of QoR checks for given Ruledecks
`[-quiet]`	Ignore command errors
`[-verbose]`	Suspend message limits during command execution

Description

Get all available QoR suggestion objects. This command returns a list of all available QoR suggestion objects.

Arguments

-filter <arg> -(Optional) Filter the returned available suggestion objects with the specified expression. The -filter argument filters the list of objects returned by the command based on property values on the objects. You can find the properties on an object with the report_property or list_property commands. In the case of the available_suggestion object, CATEGORY, AUTO and INCR_FRIENDLY are a few of properties you might use to filter the list of available suggestions.

-family <arg> - (Optional) Filter the returned available suggestion objects with the specified family name. Some valid device family names are zynquplus, kintexu, and versalpremium.

<IDs> - (Optional) Specify a list of QoR check IDs to select the specified objects.

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

-type - (Optional) Specifies the type of checks to delete. Valid values are either "suggestion" or "assessment." The default value is "suggestion".

Note: You can assign the same name to both assessment and suggestion rule decks. To retrieve any assessment type ruledecks, use the -type assessment switch.

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

Examples

The following example return an individual suggestion when you supply the full ID:

get_qor_checks -type suggestion RQS_CLOCK-5_1

The following example provides available suggestion objects based on the device family (UltraScale, UltraScale+, or Versal adaptive SoC):

get_qor_checks -family Versal

The following example filter suggestion objects within a given category. The available categories include: Timing, Congestion, Utilization, XDC and Clocking. For example, the following returns suggestions related to the Timing category:

get_qor_checks -filter {CATEGORY==Timing}