Documentation
¶
Index ¶
- Constants
- type ArkSSHConnection
- func (c *ArkSSHConnection) Connect(connectionDetails *connectionsmodels.ArkConnectionDetails) error
- func (c *ArkSSHConnection) Disconnect() error
- func (c *ArkSSHConnection) IsConnected() bool
- func (c *ArkSSHConnection) IsSuspended() bool
- func (c *ArkSSHConnection) RestoreConnection() error
- func (c *ArkSSHConnection) RunCommand(command *connectionsmodels.ArkConnectionCommand) (*connectionsmodels.ArkConnectionResult, error)
- func (c *ArkSSHConnection) SuspendConnection() error
Constants ¶
View Source
const (
// SSHPort is the default port for SSH connections.
SSHPort = 22
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArkSSHConnection ¶
type ArkSSHConnection struct {
connections.ArkConnection
// contains filtered or unexported fields
}
ArkSSHConnection is a struct that implements the ArkConnection interface for SSH connections.
func NewArkSSHConnection ¶
func NewArkSSHConnection() *ArkSSHConnection
NewArkSSHConnection creates a new instance of ArkSSHConnection.
func (*ArkSSHConnection) Connect ¶
func (c *ArkSSHConnection) Connect(connectionDetails *connectionsmodels.ArkConnectionDetails) error
Connect establishes an SSH connection using the provided connection details.
func (*ArkSSHConnection) Disconnect ¶
func (c *ArkSSHConnection) Disconnect() error
Disconnect closes the SSH connection.
func (*ArkSSHConnection) IsConnected ¶
func (c *ArkSSHConnection) IsConnected() bool
IsConnected checks if the SSH connection is established.
func (*ArkSSHConnection) IsSuspended ¶
func (c *ArkSSHConnection) IsSuspended() bool
IsSuspended checks if the SSH connection is suspended.
func (*ArkSSHConnection) RestoreConnection ¶
func (c *ArkSSHConnection) RestoreConnection() error
RestoreConnection restores the SSH connection.
func (*ArkSSHConnection) RunCommand ¶
func (c *ArkSSHConnection) RunCommand(command *connectionsmodels.ArkConnectionCommand) (*connectionsmodels.ArkConnectionResult, error)
RunCommand executes a command on the connected system.
func (*ArkSSHConnection) SuspendConnection ¶
func (c *ArkSSHConnection) SuspendConnection() error
SuspendConnection suspends the SSH connection.
Click to show internal directories.
Click to hide internal directories.