on_auth_failed Event

Fires when a single authentication attempt is failed.

Syntax

class SSHClientAuthFailedEventParams(object):
  @property
  def authentication_type() -> int: ...

# In class SSHClient:
@property
def on_auth_failed() -> Callable[[SSHClientAuthFailedEventParams], None]: ...
@on_auth_failed.setter
def on_auth_failed(event_hook: Callable[[SSHClientAuthFailedEventParams], None]) -> None: ...

Remarks

This event is fired each time a single authentication attempt fails. AuthType parameter specifies the type of authentication.

As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection.