RemoteHost

import Formic

🐜 Swift library to support IT Automation tasks. 🐜 🐜

protocol Copyable

A type whose values can be implicitly or explicitly copied.

protocol CustomDebugStringConvertible

A type with a customized textual representation suitable for debugging purposes.

protocol CustomStringConvertible

A type with a customized textual representation.

protocol Decodable

A type that can decode itself from an external representation.

protocol Encodable

A type that can encode itself to an external representation.

protocol Equatable

A type that can be compared for value equality.

protocol Escapable

protocol ExpressibleByArgument

A type that can be expressed as a command-line argument.

protocol Hashable : Equatable

A type that can be hashed into a Hasher to produce an integer hash value.

protocol Sendable

init(_ networkAddress: NetworkAddress, sshPort: Int = 22, sshUser: String? = nil, sshIdentityFile: String? = nil, strictHostKeyChecking: Bool = false) throws

Creates a new host using the NetworkAddress you provide.

init?(_ name: String, sshPort: Int = 22, sshUser: String? = nil, sshIdentityFile: String? = nil, strictHostKeyChecking: Bool = false) throws

Creates a new host without attempting DNS resolution.

init?(argument: String)

Creates a new host from a string.

init(from decoder: any Decoder) throws

static func resolve(_ name: String, sshPort: Int = 22, sshUser: String? = nil, sshIdentityFile: String? = nil, strictHostKeyChecking: Bool = false) async throws -> RemoteHost

Creates a new host using DNS name resolution.

var debugDescription: String { get }

The debug description of the host.

var description: String { get }

The description of the host.

let networkAddress: NetworkAddress

The network address.

let sshAccessCredentials: SSHAccessCredentials

The credentials to use for SSH access.

let sshPort: Int

The port to use for SSH access.

let strictHostKeyChecking: Bool

A Boolean value that indicates whether to enable strict host checking during SSH connections.

struct IPv4Address

An IPv4 address.

struct NetworkAddress

A network address, either an IP address or a DNS name.

struct SSHAccessCredentials

SSH Credentials for accessing a remote host.

static var allValueStrings: [String] { get }

static var defaultCompletionKind: CompletionKind { get }

var defaultValueDescription: String { get }

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.