The Ssh type exposes the following members.

Constructors

  NameDescription
Public methodSupported by the .NET Compact FrameworkSsh
Initializes a new instance of the Ssh class.

Methods

  NameDescription
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, AsyncCallback, Object)
Begins asynchronous Connect operation. Connects to the SSH server.
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, Int32, AsyncCallback, Object)
Begins asynchronous Connect operation. Connects to the SSH server.
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, Int32, SshParameters, AsyncCallback, Object) Obsolete.
Public methodSupported by the .NET Compact FrameworkBeginDisconnect
Begins asynchronous Disconnect operation. Informs the server that the connection is about to close and terminates the connection.
Public methodSupported by the .NET Compact FrameworkBeginLogin(AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server interactively and initializes the SSH session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkBeginLogin(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.
Public methodSupported by the .NET Compact FrameworkBeginLogin(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.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, SshPrivateKey, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server using his private key and initializes the SSH session.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, String, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server and initializes the SSH session.
Public methodSupported by the .NET Compact FrameworkBeginLogin(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.
Public methodSupported by the .NET Compact FrameworkBeginRunCommand
Begins asynchronous RunCommand operation. Runs a remote command and returns its response.
Public methodSupported by the .NET Compact FrameworkBeginStartCommand
Begins asynchronous StartCommand operation. Starts a remote command.
Public methodSupported by the .NET Compact FrameworkBeginStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartOutgoingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartOutgoingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartOutgoingTunnel(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.
Public methodSupported by the .NET Compact FrameworkBeginStartScripting(AsyncCallback, Object)
Begins asynchronous StartScripting operation. Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkBeginStartScripting(String, AsyncCallback, Object)
Begins asynchronous StartScripting operation. Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkBeginStartScripting(TerminalOptions, AsyncCallback, Object)
Begins asynchronous StartScripting operation. Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkBeginStartScripting(String, TerminalOptions, AsyncCallback, Object)
Begins asynchronous StartScripting operation. Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkBeginStartScripting(String, TerminalOptions, Int32, Int32, AsyncCallback, Object)
Begins asynchronous StartScripting operation. Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkBeginStartShell
Begins asynchronous StartShell operation. Starts a remote shell.
Public methodSupported by the .NET Compact FrameworkBeginStartSocksServer(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.
Public methodSupported by the .NET Compact FrameworkBeginStartSocksServer(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.
Public methodSupported by the .NET Compact FrameworkBeginStartVirtualTerminal(AsyncCallback, Object)
Begins asynchronous StartVirtualTerminal operation. Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkBeginStartVirtualTerminal(TerminalOptions, AsyncCallback, Object)
Begins asynchronous StartVirtualTerminal operation. Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkBeginStartVirtualTerminal(TerminalOptions, Int32, Int32, AsyncCallback, Object)
Begins asynchronous StartVirtualTerminal operation. Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkBind
Binds the Ssh object to an underlying SSH session. This can be used instead of Connect(String)/Login(String, String) methods.
Public methodSupported by the .NET Compact FrameworkConnect(String)
Connects to the SSH server.
Public methodSupported by the .NET Compact FrameworkConnect(String, Int32)
Connects to the SSH server.
Public methodSupported by the .NET Compact FrameworkConnect(String, Int32, SshParameters) Obsolete.
Public methodSupported by the .NET Compact FrameworkDisconnect
Informs the server that the connection is about to close and terminates the connection.
Public methodSupported by the .NET Compact FrameworkDispose()()()()
Disposes the Ssh object and all the socket objects.
Protected methodSupported by the .NET Compact FrameworkDispose(Boolean)
Releases the unmanaged resources used by the Ssh object and optionally releases the managed resources.
Public methodSupported by the .NET Compact FrameworkEndConnect
Ends an asynchronous BeginConnect operation.
Public methodSupported by the .NET Compact FrameworkEndDisconnect
Ends an asynchronous BeginDisconnect operation.
Public methodSupported by the .NET Compact FrameworkEndLogin
Ends an asynchronous BeginLogin operation.
Public methodSupported by the .NET Compact FrameworkEndRunCommand
Ends an asynchronous BeginRunCommand operation.
Public methodSupported by the .NET Compact FrameworkEndStartCommand
Ends an asynchronous BeginStartCommand operation.
Public methodSupported by the .NET Compact FrameworkEndStartIncomingTunnel
Ends an asynchronous BeginStartIncomingTunnel operation.
Public methodSupported by the .NET Compact FrameworkEndStartOutgoingTunnel
Ends an asynchronous BeginStartOutgoingTunnel operation.
Public methodSupported by the .NET Compact FrameworkEndStartScripting
Ends an asynchronous BeginStartScripting operation.
Public methodSupported by the .NET Compact FrameworkEndStartShell
Ends an asynchronous BeginStartShell operation.
Public methodSupported by the .NET Compact FrameworkEndStartSocksServer
Ends an asynchronous BeginStartSocksServer operation.
Public methodSupported by the .NET Compact FrameworkEndStartVirtualTerminal
Ends an asynchronous BeginStartVirtualTerminal operation.
Public methodSupported by the .NET Compact FrameworkEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodSupported by the .NET Compact FrameworkFinalize
Finalizer. Called by garbage collector during object destruction.
(Overrides Object..::..Finalize()()()().)
Public methodSupported by the .NET Compact FrameworkGetConnectionState
Checks whether the SSH session is still connected and returns its state.
Public methodSupported by the .NET Compact FrameworkGetHashCode
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.)
Public methodSupported by the .NET Compact FrameworkGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSupported by the .NET Compact FrameworkCheckConnectionState
Checks whether the SSH session is still connected. Throws an exception on error.
Public methodSupported by the .NET Compact FrameworkLogin()()()()
Authenticates the user to the server interactively and initializes the SSH session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkLogin(String)
Authenticates the user to the server interactively and initializes the SSH session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkLogin(SshGssApiCredentials)
Authenticates to the server using GSSAPI. Kerberos is only supported on Mono. NTLM is supported on Windows and partially on Mono.
Public methodSupported by the .NET Compact FrameworkLogin(String, SshPrivateKey)
Authenticates the user to the server using his private key and initializes the SSH session.
Public methodSupported by the .NET Compact FrameworkLogin(String, String)
Authenticates the user to the server and initializes the SSH session.
Public methodSupported by the .NET Compact FrameworkLogin(String, String, SshPrivateKey)
Authenticates the user to the server using a combination of password and public key and initializes the SSH session.
Protected methodSupported by the .NET Compact FrameworkMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSupported by the .NET Compact FrameworkRunCommand
Runs a remote command and returns its response.
Public methodSupported by the .NET Compact FrameworkSetSocketFactory
Sets the socket factory to be used to create communication sockets.
Public methodSupported by the .NET Compact FrameworkStartCommand
Starts a remote command.
Public methodSupported by the .NET Compact FrameworkStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartIncomingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartOutgoingTunnel(IPEndPoint, IPEndPoint)
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote endpoint.
Public methodSupported by the .NET Compact FrameworkStartOutgoingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartOutgoingTunnel(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.
Public methodSupported by the .NET Compact FrameworkStartScripting()()()()
Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkStartScripting(String)
Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkStartScripting(TerminalOptions)
Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkStartScripting(String, TerminalOptions)
Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkStartScripting(String, TerminalOptions, Int32, Int32)
Starts a scripting session with a virtual terminal.
Public methodSupported by the .NET Compact FrameworkStartShell
Starts a remote shell.
Public methodSupported by the .NET Compact FrameworkStartSocksServer(IPEndPoint)
Starts a new outgoing tunnel. Connections to local endpoint will be tunneled through the SSH server to the specified remote host/port.
Public methodSupported by the .NET Compact FrameworkStartSocksServer(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.
Public methodSupported by the .NET Compact FrameworkStartVirtualTerminal()()()()
Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkStartVirtualTerminal(TerminalOptions)
Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkStartVirtualTerminal(TerminalOptions, Int32, Int32)
Starts a virtual terminal session.
Public methodSupported by the .NET Compact FrameworkToString
Returns a string representation of this object.
(Overrides Object..::..ToString()()()().)

Fields

  NameDescription
Public fieldStatic memberSupported by the .NET Compact FrameworkDefaultPort
Default SSH port (22).

Properties

  NameDescription
Public propertySupported by the .NET Compact FrameworkEncoding
Gets or sets the Encoding to use to encode and decode command parameters and server responses.
Public propertySupported by the .NET Compact FrameworkFingerprint
Gets the server public key fingerprint (a SHA-256 hash of the server public key).
Protected propertySupported by the .NET Compact FrameworkInstanceId
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkIsAuthenticated
Gets a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.)
Public propertySupported by the .NET Compact FrameworkIsConnected
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.)
Public propertySupported by the .NET Compact FrameworkIsDisposed
Gets a value indicating whether the object is disposed.
Public propertySupported by the .NET Compact FrameworkLocalEndPoint
Gets the local client EndPoint.
Public propertySupported by the .NET Compact FrameworkLogWriter
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkProxy
Gets or sets the network proxy to use to access a remote server.
Public propertySupported by the .NET Compact FrameworkRemoteEndPoint
Gets the remote server EndPoint.
Public propertySupported by the .NET Compact FrameworkServerKey
Gets the server public key.
Public propertySupported by the .NET Compact FrameworkServerName
Gets the server name, if available.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkServerPort
Gets the server port, if available.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkSession
Gets the SSH session used by this SSH session.
Public propertySupported by the .NET Compact FrameworkSettings
Gets or sets SSH object settings.
Public propertySupported by the .NET Compact FrameworkTimeout
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).
Public propertySupported by the .NET Compact FrameworkUserName
Gets the authenticated user name, if available.
(Inherited from NetworkSession.)
Public propertyStatic memberSupported by the .NET Compact FrameworkVersion
Gets the version of the SSH component.

Events

  NameDescription
Public eventSupported by the .NET Compact FrameworkAuthenticationRequest
Occurs when an authentication request is received from the server that cannot be answered programmatically.
Public eventSupported by the .NET Compact FrameworkBannerReceived
Occurs when a banner message is received from the server.
Public eventSupported by the .NET Compact FrameworkFingerprintCheck
Occurs when a fingerprint is received from the server and needs to be validated.
Public eventSupported by the .NET Compact FrameworkTunnelError
Occurs when a tunnel fails with an error.

Explicit Interface Implementations

See Also