Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SSHClient Class
Members


In This Topic
    SSHClient Class
    In This Topic
    Represents the SSH client that will be used for the SFTP operations.
    Syntax
    'Declaration
 
Public Class SSHClient 
   Implements System.IDisposable 
    'Usage
 
Dim instance As SSHClient
    public class SSHClient : System.IDisposable 
    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Client.SSHClient

    Public Constructors
     NameDescription
    Public ConstructorSSHClient ConstructorOverloaded. Initializes a new instance of the SSHClient class.  
    Top
    Protected Fields
     NameDescription
    Protected FieldCompressionAlgorithmListInternal  
    Protected FieldConnectionManagerInternalThe SSHClientConnectionManager that the SSHClient uses.  
    Protected FieldDataIntegrityAlgorithmListInternal  
    Protected FieldEncryptionAlgorithmListInternal  
    Protected FieldHostNameStringInternal  
    Protected FieldIOProviderInternalThe SocketIOProvider that the SSHClient uses.  
    Protected FieldLanguagesAlgorithmListInternal  
    Protected FieldProtocolProviderInternalThe SSHProtocolsProvider that the SSHClient uses.  
    Top
    Public Properties
     NameDescription
    Public PropertyActiveDataIntegrityAlgorithmClientToServerString  
    Public PropertyActiveDataIntegrityAlgorithmServerToClientString  
    Public PropertyActiveEncryptionAlgorithmClientToServerString  
    Public PropertyActiveEncryptionAlgorithmServerToClientString  
    Public PropertyActiveKeyExchangeAlgorithmString  
    Public PropertyActivePublicKeyAlgorithmString  
    Public PropertyAllowTraceWriterClosureGet or sets a Boolean value that indicates whether SSHClient can close its assigned TraceWriter as part of its cleanup.  
    Public PropertyAuthenticatedGets a System.Boolean value that indicates if the SSHClient object is authenticated to a server or not.  
    Public PropertyCompressionAlgorithmList  
    Public PropertyConnectedGets a System.Boolean value that indicates if the SSHClient object is connected to a server or not.  
    Public PropertyConnectionManager  
    Public PropertyConnectionProtocolGets the SSHClient's SSH connection protocol.  
    Public PropertyDataIntegrityAlgorithmList  
    Public PropertyEncryptionAlgorithmList  
    Public PropertyEncryptionAlgorithmListClientToServer  
    Public PropertyEncryptionAlgorithmListServerToClient  
    Public PropertyHostNameGets the host name used to connect, or an empty string if not connected.  
    Public PropertyIOProvider  
    Public PropertyKeyExchangeAlgorithmList  
    Public PropertyLanguagesAlgorithmList  
    Public PropertyLocalAddress

    Gets or sets the local IP address and port from which the SSH client will be or is connected from.

     
    Public PropertyPortGets the port being used by the SSH client.  
    Public PropertyProxyClientGets or sets the proxy client to use for connecting and/or logging in via a proxy server.  
    Public PropertyPublicKeyAlgorithmList  
    Public PropertyServerEndPointGets the host name used to connect expressed as a System.Net.IPEndPoint object or null if the client is not connected.  
    Public PropertyServerIdentificationComments  
    Public PropertyServerIdentificationSoftwareVersion  
    Public PropertyServerIdentificationSoftwareVersionAndComments  
    Public PropertyState  
    Public PropertyTcpIpIOProvider  
    Public PropertyTimeoutGets or sets a value, in seconds, indicating after what period of time an SSH operation should timeout.  
    Public PropertyTimeoutSeconds  
    Public PropertyTraceWriterGets or sets the System.IO.TextWriter which will trace the connection/deconnection process as well as the commands and replies sent to and received from the SSH server.  
    Public PropertyTraceWriterTimestampFormat  
    Public PropertyTraceWriterTimestampFormatProvider  
    Public PropertyTraceWriterTimestampUTC  
    Public PropertyTransportLayerProtocol  
    Public PropertyWaitForChannelCloseMessage  
    Public PropertyWaitForServerKeysGets or sets a System.Boolean value that indicates whether, when connecting, the client should wait for the server to send its encryption keys.  
    Top
    Public Methods
     NameDescription
    Public MethodAuthenticateOverloaded. Performs authentication of the SSHClient's SSH connection using the provided username and password.  
    Public MethodConnectOverloaded. Connects the SSHClient to an SSH server.  
    Public MethodDisconnectDisconnects the SSHClient from the SSH server.  
    Public MethodDisposeOverloaded.   
    Public MethodGetSupportedAuthenticationMethods  
    Public MethodPrepareConnectOverloaded.   
    Public MethodReExchangeKeys  
    Public MethodTraceWriterTestTimestampOverloaded.   
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalize  
    Protected MethodOnAlgorithmsNegotiated  
    Protected MethodOnAuthenticationBannerReceived  
    Protected MethodOnDisconnected  
    Protected MethodOnHostKeyReceived  
    Top
    Public Events
     NameDescription
    Public EventAlgorithmsNegotiated  
    Public EventAuthenticationBannerReceived  
    Public EventDisconnected  
    Public EventHostKeyReceivedThis event is triggered during connection sequence to a SSH server when the server's public key is received for authentication.  
    Top
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    SSHClient Members
    Xceed.SSH.Client Namespace

    Send Feedback