ReferenceSSH
CommandsSSH

ssh

Usage: polyaxon ssh [OPTIONS] COMMAND [ARGS]...

  SSH access for sandbox-enabled runs.

Options:
  --help  Show this message and exit.

Commands:
  config   Print an SSH config block for a sandbox run.
  connect  Connect to a sandbox run over SSH.
  setup    Prepare SSH access for a sandbox run.

ssh connect

Usage: polyaxon ssh connect [OPTIONS] [CONNECT_ARGS]...

  Connect to a sandbox run over SSH.

  Pass SSH options or a remote command after `--`. Use a second `--` to
  separate SSH options from the remote command.

Options:
  -p, --project TEXT             The project name, e.g. 'mnist' or
                                 'acme/mnist'.
  -uid, -id, --uid, --uuid TEXT  The run uuid.
  --identity-file FILE           SSH private key to use. Defaults to
                                 Polyaxon's managed sandbox key.
  --known-hosts-file FILE        Known hosts file to use. Defaults to
                                 Polyaxon's managed file.
  --help                         Show this message and exit.

ssh setup

Usage: polyaxon ssh setup [OPTIONS]

  Prepare SSH access for a sandbox run.

Options:
  -p, --project TEXT             The project name, e.g. 'mnist' or
                                 'acme/mnist'.
  -uid, -id, --uid, --uuid TEXT  The run uuid.
  --identity-file FILE           SSH private key to use. Defaults to
                                 Polyaxon's managed sandbox key.
  --known-hosts-file FILE        Known hosts file to use. Defaults to
                                 Polyaxon's managed file.
  --timeout-ms INTEGER RANGE     Remote SSH setup timeout in milliseconds.
                                 [default: 30000; x>=1]
  --help                         Show this message and exit.

ssh config

Usage: polyaxon ssh config [OPTIONS]

  Print an SSH config block for a sandbox run.

Options:
  -p, --project TEXT             The project name, e.g. 'mnist' or
                                 'acme/mnist'.
  -uid, -id, --uid, --uuid TEXT  The run uuid.
  --identity-file FILE           SSH private key to use. Defaults to
                                 Polyaxon's managed sandbox key.
  --known-hosts-file FILE        Known hosts file to use. Defaults to
                                 Polyaxon's managed file.
  --help                         Show this message and exit.

ssh tunnel

Usage: polyaxon ssh tunnel [OPTIONS]

  Open an SSH tunnel to a sandbox run.

Options:
  -p, --project TEXT             The project name, e.g. 'mnist' or
                                 'acme/mnist'.
  -uid, -id, --uid, --uuid TEXT  The run uuid.
  --identity-file FILE           SSH private key to use. Defaults to
                                 Polyaxon's managed sandbox key.
  --known-hosts-file FILE        Known hosts file to use. Defaults to
                                 Polyaxon's managed file.
  --help                         Show this message and exit.