IPWorks Auth 2020 Python Edition

Questions / Feedback?

on_log Event

Fires once for each log message.

Syntax

class SSHAuthLogEventParams(object):
  @property
  def log_level() -> int: ...
  @property
  def message() -> str: ...
  @property
  def log_type() -> str: ...

# In class SSHAuth:
@property
def on_log() -> Callable[[SSHAuthLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[SSHAuthLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as SSH handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information is logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

Message is the log message.

LogType is reserved for future use.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Python Edition - Version 20.0 [Build 8155]