OS Manuals

/usr/bin/dask-ssh

A multi-tenant server for securely deploying and managing Dask clusters.

From dask-gateway 2026.3.0-r7 (os), captured 2026-11-05 by running dask-ssh --help (exit 0). permalink

Also provided by 5 other package versions
Usage: dask-ssh [OPTIONS] [HOSTNAMES]...

  Launch a Dask cluster over SSH. A 'dask scheduler' process will run on the
  first host specified in [HOSTNAMES] or in the hostfile, unless --scheduler
  is specified explicitly. One or more 'dask worker' processes will be run on
  each host. Use the flag --nworkers to adjust how many dask worker process
  are run on each host and the flag --nthreads to adjust how many CPUs are
  used by each dask worker process.

Options:
  --scheduler TEXT           Specify scheduler node.  Defaults to first
                             address.
  --scheduler-port INTEGER   Specify scheduler port number.  [default: 8786]
  --nthreads INTEGER         Number of threads per worker process. Defaults to
                             number of cores divided by the number of
                             processes per host.
  --nworkers INTEGER         Number of worker processes per host.  [default:
                             1]
  --hostfile PATH            Textfile with hostnames/IP addresses
  --ssh-username TEXT        Username to use when establishing SSH
                             connections.
  --ssh-port INTEGER         Port to use for SSH connections.  [default: 22]
  --ssh-private-key TEXT     Private key file to use for SSH connections.
  --nohost                   Do not pass the hostname to the worker.
  --log-directory PATH       Directory to use on all cluster nodes for the
                             output of dask scheduler and dask worker
                             commands.
  --local-directory PATH     Directory to use on all cluster nodes to place
                             workers files.
  --remote-python TEXT       Path to Python on remote nodes.
  --memory-limit TEXT        Bytes of memory that the worker can use. This can
                             be an integer (bytes), float (fraction of total
                             system memory), string (like 5GB or 5000M),
                             'auto', or zero for no memory management
                             [default: auto]
  --worker-port INTEGER      Serving computation port, defaults to random
  --nanny-port INTEGER       Serving nanny port, defaults to random
  --remote-dask-worker TEXT  Worker to run.  [default:
                             distributed.cli.dask_worker]
  --version                  Show the version and exit.
  --help                     Show this message and exit.
Options (18)
OptionDescriptionSource
--scheduler TEXTSpecify scheduler node.help
--scheduler-port INTEGERSpecify scheduler port number.help
--nthreads INTEGERNumber of threads per worker process.help
--nworkers INTEGERNumber of worker processes per host.help
--hostfile PATHTextfile with hostnames/IP addresseshelp
--ssh-username TEXTUsername to use when establishing SSH connections.help
--ssh-port INTEGERPort to use for SSH connections.help
--ssh-private-key TEXTPrivate key file to use for SSH connections.help
--nohostDo not pass the hostname to the worker.help
--log-directory PATHDirectory to use on all cluster nodes for the output of dask scheduler and dask worker commands.help
--local-directory PATHDirectory to use on all cluster nodes to place workers files.help
--remote-python TEXTPath to Python on remote nodes.help
--memory-limit TEXTBytes of memory that the worker can use.help
--worker-port INTEGERServing computation port, defaults to randomhelp
--nanny-port INTEGERServing nanny port, defaults to randomhelp
--remote-dask-worker TEXTWorker to run.help
--versionShow the version and exit.help
--helpShow this message and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.