The Ssh type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | Ssh |
Initializes a new instance of the Ssh class.
|
Methods
| Name | Description | |
|---|---|---|
| BeginConnect(String, AsyncCallback, Object) |
Begins asynchronous Connect operation.
Connects to the SSH server.
|
| BeginConnect(String, Int32, AsyncCallback, Object) |
Begins asynchronous Connect operation.
Connects to the SSH server.
|
| BeginConnect(String, Int32, SshParameters, AsyncCallback, Object) | Obsolete. |
| BeginDisconnect |
Begins asynchronous Disconnect operation.
Informs the server that the connection is about to close and
terminates the connection.
|
| BeginLogin(AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server interactively and initializes the SSH session.
Uses AuthenticationRequest event to request credentials.
|
| BeginLogin(String, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server interactively and initializes the SSH session.
Uses AuthenticationRequest event to request credentials.
|
| BeginLogin(SshGssApiCredentials, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates to the server using GSSAPI.
Kerberos is only supported on Mono.
NTLM is supported on Windows and partially on Mono.
|
| BeginLogin(String, SshPrivateKey, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server using his private key and initializes the SSH session.
|
| BeginLogin(String, String, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server and initializes the SSH session.
|
| BeginLogin(String, String, SshPrivateKey, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server using a combination of password and public key and initializes the SSH session.
|
| BeginRunCommand |
Begins asynchronous RunCommand operation.
Runs a remote command and returns its response.
|
| BeginStartCommand |
Begins asynchronous StartCommand operation.
Starts a remote command.
|
| BeginStartIncomingTunnel(IPEndPoint, IPEndPoint, AsyncCallback, Object) |
Begins asynchronous StartIncomingTunnel operation.
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| BeginStartIncomingTunnel(IPEndPoint, String, Int32, AsyncCallback, Object) |
Begins asynchronous StartIncomingTunnel operation.
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| BeginStartIncomingTunnel(String, Int32, IPEndPoint, AsyncCallback, Object) |
Begins asynchronous StartIncomingTunnel operation.
Starts a new incoming tunnel. Connections to remote address/port will be tunneled from the SSH server through the local machine to the specified target.
|
| BeginStartIncomingTunnel(String, Int32, String, Int32, AsyncCallback, Object) |
Begins asynchronous StartIncomingTunnel operation.
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| BeginStartOutgoingTunnel(IPEndPoint, IPEndPoint, AsyncCallback, Object) |
Begins asynchronous StartOutgoingTunnel operation.
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote endpoint.
|
| BeginStartOutgoingTunnel(IPEndPoint, String, Int32, AsyncCallback, Object) |
Begins asynchronous StartOutgoingTunnel operation.
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote host/port.
|
| BeginStartOutgoingTunnel(String, Int32, String, Int32, AsyncCallback, Object) |
Begins asynchronous StartOutgoingTunnel operation.
Starts a new outgoing tunnel. Connections to local host/port will be tunneled through the SSH server to the specified remote host/port.
|
| BeginStartScripting(AsyncCallback, Object) |
Begins asynchronous StartScripting operation.
Starts a scripting session with a virtual terminal.
|
| BeginStartScripting(String, AsyncCallback, Object) |
Begins asynchronous StartScripting operation.
Starts a scripting session with a virtual terminal.
|
| BeginStartScripting(TerminalOptions, AsyncCallback, Object) |
Begins asynchronous StartScripting operation.
Starts a scripting session with a virtual terminal.
|
| BeginStartScripting(String, TerminalOptions, AsyncCallback, Object) |
Begins asynchronous StartScripting operation.
Starts a scripting session with a virtual terminal.
|
| BeginStartScripting(String, TerminalOptions, Int32, Int32, AsyncCallback, Object) |
Begins asynchronous StartScripting operation.
Starts a scripting session with a virtual terminal.
|
| BeginStartShell |
Begins asynchronous StartShell operation.
Starts a remote shell.
|
| BeginStartSocksServer(IPEndPoint, AsyncCallback, Object) |
Begins asynchronous StartSocksServer operation.
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote host/port.
|
| BeginStartSocksServer(String, Int32, AsyncCallback, Object) |
Begins asynchronous StartSocksServer operation.
Starts a new outgoing tunnel. Connections to local host/port will be tunneled through the SSH server to the specified remote host/port.
|
| BeginStartVirtualTerminal(AsyncCallback, Object) |
Begins asynchronous StartVirtualTerminal operation.
Starts a virtual terminal session.
|
| BeginStartVirtualTerminal(TerminalOptions, AsyncCallback, Object) |
Begins asynchronous StartVirtualTerminal operation.
Starts a virtual terminal session.
|
| BeginStartVirtualTerminal(TerminalOptions, Int32, Int32, AsyncCallback, Object) |
Begins asynchronous StartVirtualTerminal operation.
Starts a virtual terminal session.
|
| Bind |
Binds the Ssh object to an underlying SSH session. This can be used instead of Connect(String)/Login(String, String) methods.
|
| Connect(String) |
Connects to the SSH server.
|
| Connect(String, Int32) |
Connects to the SSH server.
|
| Connect(String, Int32, SshParameters) | Obsolete. |
| Disconnect |
Informs the server that the connection is about to close and
terminates the connection.
|
| Dispose()()()() |
Disposes the Ssh object and all the socket objects.
|
 | Dispose(Boolean) |
Releases the unmanaged resources used by the Ssh object
and optionally releases the managed resources.
|
| EndConnect |
Ends an asynchronous BeginConnect operation.
|
| EndDisconnect |
Ends an asynchronous BeginDisconnect operation.
|
| EndLogin |
Ends an asynchronous BeginLogin operation.
|
| EndRunCommand |
Ends an asynchronous BeginRunCommand operation.
|
| EndStartCommand |
Ends an asynchronous BeginStartCommand operation.
|
| EndStartIncomingTunnel |
Ends an asynchronous BeginStartIncomingTunnel operation.
|
| EndStartOutgoingTunnel |
Ends an asynchronous BeginStartOutgoingTunnel operation.
|
| EndStartScripting |
Ends an asynchronous BeginStartScripting operation.
|
| EndStartShell |
Ends an asynchronous BeginStartShell operation.
|
| EndStartSocksServer |
Ends an asynchronous BeginStartSocksServer operation.
|
| EndStartVirtualTerminal |
Ends an asynchronous BeginStartVirtualTerminal operation.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize |
Finalizer. Called by garbage collector during object destruction.
(Overrides Object..::..Finalize()()()().) |
| GetConnectionState |
Checks whether the SSH session is still connected and returns its state.
|
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| CheckConnectionState |
Checks whether the SSH session is still connected. Throws an exception on error.
|
| Login()()()() |
Authenticates the user to the server interactively and initializes the SSH session.
Uses AuthenticationRequest event to request credentials.
|
| Login(String) |
Authenticates the user to the server interactively and initializes the SSH session.
Uses AuthenticationRequest event to request credentials.
|
| Login(SshGssApiCredentials) |
Authenticates to the server using GSSAPI.
Kerberos is only supported on Mono.
NTLM is supported on Windows and partially on Mono.
|
| Login(String, SshPrivateKey) |
Authenticates the user to the server using his private key and initializes the SSH session.
|
| Login(String, String) |
Authenticates the user to the server and initializes the SSH session.
|
| Login(String, String, SshPrivateKey) |
Authenticates the user to the server using a combination of password and public key and initializes the SSH session.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RunCommand |
Runs a remote command and returns its response.
|
| SetSocketFactory |
Sets the socket factory to be used to create communication sockets.
|
| StartCommand |
Starts a remote command.
|
| StartIncomingTunnel(IPEndPoint, IPEndPoint) |
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| StartIncomingTunnel(IPEndPoint, String, Int32) |
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| StartIncomingTunnel(String, Int32, IPEndPoint) |
Starts a new incoming tunnel. Connections to remote address/port will be tunneled from the SSH server through the local machine to the specified target.
|
| StartIncomingTunnel(String, Int32, String, Int32) |
Starts a new incoming tunnel. Connections to remote endpoint will be tunneled from the SSH server through the local machine to the specified target.
|
| StartOutgoingTunnel(IPEndPoint, IPEndPoint) |
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote endpoint.
|
| StartOutgoingTunnel(IPEndPoint, String, Int32) |
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote host/port.
|
| StartOutgoingTunnel(String, Int32, String, Int32) |
Starts a new outgoing tunnel. Connections to local host/port will be tunneled through the SSH server to the specified remote host/port.
|
| StartScripting()()()() |
Starts a scripting session with a virtual terminal.
|
| StartScripting(String) |
Starts a scripting session with a virtual terminal.
|
| StartScripting(TerminalOptions) |
Starts a scripting session with a virtual terminal.
|
| StartScripting(String, TerminalOptions) |
Starts a scripting session with a virtual terminal.
|
| StartScripting(String, TerminalOptions, Int32, Int32) |
Starts a scripting session with a virtual terminal.
|
| StartShell |
Starts a remote shell.
|
| StartSocksServer(IPEndPoint) |
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote host/port.
|
| StartSocksServer(String, Int32) |
Starts a new outgoing tunnel. Connections to local host/port will be tunneled through the SSH server to the specified remote host/port.
|
| StartVirtualTerminal()()()() |
Starts a virtual terminal session.
|
| StartVirtualTerminal(TerminalOptions) |
Starts a virtual terminal session.
|
| StartVirtualTerminal(TerminalOptions, Int32, Int32) |
Starts a virtual terminal session.
|
| ToString |
Returns a string representation of this object.
(Overrides Object..::..ToString()()()().) |
Fields
| Name | Description | |
|---|---|---|
  | DefaultPort |
Default SSH port (22).
|
Properties
| Name | Description | |
|---|---|---|
 | Encoding |
Gets or sets the Encoding to use to encode and decode command parameters and server responses.
|
| Fingerprint |
Gets the server public key fingerprint (a SHA-256 hash of the server public key).
|
 | InstanceId |
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.) |
| IsAuthenticated |
Gets a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.) |
| IsConnected |
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.) |
| IsDisposed |
Gets a value indicating whether the object is disposed.
|
| LocalEndPoint |
Gets the local client EndPoint.
|
| LogWriter |
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.) |
| Proxy |
Gets or sets the network proxy to use to access a remote server.
|
| RemoteEndPoint |
Gets the remote server EndPoint.
|
| ServerKey |
Gets the server public key.
|
| ServerName |
Gets the server name, if available.
(Inherited from NetworkSession.) |
| ServerPort |
Gets the server port, if available.
(Inherited from NetworkSession.) |
| Session |
Gets the SSH session used by this SSH session.
|
| Settings |
Gets or sets SSH object settings.
|
| Timeout |
Gets or sets the length of time in milliseconds before the operation times out (specify -1 or 0 to indicate that the request does not time out).
|
| UserName |
Gets the authenticated user name, if available.
(Inherited from NetworkSession.) |
| Version |
Gets the version of the SSH component.
|
Events
| Name | Description | |
|---|---|---|
 | AuthenticationRequest |
Occurs when an authentication request is received from the server that cannot be answered programmatically.
|
| BannerReceived |
Occurs when a banner message is received from the server.
|
| FingerprintCheck |
Occurs when a fingerprint is received from the server and needs to be validated.
|
| TunnelError |
Occurs when a tunnel fails with an error.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IShellChannelFactory..::..CreateShellChannel |
See Also
