Struct SshConfig 

pub struct SshConfig {

    pub host: String,
    pub port: u16,
    pub username: String,
    pub password: Option<String>,
    pub private_key: Option<String>,
    pub su_password: Option<String>,
    pub sudo_password: Option<String>,
    pub keepalive_interval: u64,
    pub keepalive_max: u64,
    pub max_output_tokens: Option<usize>,
    pub reconnect_retries: u64,
    pub reconnect_backoff_ms: u64,
    pub health_probe_timeout_ms: u64,
    pub host_key_checking: HostKeyCheckMode,
    pub known_hosts: Option<PathBuf>,
}

SSH connection configuration

Fields

host: String

Remote hostname or IP address

port: u16

SSH port (default: 22)

username: String

Username for authentication

password: Option<String>

Password for password authentication

private_key: Option<String>

Private key content (not path!) for key authentication

su_password: Option<String>

Password for su elevation to root

sudo_password: Option<String>

Password for sudo commands (if different from su_password)

keepalive_interval: u64

Keepalive interval in seconds (default: 30s) Sends keepalive packets to maintain connection like a human user

keepalive_max: u64

Maximum keepalive failures before disconnecting (default: 3) How many keepalive packets can be missed before connection drops

max_output_tokens: Option<usize>

Maximum output tokens for command execution (default: 16_000) Prevents OOM and context overflow for large outputs

reconnect_retries: u64

Number of reconnect retries after the initial attempt (default: 3)

reconnect_backoff_ms: u64

Base reconnect backoff in milliseconds (default: 250)

health_probe_timeout_ms: u64

Health probe timeout in milliseconds for active session checks (default: 1500)

host_key_checking: HostKeyCheckMode

SSH host key verification policy.

known_hosts: Option<PathBuf>

Optional known_hosts file path.

Implementations

impl SshConfig

pub fn new(host: impl Into<String>, username: impl Into<String>) -> Self

Create a new SSH configuration with minimal required fields

pub fn with_port(self, port: u16) -> Self

Set the SSH port

pub fn with_password(self, password: impl Into<String>) -> Self

Set password authentication

pub fn with_private_key(self, key: impl Into<String>) -> Self

Set private key authentication (key content, not path)

pub fn with_su_password(self, password: impl Into<String>) -> Self

Set su password for privilege elevation

pub fn with_sudo_password(self, password: impl Into<String>) -> Self

Set sudo password for sudo commands

pub fn with_keepalive_interval(self, secs: u64) -> Self

Set keepalive interval in seconds (default: 30s) Lower values = more frequent keepalives (detect dead connections faster) Higher values = less network overhead (more like idle human session)

pub fn with_keepalive_max(self, max: u64) -> Self

Set maximum keepalive failures before disconnecting (default: 3) Total idle timeout = keepalive_interval * keepalive_max Example: 30s * 3 = 90s of inactivity before disconnect

pub fn with_max_output_tokens(self, tokens: Option<usize>) -> Self

Set maximum output tokens for command execution (default: 16_000) Set to None for unlimited output (not recommended for large outputs)

pub fn with_reconnect_retries(self, retries: u64) -> Self

Set reconnect retries after the initial attempt (default: 3)

pub fn with_reconnect_backoff_ms(self, backoff_ms: u64) -> Self

Set base reconnect backoff in milliseconds (default: 250)

pub fn with_health_probe_timeout_ms(self, timeout_ms: u64) -> Self

Set health probe timeout in milliseconds (default: 1500)

pub fn with_host_key_checking(self, mode: HostKeyCheckMode) -> Self

Set SSH host key verification policy.

pub fn with_known_hosts(self, known_hosts: Option<PathBuf>) -> Self

Set a custom known_hosts file path.

Trait Implementations

impl Clone for SshConfig

fn clone(&self) -> SshConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SshConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.