Removes list of cluster configurations
Syntax
remove_cluster_configurations [‑quiet] [‑verbose] <cluster_configurations>
Usage
Name | Description |
---|---|
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
<cluster_configurations>
|
List of cluster configurations |
Categories
Description
Removes a list of cluster configurations. The list of cluster configurations to be removed is specified as input. This command can only remove user defined cluster configurations and cannot remove Vivado® default cluster configurations. To identify if a cluster configuration is default or user-defined, use the following snippet:
# if it returns 1 cluster configuration is Vivado default otherwise user defined.
get_property IS_DEFAULT [get_cluster_configurations <cluster configuration name>]
Currently, Vivado supports following clusters management tools:
-
Load Sharing Facility (LSF)
-
Sun Grid Engine (SGE)
-
Simple Linux Utility For Resource Management (SLURM)
Arguments
<cluster_configurations>
- (Required) List of cluster configurations object to be removed. You can get a list of existing cluster configurations with the get_cluster_configurations
command and provide it as input to the remove_cluster_configurations
command.
-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.Examples
The following example removes the cluster configuration with name lsf_medium.
remove_cluster_configurations [get_cluster_configurations lsf_medium]
The following example removes all the user defined cluster configurations.
remove_cluster_configurations [get_cluster_configurations -filter {IS_DEFAULT == 0}]