The Ssh type exposes the following members.

Constructors

  Name Description
Public method Ssh()()()()
Creates a new Ssh client instance.
Public method Ssh(SshParameters)
Creates a new Ssh client instance with default configuration.
Public method Ssh(SshParameters, SshConfiguration)
Creates a new Ssh client instance.

Methods

  Name Description
Public method Connect
Connects to SSH server.
Public method Disconnect
Closes open connection.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetStream
Returns the channel stream.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method RequestExec
Method requestExec request the SSH server to start the execution of the given command. The command string may contain a path.
Public method RequestPty(String, Int32, Int32)
Method RequestPty allocates a pseudo-terminal for the session.
Public method RequestPty(String, Int32, Int32, array<ITerminalMode>[]()[][])
Method RequestPty allocates a pseudo-terminal for the session.
Public method RequestShell
Method RequestShell request the user's default shell.
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

  Name Description
Public field Static member AUTH_METHOD_HOSTBASE
Public field Static member AUTH_METHOD_KBI
Public field Static member AUTH_METHOD_NONE
Public field Static member AUTH_METHOD_PASSWORD
Public field Static member AUTH_METHOD_PUBLICKEY
Public field Static member CHANNEL_REQUEST_ENV
Public field Static member CHANNEL_REQUEST_EXEC
Public field Static member CHANNEL_REQUEST_EXIT_SIGNAL
Public field Static member CHANNEL_REQUEST_EXIT_STATUS
Public field Static member CHANNEL_REQUEST_PTY_REQ
Public field Static member CHANNEL_REQUEST_SHELL
Public field Static member CHANNEL_REQUEST_SIGNAL
Public field Static member CHANNEL_REQUEST_SUBSYSTEM
Public field Static member CHANNEL_REQUEST_WINDOW_CHANGE
Public field Static member CHANNEL_REQUEST_X11_REQ
Public field Static member CHANNEL_REQUEST_XON_XOFF
Public field Static member CHANNEL_TYPE_DIRECT_TCPIP
Public field Static member CHANNEL_TYPE_FORWARDED_TCPIP
Public field Static member CHANNEL_TYPE_SESSION
Public field Static member CHANNEL_TYPE_X11
Public field Static member COMPRESSION_ALG_NONE
Public field Static member COMPRESSION_ALG_ZLIB
Public field Static member DISCONNECT_AUTH_CANCELLED_BY_USER
Public field Static member DISCONNECT_BY_APPLICATION
Public field Static member DISCONNECT_COMPRESSION_ERROR
Public field Static member DISCONNECT_CONNECTION_LOST
Public field Static member DISCONNECT_HOST_KEY_NOT_VERIFIABLE
Public field Static member DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT
Public field Static member DISCONNECT_ILLEGAL_USER_NAME
Public field Static member DISCONNECT_KEY_EXCHANGE_FAILED
Public field Static member DISCONNECT_MAC_ERROR
Public field Static member DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE
Public field Static member DISCONNECT_PROTOCOL_ERROR
Public field Static member DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED
Public field Static member DISCONNECT_RESERVED
Public field Static member DISCONNECT_SERVICE_NOT_AVAILABLE
Public field Static member DISCONNECT_TOO_MANY_CONNECTIONS
Public field Static member ENCRYPTION_ALG_3DES_CBC
Public field Static member ENCRYPTION_ALG_AES128_CBC
Public field Static member ENCRYPTION_ALG_AES192_CBC
Public field Static member ENCRYPTION_ALG_AES256_CBC
Public field Static member ENCRYPTION_ALG_ARCFOUR
Public field Static member ENCRYPTION_ALG_BLOWFISH_CBC
Public field Static member ENCRYPTION_ALG_CAST128_CBC
Public field Static member ENCRYPTION_ALG_DES_CBC
Public field Static member ENCRYPTION_ALG_IDEA_CBC
Public field Static member ENCRYPTION_ALG_NONE
Public field Static member ENCRYPTION_ALG_SERPENT128_CBC
Public field Static member ENCRYPTION_ALG_SERPENT192_CBC
Public field Static member ENCRYPTION_ALG_SERPENT256_CBC
Public field Static member ENCRYPTION_ALG_TWOFISH_CBC
Public field Static member ENCRYPTION_ALG_TWOFISH128_CBC
Public field Static member ENCRYPTION_ALG_TWOFISH192_CBC
Public field Static member ENCRYPTION_ALG_TWOFISH256_CBC
Public field Static member KEY_EXCHANGE_DIFFIE_HELLMAN
Public field Static member MAC_ALG_HMAC_MD5
Public field Static member MAC_ALG_HMAC_MD5_96
Public field Static member MAC_ALG_HMAC_SHA1
Public field Static member MAC_ALG_HMAC_SHA1_96
Public field Static member MAC_ALG_NONE
Public field Static member MSG_CHANNEL_CLOSE
Public field Static member MSG_CHANNEL_DATA
Public field Static member MSG_CHANNEL_EOF
Public field Static member MSG_CHANNEL_EXTENDED_DATA
Public field Static member MSG_CHANNEL_FAILURE
Public field Static member MSG_CHANNEL_OPEN
Public field Static member MSG_CHANNEL_OPEN_CONFIRMATION
Public field Static member MSG_CHANNEL_OPEN_FAILURE
Public field Static member MSG_CHANNEL_REQUEST
Public field Static member MSG_CHANNEL_SUCCESS
Public field Static member MSG_CHANNEL_WINDOW_ADJUST
Public field Static member MSG_DEBUG
Public field Static member MSG_DISCONNECT
Public field Static member MSG_GLOBAL_REQUEST
Public field Static member MSG_IGNORE
Public field Static member MSG_KEXDH_INIT
Public field Static member MSG_KEXDH_REPLY
Public field Static member MSG_KEXINIT
Public field Static member MSG_NEWKEYS
Public field Static member MSG_REQUEST_FAILURE
Public field Static member MSG_REQUEST_SUCCESS
Public field Static member MSG_SERVICE_ACCEPT
Public field Static member MSG_SERVICE_REQUEST
Public field Static member MSG_UNIMPLEMENTED
Public field Static member MSG_USERAUTH_BANNER
Public field Static member MSG_USERAUTH_FAILURE
Public field Static member MSG_USERAUTH_PK_OK
Public field Static member MSG_USERAUTH_REQUEST
Public field Static member MSG_USERAUTH_SUCCESS
Public field Static member PROTOCOL_REQUEST_TCPIP_FORWARD
Public field Static member PROTOCOL_REQUEST_TCPIP_FORWARD_CANCEL
Public field Static member PUB_KEY_ALG_PGP_SIGN_DSS
Public field Static member PUB_KEY_ALG_PGP_SIGN_RSA
Public field Static member PUB_KEY_ALG_SPKI_SIGN_DSS
Public field Static member PUB_KEY_ALG_SPKI_SIGN_RSA
Public field Static member PUB_KEY_ALG_SSH_DSS
Public field Static member PUB_KEY_ALG_SSH_RSA
Public field Static member PUB_KEY_ALG_X509V3_SIGN_DSS
Public field Static member PUB_KEY_ALG_X509V3_SIGN_RSA
Public field Static member SERVICE_CONNECTION
Public field Static member SERVICE_USERAUTH

Properties

  Name Description
Public property Connected
Checks if the client is still connected
Public property Debug
The debug flag.
Public property DebugStream
The debug stream.
Public property Echo
SSH echo flag.
Public property HostKeys
Gets SSH host keys for further use.
Public property Hostname
The server hostname.
Public property InitReader
The reader flag.
Public property LicenseKey
License key.
Public property Parameters
The connection parameters.
Public property Password
The current user password.
Public property Port
The server port.
Public property PrivateKey
The current user key file.
Public property TerminalType
The terminal type.
Public property Timeout
The connection timeout defined in milliseconds.
Public property Username
The current username.

Events

  Name Description
Public event ConnectionClosed
Public event SshConnectedEvent
Occurs after a successful connection to the SSH server.
Public event SshDataEvent
Occurs when data has been received from SSH server.
Public event SshDisconnectedEvent
Occurs after connection is released from ssh server.

See Also