The SshClient type exposes the following members.

Constructors

  NameDescription
Public methodSshClient(ConnectionInfo)
Initializes a new instance of the SshClient class.
Public methodSshClient(String, String, array<PrivateKeyFile>[]()[][])
Initializes a new instance of the SshClient class.
Public methodSshClient(String, String, String)
Initializes a new instance of the SshClient class.
Public methodSshClient(String, Int32, String, array<PrivateKeyFile>[]()[][])
Initializes a new instance of the SshClient class.
Public methodSshClient(String, Int32, String, String)
Initializes a new instance of the SshClient class.

Methods

  NameDescription
Public methodAddForwardedPort
Adds the forwarded port.
Public methodConnect
Connects client to the server.
(Inherited from BaseClient.)
Public methodCreateCommand(String)
Creates the command to be executed.
Public methodCreateCommand(String, Encoding)
Creates the command to be executed with specified encoding.
Public methodCreateShell(Stream, Stream, Stream)
Creates the shell.
Public methodCreateShell(Encoding, String, Stream, Stream)
Creates the shell.
Public methodCreateShell(Stream, Stream, Stream, String, UInt32, UInt32, UInt32, UInt32, IDictionary<(Of <<'(TerminalModes, UInt32>)>>))
Creates the shell.
Public methodCreateShell(Encoding, String, Stream, Stream, String, UInt32, UInt32, UInt32, UInt32, IDictionary<(Of <<'(TerminalModes, UInt32>)>>))
Creates the shell.
Public methodCreateShell(Stream, Stream, Stream, String, UInt32, UInt32, UInt32, UInt32, IDictionary<(Of <<'(TerminalModes, UInt32>)>>), Int32)
Creates the shell.
Public methodCreateShell(Encoding, String, Stream, Stream, String, UInt32, UInt32, UInt32, UInt32, IDictionary<(Of <<'(TerminalModes, UInt32>)>>), Int32)
Creates the shell.
Public methodCreateShellStream(String, UInt32, UInt32, UInt32, UInt32, Int32)
Creates the shell stream.
Public methodCreateShellStream(String, UInt32, UInt32, UInt32, UInt32, Int32, IDictionary<(Of <<'(TerminalModes, UInt32>)>>))
Creates the shell stream.
Public methodDisconnect
Disconnects client from the server.
(Inherited from BaseClient.)
Public methodDispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages.
(Inherited from BaseClient.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources
(Overrides BaseClient..::..Dispose(Boolean).)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the BaseClient is reclaimed by garbage collection.
(Inherited from BaseClient.)
Protected methodOnConnected
Called when client is connected to the server.
(Inherited from BaseClient.)
Protected methodOnConnecting
Called when client is connecting to the server.
(Inherited from BaseClient.)
Protected methodOnDisconnected
Called when client is disconnected from the server.
(Overrides BaseClient..::..OnDisconnected()()()().)
Protected methodOnDisconnecting
Called when client is disconnecting from the server.
(Overrides BaseClient..::..OnDisconnecting()()()().)
Public methodRemoveForwardedPort
Stops and removes the forwarded port from the list.
Public methodRunCommand
Creates and executes the command.
Public methodSendKeepAlive
Sends keep-alive message to the server.
(Inherited from BaseClient.)

Properties

  NameDescription
Public propertyEthernetAdapter
Returns the Ethernet adapter on which the socket resides EthernetAdapterType.EthernetLANAdapter indicates that the socket is on the LAN Adapter EthernetAdapterType.EthernetCSAdapter indicates the Control Subnet side (for a system with a router) EthernetAdapterType.EthernetUnknownAdapter indicates that the socket is not initialized as yet EthernetAdapterType.EthernetLAN2Adapter indicates the second LAN Adapter
Public propertyForwardedPorts
Gets the list of forwarded ports.
Public propertyIsConnected
Gets a value indicating whether this client is connected to the server.
(Inherited from BaseClient.)
Public propertyKeepAliveInterval
Gets or sets the keep alive interval in seconds.
(Inherited from BaseClient.)

Events

  NameDescription
Public eventErrorOccurred
Occurs when an error occurred.
(Inherited from BaseClient.)
Public eventHostKeyReceived
Occurs when host key received.
(Inherited from BaseClient.)

See Also