connect Method

Establishes connection to an SSH server.

Syntax

def connect(address: str, port: int) -> None: ...

Remarks

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using username and password properties. You might also need to configure the server key validation routine. You can do this by subscribing to on_known_key_received and on_unknown_key_received events and implementing the event handlers as required.

Adjust async_mode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as on_connect or send_bytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the async_mode topic.