Documentation Language: Swift

Structure

SSHClientConfiguration

Connection settings used to create an SSHClient.

struct SSHClientConfiguration

Overview

SSHClientConfiguration groups the network endpoint, user name, optional password, and debug flag needed to establish an SSH client connection. The value is sendable so callers can prepare configuration on one concurrency domain and hand it to the client actor on another.

Topics

Initializers

?
init(host:port:username:password:debug:)

Create a complete set of SSH client connection settings.

Instance Properties

V
debug

Whether to emit debug logging during client setup and session handling.

V
host

Host name or address of the remote SSH server.

V
password

Password to use for password-based authentication, if enabled.

V
port

TCP port used for the remote SSH server.

V
username

User name to present during authentication.

Type Methods

?
parseDestination(_:defaultUsername:)

Parse a destination string in user@host[:port] form.

Relationships

Conforms To

See Also

Essentials

?
SSHClient

Actor that manages SSH connections, sessions, and local forwards.

S
CommandResult

Output captured from a completed remote command.

E
SSHClientError

Errors raised by the high-level SSH client API.