Module tripleblind.log_export

Functions

def log_export(save_as: str = 'logs.tar.gz', overwrite: bool = False, session: Session | None = None) -> pathlib.Path

Utility to retrieve Access Point logs for diagnostics.

Args

save_as : str, optional

Destination file for the archive of log messages. Defaults to "logs.tar.gz".

overwrite : bool, optional

Overwrite any existing file? Defaults to False.

session : Optional[Session], optional

A connection session. If not specified, the default session is used.

Raises

TripleblindAPIError

Failed to communicate with Access Point

IOError

Failed to save the log file (already exists?)

Returns

Path

The path of the log archive.