Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/03/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.29.5. qed::configure_ssh_compute_spec (::quartus::qed)

The following table displays information for the qed::configure_ssh_compute_spec Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::configure_ssh_compute_spec [-h | -help] [-long_help] [-exe <quartus_sta|quartus_cdb|quartus_sh> ] [-exe_options <exe_options> ] [-lm_license_file <lm_license_file> ] [-quartus_rootdir <quartus_rootdir> ] [-additional_arguments <additional_arguments> ] -hostnames <hostnames> [-initial_working_directory <initial_working_directory> ] [-private_key <private_key> ] [-user <user> ] <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-exe <quartus_sta|quartus_cdb|quartus_sh> Executable to open the project with. Dictates the packages and commands that will be available to run.
-exe_options <exe_options> List of options to pass to executable.
-lm_license_file <lm_license_file> License file setting, LM_LICENSE_FILE
-quartus_rootdir <quartus_rootdir> Folder location where the Quartus Prime Pro software is installed and accessible on the remote machine.
-additional_arguments <additional_arguments> Additional arguments to pass to SSH client when connecting to remote host
-hostnames <hostnames> A list of hostname entries, where each entry is a hostname, a comma-separated list of hostnames, or a string in the form file:<path> which refers to a file containing list of non-file hostname entries.
-initial_working_directory <initial_working_directory> The initial working directory on the remote host.
-private_key <private_key> The private SSH key file that the user can use to connect the remote host.
-user <user> The user or login used to login to the remote host. Defaults to current user name
<object> Identifier associated with the object, must be unique
Description
Sets properties on the specified object to cause background Quartus
Prime Pro software instances to connect through the ssh protocol.

The "-hostnames" option specifies a list of hostnames that can be
connected to through the ssh protocol that will execute the background
Quartus Prime Pro software instances.

The "-exe" option specifies the Quartus Prime Pro executable to run.
The supported options are quartus_sta, quartus_cdb, and quartus_sh.

The "-exe_options" option specifies any options passed to the
executable that is specified with the "-exe" option.

The "-quartus_rootdir" option specifies the directory location of the
desired Quartus Prime Pro software installation. This is the root directory
of the software installation, not the bin directory.

The "-lm_license_file" option specifies the LM_LICENSE_FILE value
that will be passed to the Quartus Prime software executable. If you
don't know the value, look in the Tools > License Setup dialog in
the Quartus Prime Pro software GUI.

The "-user" option specifies the user or login name to use when logging in to remote host.
Use this option if the user name on remote host is different from the current user.

The "-private_key" option specifies the private SSH key file to authenticate
and log in to remote host. Use this option if the remote host prompts user for
password when connecting using the ssh client. The corresponding public
key should have been appended to the remote host's
 ~/.ssh/authorized_keys or ~/.ssh/authorized_keys2 files.

The "-farm_os" option specifies the operating system of the remote host.
Supported options are windows and linux.
The "-farm_os" option specifies the operating system of the remote host.
Supported options are windows and linux.

The "-additional_arguments" option specifies additional commandline arguments to pass to the SSH client.
Example Usage
    qed::configure_ssh_compute_spec -exe quartus_sta -hostnames hostname -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec -exe quartus_sta -hostnames file:/path/to/hostnames.txt -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec -exe quartus_sta -hostnames host1,host2 -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec -exe quartus_sta -hostnames hostname -quartus_rootdir /path/to/acds/quartus -user username -private_key ~/.ssh/id_rsa
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful