create_cluster_configuration - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Creates a cluster configuration

Syntax

create_cluster_configuration ‑submit_cmd <arg> ‑kill_cmd <arg>
    [‑monitor_cmd <arg>] [‑job_id_proc <arg>] [‑job_id_tcl <arg>]
    ‑type <arg> [‑force] [‑quiet] [‑verbose] <name>

Usage

Name Description
-submit_cmd Submit command of cluster configuration
-kill_cmd Kill command of cluster configuration
[-monitor_cmd] Monitor command of cluster configuration
[-job_id_proc] Proc name to parse job Id
[-job_id_tcl] path to the tcl file contatining the proc
-type Type of cluster configuration
[-force] Force to overwrite a cluster configuration if it already exists.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<name> Name of cluster configuration

Description

Creates cluster configuration to be used for launching runs (synthesis and implementation). Cluster configuration is defined using name, submit command, kill command and type.

Cluster configuration allows user to create configurations for different clusters and are persisted in Vivado™ tool settings. So user has to create cluster configuration just once and use whenever required.

Currently, Vivado supports following clusters management tools.

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

Arguments

<name> - (Required) Name of the cluster configuration. Cluster configuration is identified using its name, hence name of the cluster configuration should be unique. You can get a list of existing cluster configurations with the get_cluster_configurations command.

<submit_cmd> - (Required) Submit command for this cluster configuration. This is the command that will be used to submit the job on the cluster.

<kill_cmd> - (Required) Kill command for this cluster configuration. This is the command that will be used to kill the job on the cluster. The kill command must take job-id as input to kill the job.

<type> - (Required) Type of cluster configuration. This is the type of cluster for the cluster configuration being created.

  • LSF - Cluster of type "Load Sharing Facility"
  • SGE - Cluster of type "Sun Grid Engine"
  • SLURM - Cluster of type "Simple Linux Utility For Resource Management"
  • CUSTOM - Lets you create a cluster configuration for a cluster type which is not supported by Vivado. This is an experimental feature and the cluster configuration of this type will not be validated thoroughly. It is provided to allow you to add cluster configuration for non-supported cluster types.
-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.

Examples

The following example creates a cluster configuration named lsf_cluster_1 of type LSF. The submit command is bsub and the kill command is bkill.

create_cluster_configuration lsf_cluster_1 bsub bkill LSF

The following example creates a cluster configuration named lsf_medium of type LSF. The submit command is bsub with resource requirement string which looks for 64bit linux os with either rhel or centos distro and version of the os is 7 and the jobs will be submitted to medium queue. The kill command is bkill.

create_cluster_configuration lsf_medium {bsub -R "select[os == lin && type == X86_64 && (osdistro == rhel || osdistro == centos) && (osver == ws7)]" -N -q medium} bkill LSF

The following example creates a cluster configuration named sge_conf of type SGE. The submit command is qsub and the kill command is qdel.

create_cluster_configuration sge_conf qsub qdel SGE

The following example creates a cluster configuration named slurm_conf of type SLURM. The submit command is sbatch and the kill command is scancel.

create_cluster_configuration slurm_conf sbatch scancel SLURM