Struct SshConfig 

pub struct SshConfig {
    pub credentials: SshCredentials,
    pub socket_addr: SocketAddr,
    pub connection_config: SshConnectionConfig,
}

SSH connection configuration for a specific remote instance.

Contains both the SSH credentials and the target host socket address, representing everything needed to establish an SSH connection.

Fields

credentials: SshCredentials

SSH authentication credentials.

socket_addr: SocketAddr

Socket address (IP address and port) of the target host for SSH connections.

This contains both the IP address and port number of the remote instance that the SSH client will connect to.

connection_config: SshConnectionConfig

SSH connection behavior configuration (timeouts, retries, logging).

Implementations

impl SshConfig

pub fn new(credentials: SshCredentials, ssh_socket_addr: SocketAddr) -> Self

Creates a new SSH connection configuration with default connection settings.

Uses SshConnectionConfig::default() for connection behavior parameters.

use torrust_tracker_deployer_lib::adapters::ssh::{SshCredentials, SshConfig};
let credentials = SshCredentials::new(
    PathBuf::from("/home/user/.ssh/deploy_key"),
    PathBuf::from("/home/user/.ssh/deploy_key.pub"),
    Username::new("ubuntu").unwrap(),
);
let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)), 22);
let config = SshConfig::new(
    credentials,
    socket_addr,
);

pub fn with_connection_config( credentials: SshCredentials, ssh_socket_addr: SocketAddr, connection_config: SshConnectionConfig, ) -> Self

Creates a new SSH connection configuration with custom connection settings.

Use this constructor when you need to customize connection behavior (timeouts, retries, logging) for specific scenarios.

use torrust_tracker_deployer_lib::adapters::ssh::{SshCredentials, SshConfig, SshConnectionConfig};
let credentials = SshCredentials::new(
    PathBuf::from("/home/user/.ssh/deploy_key"),
    PathBuf::from("/home/user/.ssh/deploy_key.pub"),
    Username::new("ubuntu").unwrap(),
);
let socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)), 22);

// Custom configuration for fast testing
let connection_config = SshConnectionConfig::new(1, 5, 1, 2);
let config = SshConfig::with_connection_config(
    credentials,
    socket_addr,
    connection_config,
);

pub fn with_default_port(credentials: SshCredentials, host_ip: IpAddr) -> Self

Creates a new SSH connection configuration with the default port (22).

This is a convenience method for when you want to use the standard SSH port.

use torrust_tracker_deployer_lib::adapters::ssh::{SshCredentials, SshConfig};
let credentials = SshCredentials::new(
    PathBuf::from("/home/user/.ssh/deploy_key"),
    PathBuf::from("/home/user/.ssh/deploy_key.pub"),
    Username::new("ubuntu").unwrap(),
);
let config = SshConfig::with_default_port(
    credentials,
    IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)),
);

pub fn ssh_priv_key_path(&self) -> &PathBuf

Access the SSH private key path.

pub fn ssh_pub_key_path(&self) -> &PathBuf

Access the SSH public key path.

pub fn ssh_username(&self) -> &str

Access the SSH username.

pub fn ssh_port(&self) -> u16

Access the SSH port.

pub fn host_ip(&self) -> IpAddr

Access the host IP address.

pub fn socket_addr(&self) -> SocketAddr

Access the socket address.

pub fn connection_timeout_secs(&self) -> u32

Access the connection timeout in seconds.

Trait Implementations

impl Clone for SshConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.