Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SSHClient Class / Connect Method / Connect(String) Method
A string representing the SSH server's address.


In This Topic
    Connect(String) Method
    In This Topic
    Connects the SSHClient to an SSH server.
    Syntax
    'Declaration
 

    Public Overloads Sub Connect( _
   ByVal serverAddress As String _
) 
    'Usage
 

    Dim instance As SSHClient
Dim serverAddress As String
 
instance.Connect(serverAddress)
    public void Connect( 
   string serverAddress
)

    Parameters

    serverAddress
    A string representing the SSH server's address.
    Exceptions
    ExceptionDescription
    System.ArgumentExceptionThrown when the server address is null, empty or cannot be resolved.
    System.ArgumentOutOfRangeExceptionThrown when the port number is outside the range specified by System.Net.IPEndPoint.
    System.InvalidOperationExceptionThrown when an attempt to connect was made while the client's state is not in the 'NotConnected' state.
    System.Net.Sockets.SocketExceptionThrown when an error occurs with the socket object during connection. Typically when the SSH server cannot be reached at the specified address and port.
    Xceed.SSH.Protocols.SSHKeyExchangeExceptionThrown when something goes wrong with key exchange between the SSH client and the server. The InnerException property often
    Remarks
    This method uses SSHConstants.SSH_PORT for the port.
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    SSHClient Class
    SSHClient Members
    Overload List
    System.Net.IPEndPoint

    Send Feedback