qed::configure_ssh_compute_spec (::quartus::qed)

Belongs to ::quartus::qed 1.0

Sets properties on the specified object to cause background Quartus
Prime 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 software instances. Entries in the list must be
comma-separated and may be formatted as "file:<filename>", where each
file contains a list of newline separated hostnames to consider alongside
any other entries specified.

The "-jobs_per_host" option limits the number of jobs a given host
can be assigned.

The "-custom_ssh_port" option overries the port to use when making
the SSH connection. Only required if the remote host(s) uses a port
other than port 22 for SSH.

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 "-private_key" option specifies a private key that is associated
with the remote host. The corresponding pulib key should have been
appending to the remote host's ~/.ssh/authorized_keys or ~/.ssh/authorized_keys2
files.

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 "-ssh_client" option specifies the path to the SSH client to
use when launching the connection. On Linux, it defaults to 'ssh'.
On Windows, it defaults to Cygwin ssh. Windows also supports plink
from the PuTTY package.

The "-additional_arguments" option specifies additional commandline arguments to pass to the SSH client.

The "-local_remote_path_map" specifies the shared directory mapping
between local and remote host. Format is local_path;remote_path.
Windows to Linux Example:
    [drive:\windows path];[linux path]
    s:\designs\two_reg;/data/usr/designs/two_reg
Linux to Windows Example:
    /data/usr;s:\data\usr

The "-ssh_server" option specifies the server used by the remote host. Examples include openssh or cygwin.

The "-initial_work_dir" option specifies the directory that the
remote job should start in.

The "-reverse_tunnel_port" option Enables port forwarding and
specifies a port on the remote host to be forwarded to the local
host. Use this if there is a firewall that separates the local host
and the remote host. Remote host will connect to QED server using
localhost:<reverse_tunnel_port> over the secured ssh channel.
The port can be any ephemeral port that is not used by another
process. Set value to 'auto' to let QED to automatically find a free
network port on remote host. Omit this setting to disable port
forwarding.

The "-exe" option specifies the Quartus Prime 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 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 software GUI.

    qed::configure_ssh_compute_spec workspace_id -exe quartus_sta -hostnames hostname -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec workspace_id -exe quartus_sta -hostnames file:/path/to/hostnames.txt -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec workspace_id -exe quartus_sta -hostnames host1,host2 -quartus_rootdir /path/to/acds/quartus
    qed::configure_ssh_compute_spec workspace_id -exe quartus_sta -hostnames hostname -quartus_rootdir /path/to/acds/quartus -user username -private_key ~/.ssh/id_rsa