cterasdk.edge.audit module

class cterasdk.edge.audit.Audit(gateway)

Bases: cterasdk.edge.base_command.BaseCommand

Gateway Audit configuration APIs

Variables:defaultAuditEvents (list[cterasdk.edge.enum.AuditEvents]) – Default audit events

defaultAuditEvents = ['WD', 'AD', 'WEA', 'DC', 'WA', 'DE', 'WDAC', 'WO']

disable()

Disable Gateway Audit log

enable(path, auditEvents=None, logKeepPeriod=30, maxLogKBSize=102400, maxRotateTime=1440, includeAuditLogTag=True, humanReadableAuditLog=False)

Enable Gateway Audit log

Parameters:

• path (str) – Path to save the audit log
• auditEvents (list[cterasdk.edge.enum.AuditEvents],optional) – List of audit event types to save, defaults to Audit.defaultAuditEvents
• logKeepPeriod (int,optional) – Period to key the logs in days, defaults to 30
• maxLogKBSize (int,optional) – The maximum size of the log file in KB, defailts to 102400 (100 MB)
• maxRotateTime (int,optional) – The maximal time before rotating the log file in Minutes, defaults to 1440 (24 hours)
• includeAuditLogTag (bool,optional) – Include audit log tag, defailts to True
• humanReadableAuditLog (bool,optional) – Human readable audit log, defailts to False