RunSshCommandOptions
Defined in: src/protocols/ssh/runSshCommand.ts:19
Options for runSshCommand.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
auth | SshCredential | Authentication credential. Use one of: - { type: "password", username, password } - { type: "publickey", username, algorithmName, publicKeyBlob, sign } (build one from a private-key file with buildPublickeyCredential) - { type: "keyboard-interactive", username, respond } | src/protocols/ssh/runSshCommand.ts:34 |
command | string | Command to execute on the remote shell. | src/protocols/ssh/runSshCommand.ts:25 |
connectTimeoutMs? | number | TCP connect timeout in milliseconds. Defaults to 10 000. | src/protocols/ssh/runSshCommand.ts:42 |
host | string | Hostname or IP of the SSH server. | src/protocols/ssh/runSshCommand.ts:21 |
maxOutputBytes? | number | Maximum total bytes captured from stdout. Defaults to 16 MiB. | src/protocols/ssh/runSshCommand.ts:44 |
port? | number | TCP port. Defaults to 22. | src/protocols/ssh/runSshCommand.ts:23 |
transport? | SshTransportConnectionOptions | Forwarded to SshTransportConnection; covers host-key pinning, algorithm overrides, and handshake timeout. The default handshakeTimeoutMs is 10 seconds. | src/protocols/ssh/runSshCommand.ts:40 |