Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
CLICommands

orl vms ssh

Open an SSH session to a VM over the data plane, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.

orl vms ssh <vm-id> [ssh args...] [flags]

Resolves the VM's data-plane SSH endpoint and runs the system ssh. Authentication uses the key you registered with orl ssh-keys create; no key material passes through orl. Flags for orl (--print, --org, ...) go before the VM id, not after: orl refuses one of its own flags typed after the id instead of silently handing it to ssh. Everything after the id is passed straight to ssh: its options, then a command to run on the VM instead of a shell. A command that itself starts with a dash needs a literal "--" before it so ssh does not read it as one of its own options.

Flags

FlagTypeRequired
--printboolnoprint the ssh command instead of running it

This wraps the getVmDetail API operation.

On this page