Difference between revisions of "Event Definitions"

From UntangleWiki
Jump to: navigation, search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<span style="display:none" class="helpSource events">Events</span>
 +
<span style="display:none" class="helpSource events_syslog">Events</span>
 +
<span style="display:none" class="helpSource events_alert_rules">Events</span>
 +
 
All event data is stored in the [[Database Schema]] in a relational database. As Untangle and applications process traffic they create Event objects that add and modify content in the database.
 
All event data is stored in the [[Database Schema]] in a relational database. As Untangle and applications process traffic they create Event objects that add and modify content in the database.
 
Each event has it's own class/object with certain fields that modify the database in a certain way.  
 
Each event has it's own class/object with certain fields that modify the database in a certain way.  
Line 4: Line 8:
 
The list below shows the classes used in the event logging and the attributes of each event object. These can be used to add alerts in [[Reports]] or for other event handling within Untangle.  
 
The list below shows the classes used in the event logging and the attributes of each event object. These can be used to add alerts in [[Reports]] or for other event handling within Untangle.  
  
== HostTableEvent ==
+
== SpamLogEvent ==
<section begin='HostTableEvent' />
+
<section begin='SpamLogEvent' />
  
These events are created by the base system and inserted to the [[Database_Schema#host_table_updates|host_table_updates]] table when the host table is modified.
+
These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 13: Line 17:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAction
 
|-
 
|-
|address
+
|action
|InetAddress
+
|SpamMessageAction
|The address
+
|The action
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientAddr
 +
|-
 +
|clientAddr
 +
|InetAddress
 +
|The client address
 +
getClientPort
 
|-
 
|-
|key
+
|clientPort
|String
+
|int
|The key
+
|The client port
 +
getMessageId
 
|-
 
|-
|timeStamp
+
|messageId
|Timestamp
+
|Long
|The timestamp
+
|The message ID
 +
getPartitionTablePostfix
 +
getReceiver
 
|-
 
|-
|value
+
|receiver
 
|String
 
|String
|The value
+
|The receiver
|}
+
getScore
<section end='HostTableEvent' />
 
 
 
 
 
== DeviceTableEvent ==
 
<section begin='DeviceTableEvent' />
 
 
 
These events are created by the base system and inserted to the [[Database_Schema#device_table_updates|device_table_updates]] table when the device list is modified.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
 
|-
 
|-
|class
+
|score
|Class
+
|float
|The class name
+
|The score
 +
getSender
 
|-
 
|-
|device
+
|sender
|DeviceTableEntry
 
|The Device
 
|-
 
|key
 
 
|String
 
|String
|The key
+
|The sender
 +
getServerAddr
 
|-
 
|-
|macAddress
+
|serverAddr
|String
+
|InetAddress
|The MAC address
+
|The server address
 +
getServerPort
 +
|-
 +
|serverPort
 +
|int
 +
|The server port
 +
getSmtpMessageEvent
 +
|-
 +
|smtpMessageEvent
 +
|SmtpMessageEvent
 +
|The parent SMTP message event
 +
isSpam
 +
|-
 +
|isSpam
 +
|boolean
 +
|True if spam, false otherwise
 +
getSubject
 +
|-
 +
|subject
 +
|String
 +
|The subject
 +
getTag
 +
getTestsString
 +
|-
 +
|testsString
 +
|String
 +
|The tests string from the spam engine
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getVendorName
 
|-
 
|-
|value
+
|vendorName
 
|String
 
|String
|The value
+
|The application name
 
|}
 
|}
<section end='DeviceTableEvent' />
+
<section end='SpamLogEvent' />
  
  
== PenaltyBoxEvent ==
+
== SpamSmtpTarpitEvent ==
<section begin='PenaltyBoxEvent' />
+
<section begin='SpamSmtpTarpitEvent' />
  
These events are created by the [[Bandwidth Control]] and inserted to the [[Database_Schema#penaltybox|penaltybox]] table.
+
These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 83: Line 112:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getIPAddr
 
|-
 
|-
|action
+
|IPAddr
|int
+
|InetAddress
|The action
+
|The IP address
|-
+
getClass
|address
 
|InetAddress
 
|The address
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getHostname
 +
|-
 +
|hostname
 +
|String
 +
|The hostname
 +
getPartitionTablePostfix
 +
getSessionEvent
 
|-
 
|-
|entryTime
+
|sessionEvent
|Timestamp
+
|SessionEvent
|The entry time
+
|The session event
 +
getSessionId
 
|-
 
|-
|exitTime
+
|sessionId
|Timestamp
+
|Long
|The exit time
+
|The session ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getVendorName
 +
|-
 +
|vendorName
 +
|String
 +
|The application name
 
|}
 
|}
<section end='PenaltyBoxEvent' />
+
<section end='SpamSmtpTarpitEvent' />
  
  
== SessionStatsEvent ==
+
== PrioritizeEvent ==
<section begin='SessionStatsEvent' />
+
<section begin='PrioritizeEvent' />
  
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table when a session ends with the updated stats.
+
These events are created by the [[Bandwidth Control]] and update the [[Database_Schema#sessions|session]] table when a session is prioritized.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 120: Line 162:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
|c2pBytes
+
|class
|long
 
|The number of bytes sent from the client to Untangle
 
|-
 
|class
 
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getPartitionTablePostfix
 +
getPriority
 
|-
 
|-
|endTime
+
|priority
|long
+
|int
|The end time/date
+
|The priority
 +
getRuleId
 
|-
 
|-
|p2cBytes
+
|ruleId
|long
+
|int
|The number of bytes sent to the client from Untangle
+
|The rule ID
 +
getSessionEvent
 
|-
 
|-
|p2sBytes
+
|sessionEvent
|long
+
|SessionEvent
|The number of bytes sent to the server from Untangle
+
|The session event
|-
+
getTag
|s2pBytes
+
getTimeStamp
|long
 
|The number of bytes sent from the server to Untangle
 
|-
 
|sessionId
 
|Long
 
|The session ID
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 153: Line 190:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='SessionStatsEvent' />
+
<section end='PrioritizeEvent' />
  
  
== SessionEvent ==
+
== VirusFtpEvent ==
<section begin='SessionEvent' />
+
<section begin='VirusFtpEvent' />
  
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table each time a session is created.
+
These events are created by [[Virus Blocker]] and update the [[Database_Schema#ftp_events|ftp_events]] table when Virus Blocker scans an FTP transfer.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 165: Line 202:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAppName
 
|-
 
|-
|cClientAddr
+
|appName
|InetAddress
+
|String
|The client-side (pre-NAT) client address
+
|The name of the application
 +
getClass
 
|-
 
|-
|cClientPort
+
|class
|Integer
+
|Class
|The client-side (pre-NAT) client port
+
|The class name
 +
getClean
 
|-
 
|-
|cServerAddr
+
|clean
|InetAddress
+
|boolean
|The client-side (pre-NAT) server address
+
|True if clean, false otherwise
 +
getPartitionTablePostfix
 +
getSessionEvent
 
|-
 
|-
|cServerPort
+
|sessionEvent
|Integer
+
|SessionEvent
|The client-side (pre-NAT) server port
+
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|sClientAddr
+
|timeStamp
|InetAddress
+
|Timestamp
|The server-side (post-NAT) client address
+
|The timestamp
 +
getUri
 
|-
 
|-
|sClientPort
+
|uri
|Integer
+
|String
|The server-side (post-NAT) client port
+
|The URI
 +
getVirusName
 
|-
 
|-
|sServerAddr
+
|virusName
|InetAddress
+
|String
|The server-side (post-NAT) server address
+
|The virus name, if not clean
 +
|}
 +
<section end='VirusFtpEvent' />
 +
 
 +
 
 +
== VirusHttpEvent ==
 +
<section begin='VirusHttpEvent' />
 +
 
 +
These events are created by [[Virus Blocker]] and update the [[Database_Schema#http_events|http_events]] table when Virus Blocker scans an HTTP transfer.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getAppName
 
|-
 
|-
|sServerPort
+
|appName
|Integer
+
|String
|The server-side (post-NAT) server port
+
|The name of the application
|-
+
getClass
|bypassed
 
|boolean
 
|True if bypassed, false otherwise
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClean
 
|-
 
|-
|clientCountry
+
|clean
|String
+
|boolean
|The client country
+
|True if clean, false otherwise
 +
getPartitionTablePostfix
 +
getRequestLine
 
|-
 
|-
|clientIntf
+
|requestLine
|Integer
+
|RequestLine
|The client interface ID
+
|The request line
 +
getSessionEvent
 
|-
 
|-
|clientLatitude
+
|sessionEvent
|Double
+
|SessionEvent
|The client latitude
+
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|clientLongitude
+
|timeStamp
|Double
+
|Timestamp
|The client longitude
+
|The timestamp
 +
getVirusName
 
|-
 
|-
|entitled
+
|virusName
|boolean
 
|The entitled status
 
|-
 
|filterPrefix
 
 
|String
 
|String
|The filter prefix if blocked by the filter rules
+
|The virus name, if not clean
|-
+
|}
|hostname
+
<section end='VirusHttpEvent' />
 +
 
 +
 
 +
== VirusSmtpEvent ==
 +
<section begin='VirusSmtpEvent' />
 +
 
 +
These events are created by [[Virus Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when Virus Blocker scans an email.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getAction
 +
|-
 +
|action
 
|String
 
|String
|The hostname
+
|The action
 +
getAppName
 
|-
 
|-
|icmpType
+
|appName
|Short
+
|String
|The ICMP type
+
|The name of the application
 +
getClass
 
|-
 
|-
|localAddr
+
|class
|InetAddress
+
|Class
|The local host address
+
|The class name
 +
getClean
 
|-
 
|-
|policyId
+
|clean
|Integer
+
|boolean
|The policy ID
+
|True if clean, false otherwise
 +
getMessageId
 
|-
 
|-
|policyRuleId
+
|messageId
|Integer
+
|Long
|The policy rule ID
+
|The message ID
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|protocol
+
|timeStamp
|Short
+
|Timestamp
|The protocol
+
|The timestamp
 +
getVirusName
 
|-
 
|-
|protocolName
+
|virusName
 
|String
 
|String
|The protocol name
+
|The virus name, if not clean
 +
|}
 +
<section end='VirusSmtpEvent' />
 +
 
 +
 
 +
== FirewallEvent ==
 +
<section begin='FirewallEvent' />
 +
 
 +
These events are created by [[Firewall]] and update the [[Database_Schema#sessions|sessions]] table when a firewall rule matches a session.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getBlocked
 
|-
 
|-
|remoteAddr
+
|blocked
|InetAddress
+
|boolean
|The remote host address
+
|True if blocked, false otherwise
 +
getClass
 
|-
 
|-
|serverCountry
+
|class
|String
+
|Class
|The server country
+
|The class name
 +
getFlagged
 
|-
 
|-
|serverIntf
+
|flagged
|Integer
+
|boolean
|The server interface ID
+
|True if flagged, false otherwise
 +
getPartitionTablePostfix
 +
getRuleId
 
|-
 
|-
|serverLatitude
+
|ruleId
|Double
+
|long
|The server latitude
+
|The rule ID
|-
+
getSessionId
|serverLongitude
 
|Double
 
|The server longitude
 
 
|-
 
|-
 
|sessionId
 
|sessionId
 
|Long
 
|Long
 
|The session ID
 
|The session ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|username
 
|String
 
|The username
 
 
|}
 
|}
<section end='SessionEvent' />
+
<section end='FirewallEvent' />
  
  
== SessionMinuteEvent ==
+
== OpenVpnStatusEvent ==
<section begin='SessionMinuteEvent' />
+
<section begin='OpenVpnStatusEvent' />
  
These events are created by the base system and update the [[Database_Schema#sessions|session_minutes]] table each minute a session exists.
+
These events are created by [[OpenVPN]] and update the [[Database_Schema#openvpn_stats|openvpn_stats]] table periodically.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 302: Line 397:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAddress
 +
|-
 +
|address
 +
|InetAddress
 +
|The address
 +
getBytesRxDelta
 
|-
 
|-
|c2sBytes
+
|bytesRxDelta
 
|long
 
|long
|The number of bytes sent from the client to the server
+
|The delta number of RX (received) bytes from the previous event
 +
getBytesRxTotal
 
|-
 
|-
|class
+
|bytesRxTotal
|Class
+
|long
|The class name
+
|The total number of RX (received) bytes
 +
getBytesTxDelta
 
|-
 
|-
|s2cBytes
+
|bytesTxDelta
 
|long
 
|long
|The number of bytes sent from the server to the client
+
|The delta number of TX (transmitted) bytes from the previous event
 +
getBytesTxTotal
 
|-
 
|-
|sessionId
+
|bytesTxTotal
 
|long
 
|long
|The session ID
+
|The total number of TX (transmitted) bytes
 +
getClass
 
|-
 
|-
|timeStamp
+
|class
 +
|Class
 +
|The class name
 +
getClientName
 +
|-
 +
|clientName
 +
|String
 +
|The client name
 +
getEnd
 +
|-
 +
|end
 +
|Timestamp
 +
|The end
 +
getPartitionTablePostfix
 +
getPoolAddress
 +
|-
 +
|poolAddress
 +
|InetAddress
 +
|The pool address
 +
getPort
 +
|-
 +
|port
 +
|int
 +
|The port
 +
getStart
 +
|-
 +
|start
 +
|Timestamp
 +
|The start
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='SessionMinuteEvent' />
+
<section end='OpenVpnStatusEvent' />
  
  
== SessionNatEvent ==
+
== OpenVpnEvent ==
<section begin='SessionNatEvent' />
+
<section begin='OpenVpnEvent' />
  
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table each time a session is NATd with the post-NAT information.
+
These events are created by [[OpenVPN]] and update the [[Database_Schema#openvpn_events|openvpn_events]] table when OpenVPN processes a client action.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 335: Line 472:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAddress
 
|-
 
|-
|sClientAddr
+
|address
 
|InetAddress
 
|InetAddress
|The server-side (post-NAT) client address
+
|The address
|-
+
getClass
|sClientPort
 
|Integer
 
|The server-side (post-NAT) client port
 
|-
 
|sServerAddr
 
|InetAddress
 
|The server-side (post-NAT) server address
 
|-
 
|sServerPort
 
|Integer
 
|The server-side (post-NAT) server port
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientName
 +
|-
 +
|clientName
 +
|String
 +
|The client name
 +
getPartitionTablePostfix
 +
getPoolAddress
 
|-
 
|-
|serverIntf
+
|poolAddress
|Integer
+
|InetAddress
|The server interface ID
+
|The pool address
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getType
 +
|-
 +
|type
 +
|OpenVpnEvent$EventType
 +
|The type
 
|}
 
|}
<section end='SessionNatEvent' />
+
<section end='OpenVpnEvent' />
  
  
== QuotaEvent ==
+
== AdminLoginEvent ==
<section begin='QuotaEvent' />
+
<section begin='AdminLoginEvent' />
  
These events are created by the [[Bandwidth Control]] and inserted or update the [[Database_Schema#quotas|quotas]] table when quotas are given or exceeded.
+
These events are created by the base system and inserted to the [[Database_Schema#user_table_updates|admin_logins]] table when an administrator login is attempted or successful.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 376: Line 517:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
|action
+
|class
|int
+
|Class
|The action (1=Quota Given, 2=Quota Exceeded)
+
|The class name
 +
getClientAddress
 
|-
 
|-
|address
+
|clientAddress
 
|InetAddress
 
|InetAddress
|The address
+
|The client address
 +
getLocal
 
|-
 
|-
|class
+
|local
|Class
+
|boolean
|The class name
+
|1 if login is done via local console, 0 otherwise
 +
getLogin
 
|-
 
|-
|quotaSize
+
|login
|long
+
|String
|The quota size
+
|The login username
 +
getPartitionTablePostfix
 +
getReason
 
|-
 
|-
 
|reason
 
|reason
 
|String
 
|String
 
|The reason
 
|The reason
 +
getSucceeded
 +
|-
 +
|succeeded
 +
|boolean
 +
|1 if successful, 0 otherwise
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 401: Line 555:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='QuotaEvent' />
+
<section end='AdminLoginEvent' />
  
  
== SettingsChangesEvent ==
+
== AlertEvent ==
<section begin='SettingsChangesEvent' />
+
<section begin='AlertEvent' />
  
These events are created by the base system and inserted to the [[Database_Schema#settings_changes|settings_changes]] table when settings are changed.
+
These events are created by [[Reports]] and inserted to the [[Database_Schema#alerts|alerts]] table when an alert fires.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 413: Line 567:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getCausalRule
 +
|-
 +
|causalRule
 +
|EventRule
 +
|The causal rule
 +
getCause
 +
|-
 +
|cause
 +
|LogEvent
 +
|The cause
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getDescription
 
|-
 
|-
|hostname
+
|description
 
|String
 
|String
|The hostname
+
|The description
 +
getEventSent
 +
|-
 +
|eventSent
 +
|Boolean
 +
|True if the event was sent, false otherwise
 +
getJson
 +
|-
 +
|json
 +
|String
 +
|The JSON string
 +
getPartitionTablePostfix
 +
getSummaryText
 
|-
 
|-
|settingsFile
+
|summaryText
 
|String
 
|String
|The settings file
+
|The summary text
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|username
 
|String
 
|The username
 
 
|}
 
|}
<section end='SettingsChangesEvent' />
+
<section end='AlertEvent' />
  
  
== LogEvent ==
+
== InterfaceStatEvent ==
<section begin='LogEvent' />
+
<section begin='InterfaceStatEvent' />
  
These base class for all events.
+
These events are created by the base system and inserted to the [[Database_Schema#settings_changes|interface_stat_events]] table periodically with interface stats.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 446: Line 622:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getInterfaceId
 +
|-
 +
|interfaceId
 +
|int
 +
|The interface ID
 +
getPartitionTablePostfix
 +
getRxBytes
 
|-
 
|-
|timeStamp
+
|rxBytes
|Timestamp
+
|double
|The timestamp
+
|The total of received bytes
|}
+
getRxRate
<section end='LogEvent' />
 
 
 
 
 
== InterfaceStatEvent ==
 
<section begin='InterfaceStatEvent' />
 
 
 
These events are created by the base system and inserted to the [[Database_Schema#settings_changes|interface_stat_events]] table periodically with interface stats.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
|-
 
|class
 
|Class
 
|The class name
 
|-
 
|interfaceId
 
|int
 
|The interface ID
 
 
|-
 
|-
 
|rxRate
 
|rxRate
 
|double
 
|double
 
|The RX rate in byte/s
 
|The RX rate in byte/s
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getTxBytes
 +
|-
 +
|txBytes
 +
|double
 +
|The total of transmitted bytes
 +
getTxRate
 
|-
 
|-
 
|txRate
 
|txRate
Line 491: Line 663:
  
  
== SystemStatEvent ==
+
== LogEvent ==
<section begin='SystemStatEvent' />
+
<section begin='LogEvent' />
  
These events are created by the base system and inserted to the [[Database_Schema#server_events|server_events]] table periodically.
+
These base class for all events.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 500: Line 672:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
|activeHosts
+
|class
 +
|Class
 +
|The class name
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
|}
 +
<section end='LogEvent' />
 +
 
 +
 
 +
== SystemStatEvent ==
 +
<section begin='SystemStatEvent' />
 +
 
 +
These events are created by the base system and inserted to the [[Database_Schema#server_events|server_events]] table periodically.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getActiveHosts
 +
|-
 +
|activeHosts
 
|int
 
|int
 
|The active host count
 
|The active host count
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getCpuSystem
 
|-
 
|-
 
|cpuSystem
 
|cpuSystem
 
|float
 
|float
 
|The system CPU utilization
 
|The system CPU utilization
 +
getCpuUser
 
|-
 
|-
 
|cpuUser
 
|cpuUser
 
|float
 
|float
 
|The user CPU utilization
 
|The user CPU utilization
 +
getDiskFree
 
|-
 
|-
 
|diskFree
 
|diskFree
 
|long
 
|long
 
|The amount of disk free
 
|The amount of disk free
 +
getDiskFreePercent
 
|-
 
|-
 
|diskFreePercent
 
|diskFreePercent
 
|float
 
|float
 
|The percentage of disk free
 
|The percentage of disk free
 +
getDiskTotal
 
|-
 
|-
 
|diskTotal
 
|diskTotal
 
|long
 
|long
 
|The total size of the disk
 
|The total size of the disk
 +
getDiskUsed
 
|-
 
|-
 
|diskUsed
 
|diskUsed
 
|long
 
|long
 
|The amount of disk used
 
|The amount of disk used
 +
getDiskUsedPercent
 
|-
 
|-
 
|diskUsedPercent
 
|diskUsedPercent
 
|float
 
|float
 
|The percentage of disk used
 
|The percentage of disk used
 +
getLoad1
 
|-
 
|-
 
|load1
 
|load1
 
|float
 
|float
 
|The 1-minute CPU load
 
|The 1-minute CPU load
 +
getLoad15
 
|-
 
|-
 
|load15
 
|load15
 
|float
 
|float
 
|The 15-minute CPU load
 
|The 15-minute CPU load
 +
getLoad5
 
|-
 
|-
 
|load5
 
|load5
 
|float
 
|float
 
|The 5-minute CPU load
 
|The 5-minute CPU load
 +
getMemBuffers
 
|-
 
|-
 
|memBuffers
 
|memBuffers
 
|long
 
|long
 
|The amount of memory used by buffers
 
|The amount of memory used by buffers
 +
getMemCache
 
|-
 
|-
 
|memCache
 
|memCache
 
|long
 
|long
 
|The amount of memory used by cache
 
|The amount of memory used by cache
 +
getMemFree
 
|-
 
|-
 
|memFree
 
|memFree
 
|long
 
|long
 
|The amount of free memory
 
|The amount of free memory
 +
getMemFreePercent
 
|-
 
|-
 
|memFreePercent
 
|memFreePercent
 
|float
 
|float
 
|The percentage of total memory that is free
 
|The percentage of total memory that is free
 +
getMemTotal
 
|-
 
|-
 
|memTotal
 
|memTotal
 
|long
 
|long
 
|The total amount of memory
 
|The total amount of memory
 +
getMemUsed
 
|-
 
|-
 
|memUsed
 
|memUsed
 
|long
 
|long
 
|The amount of used memory
 
|The amount of used memory
 +
getMemUsedPercent
 
|-
 
|-
 
|memUsedPercent
 
|memUsedPercent
 
|float
 
|float
 
|The percentage of total memory that is used
 
|The percentage of total memory that is used
 +
getPartitionTablePostfix
 +
getSwapFree
 
|-
 
|-
 
|swapFree
 
|swapFree
 
|long
 
|long
 
|The amount of free swap
 
|The amount of free swap
 +
getSwapFreePercent
 
|-
 
|-
 
|swapFreePercent
 
|swapFreePercent
 
|float
 
|float
 
|The percentage of total swap that is free
 
|The percentage of total swap that is free
 +
getSwapTotal
 
|-
 
|-
 
|swapTotal
 
|swapTotal
 
|long
 
|long
 
|The total size of swap
 
|The total size of swap
 +
getSwapUsed
 
|-
 
|-
 
|swapUsed
 
|swapUsed
 
|long
 
|long
 
|The amount of used swap
 
|The amount of used swap
 +
getSwapUsedPercent
 
|-
 
|-
 
|swapUsedPercent
 
|swapUsedPercent
 
|float
 
|float
 
|The percentage of total swap that is used
 
|The percentage of total swap that is used
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 604: Line 828:
  
  
== TunnelStatusEvent ==
+
== HostTableEvent ==
<section begin='TunnelStatusEvent' />
+
<section begin='HostTableEvent' />
  
These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_tunnel_stats|ipsec_tunnel_stats]] table periodically.
+
These events are created by the base system and inserted to the [[Database_Schema#host_table_updates|host_table_updates]] table when the host table is modified.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 613: Line 837:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAddress
 +
|-
 +
|address
 +
|InetAddress
 +
|The address
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getKey
 
|-
 
|-
|inBytes
+
|key
|long
+
|String
|The number of bytes received from this tunnel
+
|The key
 +
getOldValue
 
|-
 
|-
|outBytes
+
|oldValue
|long
+
|String
|The number of bytes sent in this tunnel
+
|The old value
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getValue
 
|-
 
|-
|tunnelName
+
|value
 
|String
 
|String
|The name of this tunnel
+
|The value
 
|}
 
|}
<section end='TunnelStatusEvent' />
+
<section end='HostTableEvent' />
  
  
== VirtualUserEvent ==
+
== DeviceTableEvent ==
<section begin='VirtualUserEvent' />
+
<section begin='DeviceTableEvent' />
  
These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_user_events|ipsec_user_events]] table when a user event occurs.
+
These events are created by the base system and inserted to the [[Database_Schema#device_table_updates|device_table_updates]] table when the device list is modified.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 646: Line 882:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getDevice
 
|-
 
|-
|clientAddress
+
|device
|InetAddress
+
|DeviceTableEntry
|The client address
+
|The Device
 +
getKey
 
|-
 
|-
|clientProtocol
+
|key
 
|String
 
|String
|The client protocol
+
|The key
 +
getMacAddress
 
|-
 
|-
|clientUsername
+
|macAddress
 
|String
 
|String
|The client username
+
|The MAC address
|-
+
getOldValue
|elapsedTime
 
|String
 
|The elapsed time
 
|-
 
|eventId
 
|Long
 
|The event ID
 
|-
 
|netInterface
 
|String
 
|The net interface
 
 
|-
 
|-
|netProcess
+
|oldValue
 
|String
 
|String
|The net process
+
|The old value
|-
+
getPartitionTablePostfix
|netRXbytes
+
getTag
|Long
+
getTimeStamp
|The number of RX (received) bytes
 
|-
 
|netTXbytes
 
|Long
 
|The number of TX (transmitted) bytes
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getValue
 +
|-
 +
|value
 +
|String
 +
|The value
 
|}
 
|}
<section end='VirtualUserEvent' />
+
<section end='DeviceTableEvent' />
  
  
== AlertEvent ==
+
== SettingsChangesEvent ==
<section begin='AlertEvent' />
+
<section begin='SettingsChangesEvent' />
  
These events are created by [[Reports]] and inserted to the [[Database_Schema#alerts|alerts]] table when an alert fires.
+
These events are created by the base system and inserted to the [[Database_Schema#settings_changes|settings_changes]] table when settings are changed.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 703: Line 932:
 
! Type
 
! Type
 
! Description
 
! Description
|-
+
getClass
|cause
 
|LogEvent
 
|The cause
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getHostname
 
|-
 
|-
|description
+
|hostname
 
|String
 
|String
|The description
+
|The hostname
 +
getPartitionTablePostfix
 +
getSettingsFile
 
|-
 
|-
|json
+
|settingsFile
|JSONObject
 
|The JSON string
 
|-
 
|summaryText
 
 
|String
 
|String
|The summary text
+
|The settings file
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getUsername
 +
|-
 +
|username
 +
|String
 +
|The username
 
|}
 
|}
<section end='AlertEvent' />
+
<section end='SettingsChangesEvent' />
  
  
== ConfigurationBackupEvent ==
+
== UserTableEvent ==
<section begin='ConfigurationBackupEvent' />
+
<section begin='UserTableEvent' />
  
These events are created by [[Configuration Backup]] and inserted to the [[Database_Schema#configuratio_backup_events|configuratio_backup_events]] table when a backup occurs.
+
These events are created by the base system and inserted to the [[Database_Schema#user_table_updates|user_table_updates]] table when the user table is modified.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 740: Line 972:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getKey
 
|-
 
|-
|destination
+
|key
 
|String
 
|String
|The destination
+
|The key
 +
getOldValue
 
|-
 
|-
|detail
+
|oldValue
 
|String
 
|String
|The details
+
|The old value
|-
+
getPartitionTablePostfix
|success
+
getTag
|boolean
+
getTimeStamp
|True if successful, false otherwise
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getUsername
 +
|-
 +
|username
 +
|String
 +
|The username
 +
getValue
 +
|-
 +
|value
 +
|String
 +
|The value
 
|}
 
|}
<section end='ConfigurationBackupEvent' />
+
<section end='UserTableEvent' />
  
  
== WebCacheEvent ==
+
== SessionMinuteEvent ==
<section begin='WebCacheEvent' />
+
<section begin='SessionMinuteEvent' />
  
These events are created by [[Web Cache]] and inserted to the [[Database_Schema#web_cache_stats|web_cache_stats]] table periodically.
+
These events are created by the base system and update the [[Database_Schema#sessions|session_minutes]] table each minute a session exists.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 773: Line 1,017:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getC2sBytes
 
|-
 
|-
|bypassCount
+
|c2sBytes
 
|long
 
|long
|The number of bypasses
+
|The number of bytes sent from the client to the server
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getPartitionTablePostfix
 +
getS2cBytes
 
|-
 
|-
|hitBytes
+
|s2cBytes
 
|long
 
|long
|The number of bytes worth of hits
+
|The number of bytes sent from the server to the client
 +
getSessionId
 
|-
 
|-
|hitCount
+
|sessionId
 
|long
 
|long
|The number of hits
+
|The session ID
|-
+
getTag
|missBytes
+
getTimeStamp
|long
 
|The number of bytes worth of misses
 
|-
 
|missCount
 
|long
 
|The number of misses
 
|-
 
|policyId
 
|Long
 
|The policy ID
 
|-
 
|systemCount
 
|long
 
|The number of system bypasses
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 810: Line 1,045:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='WebCacheEvent' />
+
<section end='SessionMinuteEvent' />
  
  
== PrioritizeEvent ==
+
== SessionEvent ==
<section begin='PrioritizeEvent' />
+
<section begin='SessionEvent' />
  
These events are created by the [[Bandwidth Control]] and update the [[Database_Schema#sessions|session]] table when a session is prioritized.
+
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table each time a session is created.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 822: Line 1,057:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getCClientAddr
 
|-
 
|-
|class
+
|CClientAddr
|Class
+
|InetAddress
|The class name
+
|The client-side (pre-NAT) client address
 +
getCClientPort
 
|-
 
|-
|priority
+
|CClientPort
|int
+
|Integer
|The priority
+
|The client-side (pre-NAT) client port
 +
getCServerAddr
 
|-
 
|-
|ruleId
+
|CServerAddr
|int
+
|InetAddress
|The rule ID
+
|The client-side (pre-NAT) server address
 +
getCServerPort
 
|-
 
|-
|sessionEvent
+
|CServerPort
|SessionEvent
+
|Integer
|The session event
+
|The client-side (pre-NAT) server port
 +
getSClientAddr
 
|-
 
|-
|timeStamp
+
|SClientAddr
|Timestamp
+
|InetAddress
|The timestamp
+
|The server-side (post-NAT) client address
|}
+
getSClientPort
<section end='PrioritizeEvent' />
+
|-
 
+
|SClientPort
 
+
|Integer
== HttpResponseEvent ==
+
|The server-side (post-NAT) client port
<section begin='HttpResponseEvent' />
+
getSServerAddr
 
+
|-
These events are created by HTTP subsystem and update the [[Database_Schema#http_events|http_events]] table when a web response happens.
+
|SServerAddr
 
+
|InetAddress
{| border="1" cellpadding="2" width="90%" align="center"
+
|The server-side (post-NAT) server address
! Attribute Name
+
getSServerPort
! Type
+
|-
! Description
+
|SServerPort
 +
|Integer
 +
|The server-side (post-NAT) server port
 +
getBypassed
 +
|-
 +
|bypassed
 +
|boolean
 +
|True if bypassed, false otherwise
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientCountry
 
|-
 
|-
|contentLength
+
|clientCountry
|long
 
|The content length
 
|-
 
|contentType
 
 
|String
 
|String
|The content type
+
|The client country
 +
getClientIntf
 
|-
 
|-
|httpRequestEvent
+
|clientIntf
|HttpRequestEvent
+
|Integer
|The corresponding HTTP request event
+
|The client interface ID
 +
getClientLatitude
 
|-
 
|-
|requestLine
+
|clientLatitude
|RequestLine
+
|Double
|The request line
+
|The client latitude
 +
getClientLongitude
 
|-
 
|-
|timeStamp
+
|clientLongitude
|Timestamp
+
|Double
|The timestamp
+
|The client longitude
|}
+
getEntitled
<section end='HttpResponseEvent' />
 
 
 
 
 
== HttpRequestEvent ==
 
<section begin='HttpRequestEvent' />
 
 
 
These events are created by HTTP subsystem and inserted to the [[Database_Schema#http_events|http_events]] table when a web request happens.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
 
|-
 
|-
|class
+
|entitled
|Class
+
|boolean
|The class name
+
|The entitled status
 +
getFilterPrefix
 
|-
 
|-
|contentLength
+
|filterPrefix
|long
+
|String
|The content length
+
|The filter prefix if blocked by the filter rules
 +
getHostname
 
|-
 
|-
|domain
+
|hostname
 
|String
 
|String
|The domain
+
|The hostname
 +
getIcmpType
 +
|-
 +
|icmpType
 +
|Short
 +
|The ICMP type
 +
getLocalAddr
 
|-
 
|-
|host
+
|localAddr
|String
+
|InetAddress
|The host
+
|The local host address
 +
getPartitionTablePostfix
 +
getPolicyId
 
|-
 
|-
|method
+
|policyId
|HttpMethod
+
|Integer
|The HTTP method
+
|The policy ID
 +
getPolicyRuleId
 
|-
 
|-
|referer
+
|policyRuleId
|String
+
|Integer
|The referer
+
|The policy rule ID
 +
getProtocol
 
|-
 
|-
|requestId
+
|protocol
|Long
+
|Short
|The request ID
+
|The protocol
 +
getProtocolName
 
|-
 
|-
|requestUri
+
|protocolName
|URI
+
|String
|The request URI
+
|The protocol name
 +
getRemoteAddr
 
|-
 
|-
|sessionEvent
+
|remoteAddr
|SessionEvent
+
|InetAddress
|The session event
+
|The remote host address
 +
getServerCountry
 
|-
 
|-
|timeStamp
+
|serverCountry
|Timestamp
+
|String
|The timestamp
+
|The server country
|}
+
getServerIntf
<section end='HttpRequestEvent' />
 
 
 
 
 
== ApplicationControlLiteEvent ==
 
<section begin='ApplicationControlLiteEvent' />
 
 
 
These events are created by [[Application Control Lite]] and update the [[Database_Schema#sessions|sessions]] table when application control lite identifies a session.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
 
|-
 
|-
|blocked
+
|serverIntf
|boolean
+
|Integer
|True if blocked, false otherwise
+
|The server interface ID
 +
getServerLatitude
 
|-
 
|-
|class
+
|serverLatitude
|Class
+
|Double
|The class name
+
|The server latitude
 +
getServerLongitude
 
|-
 
|-
|protocol
+
|serverLongitude
|String
+
|Double
|The protocol
+
|The server longitude
 +
getSessionId
 
|-
 
|-
 
|sessionId
 
|sessionId
 
|Long
 
|Long
 
|The session ID
 
|The session ID
 +
getTag
 +
getTagsString
 +
|-
 +
|tagsString
 +
|String
 +
|The string value of all tags
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getUsername
 +
|-
 +
|username
 +
|String
 +
|The username
 
|}
 
|}
<section end='ApplicationControlLiteEvent' />
+
<section end='SessionEvent' />
  
  
== FirewallEvent ==
+
== SessionStatsEvent ==
<section begin='FirewallEvent' />
+
<section begin='SessionStatsEvent' />
  
These events are created by [[Firewall]] and update the [[Database_Schema#sessions|sessions]] table when a firewall rule matches a session.
+
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table when a session ends with the updated stats.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 978: Line 1,232:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getC2pBytes
 
|-
 
|-
|blocked
+
|c2pBytes
|boolean
+
|long
|True if blocked, false otherwise
+
|The number of bytes sent from the client to Untangle
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getEndTime
 +
|-
 +
|endTime
 +
|long
 +
|The end time/date
 +
getP2cBytes
 +
|-
 +
|p2cBytes
 +
|long
 +
|The number of bytes sent to the client from Untangle
 +
getP2sBytes
 
|-
 
|-
|flagged
+
|p2sBytes
|boolean
+
|long
|True if flagged, false otherwise
+
|The number of bytes sent to the server from Untangle
 +
getPartitionTablePostfix
 +
getS2pBytes
 
|-
 
|-
|ruleId
+
|s2pBytes
 
|long
 
|long
|The rule ID
+
|The number of bytes sent from the server to Untangle
 +
getSessionEvent
 +
|-
 +
|sessionEvent
 +
|SessionEvent
 +
|The session event
 +
getSessionId
 
|-
 
|-
 
|sessionId
 
|sessionId
 
|Long
 
|Long
 
|The session ID
 
|The session ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,003: Line 1,280:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='FirewallEvent' />
+
<section end='SessionStatsEvent' />
  
  
== WebFilterQueryEvent ==
+
== SessionNatEvent ==
<section begin='WebFilterQueryEvent' />
+
<section begin='SessionNatEvent' />
  
These events are created by [[Web Filter]] and inserted to the [[Database_Schema#http_query_events|http_query_events]] table when web filter processes a search engine search.
+
These events are created by the base system and update the [[Database_Schema#sessions|sessions]] table each time a session is NATd with the post-NAT information.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,015: Line 1,292:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getSClientAddr
 +
|-
 +
|SClientAddr
 +
|InetAddress
 +
|The server-side (post-NAT) client address
 +
getSClientPort
 +
|-
 +
|SClientPort
 +
|Integer
 +
|The server-side (post-NAT) client port
 +
getSServerAddr
 +
|-
 +
|SServerAddr
 +
|InetAddress
 +
|The server-side (post-NAT) server address
 +
getSServerPort
 +
|-
 +
|SServerPort
 +
|Integer
 +
|The server-side (post-NAT) server port
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getPartitionTablePostfix
 +
getServerIntf
 
|-
 
|-
|contentLength
+
|serverIntf
|long
+
|Integer
|The content length
+
|The server interface ID
 +
getSessionEvent
 
|-
 
|-
|host
+
|sessionEvent
|String
+
|SessionEvent
|The host
+
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|method
+
|timeStamp
|HttpMethod
+
|Timestamp
|The method
+
|The timestamp
|-
 
|nodeName
 
|String
 
|The name of the application
 
|-
 
|requestId
 
|Long
 
|The request ID
 
|-
 
|requestUri
 
|URI
 
|The request URI
 
|-
 
|sessionEvent
 
|SessionEvent
 
|The session event
 
|-
 
|term
 
|String
 
|The search term/phrase
 
|-
 
|timeStamp
 
|Timestamp
 
|The timestamp
 
 
|}
 
|}
<section end='WebFilterQueryEvent' />
+
<section end='SessionNatEvent' />
  
  
== WebFilterEvent ==
+
== QuotaEvent ==
<section begin='WebFilterEvent' />
+
<section begin='QuotaEvent' />
  
These events are created by [[Web Filter]] and update the [[Database_Schema#http_events|http_events]] table when web filter processes a web request.
+
These events are created by the [[Bandwidth Control]] and inserted or update the [[Database_Schema#quotas|quotas]] table when quotas are given or exceeded.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,068: Line 1,347:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAction
 
|-
 
|-
|blocked
+
|action
|Boolean
+
|int
|True if blocked, false otherwise
+
|The action (1=Quota Given, 2=Quota Exceeded)
|-
+
getClass
|category
 
|String
 
|The category
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getEntity
 
|-
 
|-
|flagged
+
|entity
|Boolean
+
|String
|True if flagged, false otherwise
+
|The entity
 +
getPartitionTablePostfix
 +
getQuotaSize
 
|-
 
|-
|nodeName
+
|quotaSize
|String
+
|long
|The name of the application
+
|The quota size
 +
getReason
 
|-
 
|-
 
|reason
 
|reason
|Reason
+
|String
 
|The reason
 
|The reason
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,097: Line 1,380:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='WebFilterEvent' />
+
<section end='QuotaEvent' />
  
  
== ApplicationControlLogEvent ==
+
== SmtpMessageAddressEvent ==
<section begin='ApplicationControlLogEvent' />
+
<section begin='SmtpMessageAddressEvent' />
  
These events are created by [[Application Control]] and update the [[Database_Schema#sessions|sessions]] table when application control identifies a session.
+
These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_addrs|mail_addrs]] table for each address on each email.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,109: Line 1,392:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAddr
 
|-
 
|-
|application
+
|addr
 
|String
 
|String
|The application
+
|The address
|-
+
getClass
|blocked
 
|boolean
 
|True if blocked, false otherwise
 
|-
 
|category
 
|String
 
|The category
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getKind
 
|-
 
|-
|confidence
+
|kind
|Integer
+
|AddressKind
|The confidence (0-100)
+
|The type for this address (F=From, T=To, C=CC, G=Envelope From, B=Envelope To, X=Unknown)
 +
getMessageId
 
|-
 
|-
|detail
+
|messageId
|String
+
|Long
|The details
+
|The message ID
 +
getPartitionTablePostfix
 +
getPersonal
 
|-
 
|-
|flagged
+
|personal
|boolean
 
|True if flagged, false otherwise
 
|-
 
|protochain
 
 
|String
 
|String
|The protochain
+
|personal
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|ruleId
+
|timeStamp
|Integer
+
|Timestamp
|The rule ID
 
|-
 
|sessionEvent
 
|SessionEvent
 
|The session event
 
|-
 
|state
 
|Integer
 
|The state
 
|-
 
|timeStamp
 
|Timestamp
 
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='ApplicationControlLogEvent' />
+
<section end='SmtpMessageAddressEvent' />
  
  
== SslInspectorLogEvent ==
+
== SmtpMessageEvent ==
<section begin='SslInspectorLogEvent' />
+
<section begin='SmtpMessageEvent' />
  
These events are created by [[SSL Inspector]] and update the [[Database_Schema#sessions|sessions]] table when a session is processed by SSL Inspector.
+
These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_msgs|mail_msgs]] table for each email.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,170: Line 1,437:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAddresses
 +
|-
 +
|addresses
 +
|Set
 +
|The addresses
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getEnvelopeFromAddress
 
|-
 
|-
|detail
+
|envelopeFromAddress
 
|String
 
|String
|The details
+
|The envelop FROM address
 +
getEnvelopeToAddress
 
|-
 
|-
|ruleId
+
|envelopeToAddress
|Integer
+
|String
|The rule ID
+
|The envelope TO address
 +
getMessageId
 +
|-
 +
|messageId
 +
|Long
 +
|The message ID
 +
getPartitionTablePostfix
 +
getReceiver
 +
|-
 +
|receiver
 +
|String
 +
|The receiver
 +
getSender
 +
|-
 +
|sender
 +
|String
 +
|The sender
 +
getSessionEvent
 
|-
 
|-
 
|sessionEvent
 
|sessionEvent
 
|SessionEvent
 
|SessionEvent
 
|The session event
 
|The session event
 +
getSessionId
 +
|-
 +
|sessionId
 +
|Long
 +
|The session ID
 +
getSubject
 
|-
 
|-
|status
+
|subject
 
|String
 
|String
|The status
+
|The subject
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getTmpFile
 +
|-
 +
|tmpFile
 +
|File
 +
|The /tmp file
 
|}
 
|}
<section end='SslInspectorLogEvent' />
+
<section end='SmtpMessageEvent' />
  
  
== SpamSmtpTarpitEvent ==
+
== CaptureRuleEvent ==
<section begin='SpamSmtpTarpitEvent' />
+
<section begin='CaptureRuleEvent' />
  
These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted.
+
These events are created by [[Captive Portal]] and update the [[Database_Schema#sessions|sessions]] table when Captive Portal processes a session.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,207: Line 1,512:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getCaptured
 
|-
 
|-
|iPAddr
+
|captured
|InetAddress
+
|boolean
|The IP address
+
|True if captured, false otherwise
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getPartitionTablePostfix
 +
getRuleId
 
|-
 
|-
|hostname
+
|ruleId
|String
+
|Integer
|The hostname
+
|The rule ID
 +
getSessionEvent
 
|-
 
|-
 
|sessionEvent
 
|sessionEvent
 
|SessionEvent
 
|SessionEvent
 
|The session event
 
|The session event
|-
+
getTag
|sessionId
+
getTimeStamp
|Long
 
|The session ID
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|vendorName
 
|String
 
|The application name
 
 
|}
 
|}
<section end='SpamSmtpTarpitEvent' />
+
<section end='CaptureRuleEvent' />
  
  
== SpamLogEvent ==
+
== CaptivePortalUserEvent ==
<section begin='SpamLogEvent' />
+
<section begin='CaptivePortalUserEvent' />
  
These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned.
+
These events are created by [[Captive Portal]] and inserted to the [[Database_Schema#captive_portal_user_events|captive_portal_user_events]] table when Captive Portal user takes an action.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,248: Line 1,552:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAuthenticationType
 
|-
 
|-
|action
+
|authenticationType
|SpamMessageAction
+
|CaptivePortalSettings$AuthenticationType
|The action
+
|The authentication type
 +
getAuthenticationTypeValue
 +
|-
 +
|authenticationTypeValue
 +
|String
 +
|The authentication type as a string
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientAddr
 
|-
 
|-
 
|clientAddr
 
|clientAddr
|InetAddress
+
|String
 
|The client address
 
|The client address
 +
getEvent
 
|-
 
|-
|clientPort
+
|event
|int
+
|CaptivePortalUserEvent$EventType
|The client port
+
|The event (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)
 +
getEventValue
 
|-
 
|-
|messageId
+
|eventValue
|Long
+
|String
|The message ID
+
|The event value as a string (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)
 +
getLoginName
 
|-
 
|-
|receiver
+
|loginName
 
|String
 
|String
|The receiver
+
|The login name
 +
getPartitionTablePostfix
 +
getPolicyId
 
|-
 
|-
|score
+
|policyId
|float
+
|Integer
|The score
+
|The policy ID
|-
+
getTag
|sender
+
getTimeStamp
|String
 
|The sender
 
|-
 
|serverAddr
 
|InetAddress
 
|The server address
 
|-
 
|serverPort
 
|int
 
|The server port
 
|-
 
|smtpMessageEvent
 
|SmtpMessageEvent
 
|The parent SMTP message event
 
|-
 
|isSpam
 
|boolean
 
|True if spam, false otherwise
 
|-
 
|subject
 
|String
 
|The subject
 
|-
 
|testsString
 
|String
 
|The tests string from the spam engine
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|vendorName
 
|String
 
|The application name
 
 
|}
 
|}
<section end='SpamLogEvent' />
+
<section end='CaptivePortalUserEvent' />
  
  
== SpamSmtpTarpitEvent ==
+
== AdBlockerEvent ==
<section begin='SpamSmtpTarpitEvent' />
+
<section begin='AdBlockerEvent' />
  
These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted.
+
These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when an ad is blocked.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,325: Line 1,612:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAction
 
|-
 
|-
|iPAddr
+
|action
|InetAddress
+
|Action
|The IP address
+
|The action
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getPartitionTablePostfix
 +
getReason
 
|-
 
|-
|hostname
+
|reason
 
|String
 
|String
|The hostname
+
|The reason
 +
getRequestId
 
|-
 
|-
|sessionEvent
+
|requestId
|SessionEvent
 
|The session event
 
|-
 
|sessionId
 
 
|Long
 
|Long
|The session ID
+
|The request ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|vendorName
 
|String
 
|The application name
 
 
|}
 
|}
<section end='SpamSmtpTarpitEvent' />
+
<section end='AdBlockerEvent' />
  
  
== SpamLogEvent ==
+
== CookieEvent ==
<section begin='SpamLogEvent' />
+
<section begin='CookieEvent' />
  
These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned.
+
These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when a cookie is blocked.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,366: Line 1,652:
 
! Type
 
! Type
 
! Description
 
! Description
|-
+
getClass
|action
 
|SpamMessageAction
 
|The action
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getIdentification
 
|-
 
|-
|clientAddr
+
|identification
|InetAddress
+
|String
|The client address
+
|The identification string
 +
getPartitionTablePostfix
 +
getRequestId
 
|-
 
|-
|clientPort
+
|requestId
|int
 
|The client port
 
|-
 
|messageId
 
 
|Long
 
|Long
|The message ID
+
|The request ID
 +
getSessionEvent
 
|-
 
|-
|receiver
+
|sessionEvent
|String
+
|SessionEvent
|The receiver
+
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|score
+
|timeStamp
|float
+
|Timestamp
|The score
+
|The timestamp
 +
|}
 +
<section end='CookieEvent' />
 +
 
 +
 
 +
== HttpRequestEvent ==
 +
<section begin='HttpRequestEvent' />
 +
 
 +
These events are created by HTTP subsystem and inserted to the [[Database_Schema#http_events|http_events]] table when a web request happens.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getContentLength
 +
|-
 +
|contentLength
 +
|long
 +
|The content length
 +
getDomain
 
|-
 
|-
|sender
+
|domain
 
|String
 
|String
|The sender
+
|The domain
 +
getHost
 
|-
 
|-
|serverAddr
+
|host
|InetAddress
+
|String
|The server address
+
|The host
|-
+
getMethod
|serverPort
 
|int
 
|The server port
 
 
|-
 
|-
|smtpMessageEvent
+
|method
|SmtpMessageEvent
+
|HttpMethod
|The parent SMTP message event
+
|The HTTP method
 +
getPartitionTablePostfix
 +
getReferer
 
|-
 
|-
|isSpam
+
|referer
|boolean
 
|True if spam, false otherwise
 
|-
 
|subject
 
 
|String
 
|String
|The subject
+
|The referer
 +
getRequestId
 
|-
 
|-
|testsString
+
|requestId
|String
+
|Long
|The tests string from the spam engine
+
|The request ID
 +
getRequestUri
 
|-
 
|-
|timeStamp
+
|requestUri
|Timestamp
+
|URI
|The timestamp
+
|The request URI
 +
getSessionEvent
 
|-
 
|-
|vendorName
+
|sessionEvent
|String
+
|SessionEvent
|The application name
+
|The session event
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 
|}
 
|}
<section end='SpamLogEvent' />
+
<section end='HttpRequestEvent' />
  
  
== CookieEvent ==
+
== HttpResponseEvent ==
<section begin='CookieEvent' />
+
<section begin='HttpResponseEvent' />
  
These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when a cookie is blocked.
+
These events are created by HTTP subsystem and update the [[Database_Schema#http_events|http_events]] table when a web response happens.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,443: Line 1,757:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getContentFilename
 
|-
 
|-
|identification
+
|contentFilename
 
|String
 
|String
|The identification string
+
|The content filename
 +
getContentLength
 
|-
 
|-
|requestId
+
|contentLength
|Long
+
|long
|The request ID
+
|The content length
 +
getContentType
 
|-
 
|-
|sessionEvent
+
|contentType
|SessionEvent
+
|String
|The session event
+
|The content type
 +
getHttpRequestEvent
 +
|-
 +
|httpRequestEvent
 +
|HttpRequestEvent
 +
|The corresponding HTTP request event
 +
getPartitionTablePostfix
 +
getRequestLine
 +
|-
 +
|requestLine
 +
|RequestLine
 +
|The request line
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,464: Line 1,795:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='CookieEvent' />
+
<section end='HttpResponseEvent' />
  
  
== AdBlockerEvent ==
+
== WebCacheEvent ==
<section begin='AdBlockerEvent' />
+
<section begin='WebCacheEvent' />
  
These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when an ad is blocked.
+
These events are created by [[Web Cache]] and inserted to the [[Database_Schema#web_cache_stats|web_cache_stats]] table periodically.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,476: Line 1,807:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getBypassCount
 
|-
 
|-
|action
+
|bypassCount
|Action
+
|long
|The action
+
|The number of bypasses
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getHitBytes
 
|-
 
|-
|reason
+
|hitBytes
|String
+
|long
|The reason
+
|The number of bytes worth of hits
 +
getHitCount
 
|-
 
|-
|requestId
+
|hitCount
|Long
+
|long
|The request ID
+
|The number of hits
 +
getMissBytes
 +
|-
 +
|missBytes
 +
|long
 +
|The number of bytes worth of misses
 +
getMissCount
 +
|-
 +
|missCount
 +
|long
 +
|The number of misses
 +
getPartitionTablePostfix
 +
getPolicyId
 +
|-
 +
|policyId
 +
|Long
 +
|The policy ID
 +
getSystemCount
 +
|-
 +
|systemCount
 +
|long
 +
|The number of system bypasses
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,497: Line 1,855:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='AdBlockerEvent' />
+
<section end='WebCacheEvent' />
  
  
== IntrusionPreventionLogEvent ==
+
== TunnelVpnStatusEvent ==
<section begin='IntrusionPreventionLogEvent' />
+
<section begin='TunnelVpnStatusEvent' />
  
These events are created by [[Intrusion Prevention]] and inserted to the [[Database_Schema#intrusion_prevention_events|intrusion_prevention_events]] table when a rule matches.
+
These events are created by [[Tunnel VPN]] and inserted to the [[Database_Schema#tunnel_vpn_stats|tunnel_vpn_stats]] table periodically.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,509: Line 1,867:
 
! Type
 
! Type
 
! Description
 
! Description
|-
+
getClass
|blocked
 
|short
 
|1 if blocked, 0 otherwise
 
|-
 
|category
 
|String
 
|The category
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getInBytes
 
|-
 
|-
|classificationId
+
|inBytes
 
|long
 
|long
|The classification ID
+
|The number of bytes received from this tunnel
 +
getOutBytes
 
|-
 
|-
|classtype
+
|outBytes
|String
 
|The classtype
 
|-
 
|dportIcode
 
|int
 
|The dportIcode
 
|-
 
|eventId
 
 
|long
 
|long
|The event ID
+
|The number of bytes sent in this tunnel
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|eventMicrosecond
+
|timeStamp
|long
+
|Timestamp
|The event microsecond
+
|The timestamp
 +
getTunnelName
 
|-
 
|-
|eventSecond
+
|tunnelName
|long
+
|String
|The event second
+
|The name of this tunnel
 +
|}
 +
<section end='TunnelVpnStatusEvent' />
 +
 
 +
 
 +
== TunnelVpnEvent ==
 +
<section begin='TunnelVpnEvent' />
 +
 
 +
These events are created by [[Tunnel VPN]] and inserted to the [[Database_Schema#tunnel_vpn_events|tunnel_vpn_events]] table when a tunnel connection event occurs.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getEventType
 
|-
 
|-
 
|eventType
 
|eventType
|long
+
|TunnelVpnEvent$EventType
 
|The event type
 
|The event type
 +
getLocalAddress
 
|-
 
|-
|generatorId
+
|localAddress
|long
 
|The generator ID
 
|-
 
|impact
 
|short
 
|The impact
 
|-
 
|impactFlag
 
|short
 
|The impact flag
 
|-
 
|ipDestination
 
 
|InetAddress
 
|InetAddress
|The IP address destination
+
|The local host address
 +
getPartitionTablePostfix
 +
getServerAddress
 
|-
 
|-
|ipSource
+
|serverAddress
 
|InetAddress
 
|InetAddress
|The IP address source
+
|The server address
 +
getTag
 +
getTimeStamp
 
|-
 
|-
|mplsLabel
+
|timeStamp
|long
+
|Timestamp
|The mplsLabel
+
|The timestamp
 +
getTunnelName
 
|-
 
|-
|msg
+
|tunnelName
 
|String
 
|String
|The msg
+
|The name of this tunnel
 +
|}
 +
<section end='TunnelVpnEvent' />
 +
 
 +
 
 +
== IntrusionPreventionLogEvent ==
 +
<section begin='IntrusionPreventionLogEvent' />
 +
 
 +
These events are created by [[Intrusion Prevention]] and inserted to the [[Database_Schema#intrusion_prevention_events|intrusion_prevention_events]] table when a rule matches.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getBlocked
 +
|-
 +
|blocked
 +
|boolean
 +
|True if blocked, false otherwise
 +
getCategory
 
|-
 
|-
|padding
+
|category
|int
+
|String
|The padding
+
|The category
 +
getClass
 
|-
 
|-
|priorityId
+
|class
|long
+
|Class
|The priority ID
+
|The class name
 +
getClassificationId
 
|-
 
|-
|protocol
+
|classificationId
|short
+
|long
|The protocol
+
|The classification ID
 +
getClasstype
 +
|-
 +
|classtype
 +
|String
 +
|The classtype
 +
getDportIcode
 +
|-
 +
|dportIcode
 +
|int
 +
|The dportIcode
 +
getEventId
 
|-
 
|-
|sensorId
+
|eventId
 
|long
 
|long
|The sensor ID
+
|The event ID
 +
getEventMicrosecond
 
|-
 
|-
|signatureId
+
|eventMicrosecond
 
|long
 
|long
|The signature ID
+
|The event microsecond
 +
getEventSecond
 
|-
 
|-
|signatureRevision
+
|eventSecond
 
|long
 
|long
|The signature revision
+
|The event second
 +
getEventType
 
|-
 
|-
|sportItype
+
|eventType
|int
+
|long
|The sportItype
+
|The event type
 +
getGeneratorId
 
|-
 
|-
|timeStamp
+
|generatorId
|Timestamp
+
|long
|The timestamp
+
|The generator ID
 +
getImpact
 
|-
 
|-
|vlanId
+
|impact
|int
+
|short
|The VLAN Id
+
|The impact
|}
+
getImpactFlag
<section end='IntrusionPreventionLogEvent' />
 
 
 
 
 
== WanFailoverTestEvent ==
 
<section begin='WanFailoverTestEvent' />
 
 
 
These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_test_events|wan_failover_test_events]] table when a test is run.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
 
|-
 
|-
|class
+
|impactFlag
|Class
+
|short
|The class name
+
|The impact flag
 +
getIpDestination
 
|-
 
|-
|description
+
|ipDestination
 +
|InetAddress
 +
|The IP address destination
 +
getIpSource
 +
|-
 +
|ipSource
 +
|InetAddress
 +
|The IP address source
 +
getMplsLabel
 +
|-
 +
|mplsLabel
 +
|long
 +
|The mplsLabel
 +
getMsg
 +
|-
 +
|msg
 
|String
 
|String
|The description
+
|The msg
 +
getPadding
 
|-
 
|-
|interfaceId
+
|padding
 
|int
 
|int
|The interface ID
+
|The padding
 +
getPartitionTablePostfix
 +
getPriorityId
 +
|-
 +
|priorityId
 +
|long
 +
|The priority ID
 +
getProtocol
 
|-
 
|-
|name
+
|protocol
|String
+
|short
|The test name
+
|The protocol
 +
getRid
 
|-
 
|-
|osName
+
|rid
 
|String
 
|String
|The O/S interface name
+
|Rule ID
 +
getSensorId
 
|-
 
|-
|success
+
|sensorId
|Boolean
+
|long
|True if successful, false otherwise
+
|The sensor ID
 +
getSignatureId
 +
|-
 +
|signatureId
 +
|long
 +
|The signature ID
 +
getSignatureRevision
 +
|-
 +
|signatureRevision
 +
|long
 +
|The signature revision
 +
getSportItype
 +
|-
 +
|sportItype
 +
|int
 +
|The sportItype
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getVlanId
 +
|-
 +
|vlanId
 +
|int
 +
|The VLAN Id
 
|}
 
|}
<section end='WanFailoverTestEvent' />
+
<section end='IntrusionPreventionLogEvent' />
  
  
== WanFailoverEvent ==
+
== ApplicationControlLogEvent ==
<section begin='WanFailoverEvent' />
+
<section begin='ApplicationControlLogEvent' />
  
These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_action_events|wan_failover_action_events]] table when WAN Failover takes an action.
+
These events are created by [[Application Control]] and update the [[Database_Schema#sessions|sessions]] table when application control identifies a session.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,667: Line 2,102:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getApplication
 
|-
 
|-
|action
+
|application
|WanFailoverEvent$Action
+
|String
|The action
+
|The application
 +
getBlocked
 +
|-
 +
|blocked
 +
|boolean
 +
|True if blocked, false otherwise
 +
getCategory
 +
|-
 +
|category
 +
|String
 +
|The category
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getConfidence
 
|-
 
|-
|interfaceId
+
|confidence
|int
+
|Integer
|The interface ID
+
|The confidence (0-100)
 +
getDetail
 
|-
 
|-
|name
+
|detail
 
|String
 
|String
|The name
+
|The details
 +
getFlagged
 +
|-
 +
|flagged
 +
|boolean
 +
|True if flagged, false otherwise
 +
getPartitionTablePostfix
 +
getProtochain
 
|-
 
|-
|osName
+
|protochain
 
|String
 
|String
|The O/S interface name
+
|The protochain
 +
getRuleId
 
|-
 
|-
|timeStamp
+
|ruleId
|Timestamp
+
|Integer
 +
|The rule ID
 +
getSessionEvent
 +
|-
 +
|sessionEvent
 +
|SessionEvent
 +
|The session event
 +
getState
 +
|-
 +
|state
 +
|Integer
 +
|The state
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='WanFailoverEvent' />
+
<section end='ApplicationControlLogEvent' />
  
  
== CaptivePortalUserEvent ==
+
== LoginEvent ==
<section begin='CaptivePortalUserEvent' />
+
<section begin='LoginEvent' />
  
These events are created by [[Captive Portal]] and inserted to the [[Database_Schema#captive_portal_user_events|captive_portal_user_events]] table when Captive Portal user takes an action.
+
These events are created by [[Directory Connector]] and inserted to the [[Database_Schema#directory_connector_login_events|directory_connector_login_events]] table for each login.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,704: Line 2,177:
 
! Type
 
! Type
 
! Description
 
! Description
|-
+
getClass
|authenticationType
 
|CaptivePortalSettings$AuthenticationType
 
|The authentication type
 
|-
 
|authenticationTypeValue
 
|String
 
|The authentication type as a string
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientAddr
 
|-
 
|-
 
|clientAddr
 
|clientAddr
 
|InetAddress
 
|InetAddress
 
|The client address
 
|The client address
 +
getDomain
 +
|-
 +
|domain
 +
|String
 +
|The domain
 +
getEvent
 
|-
 
|-
 
|event
 
|event
|CaptivePortalUserEvent$EventType
 
|The event (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)
 
|-
 
|eventValue
 
 
|String
 
|String
|The event value as a string (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)
+
|The event
 +
getLoginName
 
|-
 
|-
 
|loginName
 
|loginName
 
|String
 
|String
 
|The login name
 
|The login name
 +
getLoginType
 
|-
 
|-
|policyId
+
|loginType
|Integer
+
|String
|The policy ID
+
|W = Windows login, A=Active Directory, R=RADIUS, T=test
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,741: Line 2,215:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='CaptivePortalUserEvent' />
+
<section end='LoginEvent' />
  
  
== CaptureRuleEvent ==
+
== WebFilterEvent ==
<section begin='CaptureRuleEvent' />
+
<section begin='WebFilterEvent' />
  
These events are created by [[Captive Portal]] and update the [[Database_Schema#sessions|sessions]] table when Captive Portal processes a session.
+
These events are created by [[Web Filter]] and update the [[Database_Schema#http_events|http_events]] table when web filter processes a web request.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,753: Line 2,227:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAppName
 
|-
 
|-
|captured
+
|appName
|boolean
+
|String
|True if captured, false otherwise
+
|The name of the application
 +
getBlocked
 
|-
 
|-
|class
+
|blocked
|Class
+
|Boolean
|The class name
+
|True if blocked, false otherwise
 +
getCategory
 
|-
 
|-
|ruleId
+
|category
 +
|String
 +
|The category
 +
getCategoryId
 +
|-
 +
|categoryId
 +
|Integer
 +
|Numeric value of matching category
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getFlagged
 +
|-
 +
|flagged
 +
|Boolean
 +
|True if flagged, false otherwise
 +
getPartitionTablePostfix
 +
getReason
 +
|-
 +
|reason
 +
|Reason
 +
|The reason
 +
getRequestLine
 +
|-
 +
|requestLine
 +
|RequestLine
 +
|The request line
 +
getRuleId
 +
|-
 +
|ruleId
 
|Integer
 
|Integer
 
|The rule ID
 
|The rule ID
 +
getSessionEvent
 
|-
 
|-
 
|sessionEvent
 
|sessionEvent
 
|SessionEvent
 
|SessionEvent
 
|The session event
 
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,774: Line 2,285:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='CaptureRuleEvent' />
+
<section end='WebFilterEvent' />
  
  
== VirusSmtpEvent ==
+
== WebFilterQueryEvent ==
<section begin='VirusSmtpEvent' />
+
<section begin='WebFilterQueryEvent' />
  
These events are created by [[Virus Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when Virus Blocker scans an email.
+
These events are created by [[Web Filter]] and inserted to the [[Database_Schema#http_query_events|http_query_events]] table when web filter processes a search engine search.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,786: Line 2,297:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAppName
 
|-
 
|-
|action
+
|appName
 
|String
 
|String
|The action
+
|The name of the application
 +
getBlocked
 +
|-
 +
|blocked
 +
|Boolean
 +
|True if blocked, false otherwise
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getContentLength
 
|-
 
|-
|clean
+
|contentLength
|boolean
+
|long
|True if clean, false otherwise
+
|The content length
 +
getFlagged
 
|-
 
|-
|messageId
+
|flagged
|Long
+
|Boolean
|The message ID
+
|True if flagged, false otherwise
 +
getHost
 
|-
 
|-
|nodeName
+
|host
 
|String
 
|String
|The name of the application
+
|The host
 +
getMethod
 +
|-
 +
|method
 +
|HttpMethod
 +
|The method
 +
getPartitionTablePostfix
 +
getRequestId
 
|-
 
|-
|timeStamp
+
|requestId
|Timestamp
+
|Long
|The timestamp
+
|The request ID
 +
getRequestUri
 
|-
 
|-
|virusName
+
|requestUri
|String
+
|URI
|The virus name, if not clean
+
|The request URI
 +
getSessionEvent
 +
|-
 +
|sessionEvent
 +
|SessionEvent
 +
|The session event
 +
getTag
 +
getTerm
 +
|-
 +
|term
 +
|String
 +
|The search term/phrase
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 
|}
 
|}
<section end='VirusSmtpEvent' />
+
<section end='WebFilterQueryEvent' />
  
  
== VirusFtpEvent ==
+
== WanFailoverTestEvent ==
<section begin='VirusFtpEvent' />
+
<section begin='WanFailoverTestEvent' />
  
These events are created by [[Virus Blocker]] and update the [[Database_Schema#ftp_events|ftp_events]] table when Virus Blocker scans an FTP transfer.
+
These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_test_events|wan_failover_test_events]] table when a test is run.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,827: Line 2,372:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getDescription
 
|-
 
|-
|clean
+
|description
|boolean
 
|True if clean, false otherwise
 
|-
 
|nodeName
 
 
|String
 
|String
|The name of the application
+
|The description
 +
getInterfaceId
 
|-
 
|-
|sessionEvent
+
|interfaceId
|SessionEvent
+
|int
|The session event
+
|The interface ID
 +
getName
 +
|-
 +
|name
 +
|String
 +
|The test name
 +
getOsName
 +
|-
 +
|osName
 +
|String
 +
|The O/S interface name
 +
getPartitionTablePostfix
 +
getSuccess
 +
|-
 +
|success
 +
|Boolean
 +
|True if successful, false otherwise
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|uri
 
|String
 
|The URI
 
|-
 
|virusName
 
|String
 
|The virus name, if not clean
 
 
|}
 
|}
<section end='VirusFtpEvent' />
+
<section end='WanFailoverTestEvent' />
  
  
== VirusHttpEvent ==
+
== WanFailoverEvent ==
<section begin='VirusHttpEvent' />
+
<section begin='WanFailoverEvent' />
  
These events are created by [[Virus Blocker]] and update the [[Database_Schema#http_events|http_events]] table when Virus Blocker scans an HTTP transfer.
+
These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_action_events|wan_failover_action_events]] table when WAN Failover takes an action.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,868: Line 2,422:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAction
 +
|-
 +
|action
 +
|WanFailoverEvent$Action
 +
|The action
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getInterfaceId
 
|-
 
|-
|clean
+
|interfaceId
|boolean
+
|int
|True if clean, false otherwise
+
|The interface ID
 +
getName
 
|-
 
|-
|nodeName
+
|name
 
|String
 
|String
|The name of the application
+
|The name
 +
getOsName
 
|-
 
|-
|requestId
+
|osName
|Long
+
|String
|The request ID
+
|The O/S interface name
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|virusName
 
|String
 
|The virus name, if not clean
 
 
|}
 
|}
<section end='VirusHttpEvent' />
+
<section end='WanFailoverEvent' />
  
  
== OpenVpnEvent ==
+
== ThreatPreventionEvent ==
<section begin='OpenVpnEvent' />
+
<section begin='ThreatPreventionEvent' />
  
These events are created by [[OpenVPN]] and update the [[Database_Schema#openvpn_events|openvpn_events]] table when OpenVPN processes a client action.
+
These events are created by [[Threat Prevention]] and inserted to the [[Database_Schema#sessions|sessions]] table for each threat lookup.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,905: Line 2,467:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getBlocked
 
|-
 
|-
|address
+
|blocked
|InetAddress
+
|boolean
|The address
+
|True if blocked, false otherwise
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientCategories
 +
|-
 +
|clientCategories
 +
|int
 +
|Client threat categories
 +
getClientReputation
 +
|-
 +
|clientReputation
 +
|int
 +
|Client threat reputation
 +
getFlagged
 +
|-
 +
|flagged
 +
|boolean
 +
|True if flagged, false otherwise
 +
getPartitionTablePostfix
 +
getRuleId
 +
|-
 +
|ruleId
 +
|long
 +
|The rule ID
 +
getServerCategories
 +
|-
 +
|serverCategories
 +
|int
 +
|Server threat categories
 +
getServerReputation
 
|-
 
|-
|clientName
+
|serverReputation
|String
+
|int
|The client name
+
|Server threat reputation
 +
getSessionId
 
|-
 
|-
|poolAddress
+
|sessionId
|InetAddress
+
|Long
|The pool address
+
|The session ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
|-
 
|type
 
|OpenVpnEvent$EventType
 
|The type
 
 
|}
 
|}
<section end='OpenVpnEvent' />
+
<section end='ThreatPreventionEvent' />
 +
 
  
 +
== ThreatPreventionHttpEvent ==
 +
<section begin='ThreatPreventionHttpEvent' />
  
== OpenVpnStatusEvent ==
+
These events are created by [[Threat Prevention]] and inserted to the [[Database_Schema#http_events|http_events]] table for each threat lookup.
<section begin='OpenVpnStatusEvent' />
 
 
 
These events are created by [[OpenVPN]] and update the [[Database_Schema#openvpn_stats|openvpn_stats]] table periodically.
 
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 1,942: Line 2,532:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getBlocked
 
|-
 
|-
|address
+
|blocked
|InetAddress
+
|Boolean
|The address
+
|True if blocked, false otherwise
 +
getCategories
 
|-
 
|-
|bytesRxDelta
+
|categories
|long
+
|Integer
|The delta number of RX (received) bytes from the previous event
+
|Server threat categories
|-
+
getClass
|bytesRxTotal
 
|long
 
|The total number of RX (received) bytes
 
|-
 
|bytesTxDelta
 
|long
 
|The delta number of TX (transmitted) bytes from the previous event
 
|-
 
|bytesTxTotal
 
|long
 
|The total number of TX (transmitted) bytes
 
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getFlagged
 
|-
 
|-
|clientName
+
|flagged
|String
+
|Boolean
|The client name
+
|True if flagged, false otherwise
 +
getPartitionTablePostfix
 +
getReputation
 
|-
 
|-
|end
+
|reputation
|Timestamp
+
|Integer
|The end
+
|Server threat reputation
 +
getRequestLine
 
|-
 
|-
|poolAddress
+
|requestLine
|InetAddress
+
|RequestLine
|The pool address
+
|The request line
 +
getRuleId
 
|-
 
|-
|port
+
|ruleId
|int
+
|Integer
|The port
+
|The rule ID
 +
getSessionEvent
 
|-
 
|-
|start
+
|sessionEvent
|Timestamp
+
|SessionEvent
|The start
+
|The session event
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
Line 1,991: Line 2,580:
 
|The timestamp
 
|The timestamp
 
|}
 
|}
<section end='OpenVpnStatusEvent' />
+
<section end='ThreatPreventionHttpEvent' />
  
  
== SmtpMessageAddressEvent ==
+
== SpamLogEvent ==
<section begin='SmtpMessageAddressEvent' />
+
<section begin='SpamLogEvent' />
  
These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_addrs|mail_addrs]] table for each address on each email.
+
These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 2,003: Line 2,592:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getAction
 
|-
 
|-
|addr
+
|action
|String
+
|SpamMessageAction
|The address
+
|The action
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getClientAddr
 +
|-
 +
|clientAddr
 +
|InetAddress
 +
|The client address
 +
getClientPort
 
|-
 
|-
|kind
+
|clientPort
|AddressKind
+
|int
|The type for this address (F=From, T=To, C=CC, G=Envelope From, B=Envelope To, X=Unknown)
+
|The client port
 +
getMessageId
 
|-
 
|-
 
|messageId
 
|messageId
 
|Long
 
|Long
 
|The message ID
 
|The message ID
 +
getPartitionTablePostfix
 +
getReceiver
 +
|-
 +
|receiver
 +
|String
 +
|The receiver
 +
getScore
 +
|-
 +
|score
 +
|float
 +
|The score
 +
getSender
 
|-
 
|-
|personal
+
|sender
 
|String
 
|String
|personal
+
|The sender
 +
getServerAddr
 
|-
 
|-
|timeStamp
+
|serverAddr
|Timestamp
+
|InetAddress
|The timestamp
+
|The server address
|}
+
getServerPort
<section end='SmtpMessageAddressEvent' />
+
|-
 
+
|serverPort
 
+
|int
== SmtpMessageEvent ==
+
|The server port
<section begin='SmtpMessageEvent' />
+
getSmtpMessageEvent
 
 
These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_msgs|mail_msgs]] table for each email.
 
 
 
{| border="1" cellpadding="2" width="90%" align="center"
 
! Attribute Name
 
! Type
 
! Description
 
 
|-
 
|-
|addresses
+
|smtpMessageEvent
|Set
+
|SmtpMessageEvent
|The addresses
+
|The parent SMTP message event
 +
isSpam
 
|-
 
|-
|class
+
|isSpam
|Class
+
|boolean
|The class name
+
|True if spam, false otherwise
 +
getSubject
 
|-
 
|-
|envelopeFromAddress
+
|subject
 
|String
 
|String
|The envelop FROM address
+
|The subject
 +
getTag
 +
getTestsString
 
|-
 
|-
|envelopeToAddress
+
|testsString
 
|String
 
|String
|The envelope TO address
+
|The tests string from the spam engine
|-
+
getTimeStamp
|messageId
 
|Long
 
|The message ID
 
|-
 
|receiver
 
|String
 
|The receiver
 
|-
 
|sender
 
|String
 
|The sender
 
|-
 
|sessionEvent
 
|SessionEvent
 
|The session event
 
|-
 
|sessionId
 
|Long
 
|The session ID
 
|-
 
|subject
 
|String
 
|The subject
 
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getVendorName
 
|-
 
|-
|tmpFile
+
|vendorName
|File
+
|String
|The /tmp file
+
|The application name
 
|}
 
|}
<section end='SmtpMessageEvent' />
+
<section end='SpamLogEvent' />
  
  
== LoginEvent ==
+
== SpamSmtpTarpitEvent ==
<section begin='LoginEvent' />
+
<section begin='SpamSmtpTarpitEvent' />
  
These events are created by [[Directory Connector]] and inserted to the [[Database_Schema#directory_connector_login_events|directory_connector_login_events]] table for each login.
+
These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted.
  
 
{| border="1" cellpadding="2" width="90%" align="center"
 
{| border="1" cellpadding="2" width="90%" align="center"
Line 2,101: Line 2,687:
 
! Type
 
! Type
 
! Description
 
! Description
 +
getIPAddr
 +
|-
 +
|IPAddr
 +
|InetAddress
 +
|The IP address
 +
getClass
 
|-
 
|-
 
|class
 
|class
 
|Class
 
|Class
 
|The class name
 
|The class name
 +
getHostname
 
|-
 
|-
|clientAddr
+
|hostname
|InetAddress
 
|The client address
 
|-
 
|domain
 
 
|String
 
|String
|The domain
+
|The hostname
 +
getPartitionTablePostfix
 +
getSessionEvent
 
|-
 
|-
|event
+
|sessionEvent
|String
+
|SessionEvent
|The event
+
|The session event
 +
getSessionId
 
|-
 
|-
|loginName
+
|sessionId
|String
+
|Long
|The login name
+
|The session ID
 +
getTag
 +
getTimeStamp
 
|-
 
|-
 
|timeStamp
 
|timeStamp
 
|Timestamp
 
|Timestamp
 
|The timestamp
 
|The timestamp
 +
getVendorName
 +
|-
 +
|vendorName
 +
|String
 +
|The application name
 
|}
 
|}
<section end='LoginEvent' />
+
<section end='SpamSmtpTarpitEvent' />
 +
 
 +
 
 +
== ConfigurationBackupEvent ==
 +
<section begin='ConfigurationBackupEvent' />
 +
 
 +
These events are created by [[Configuration Backup]] and inserted to the [[Database_Schema#configuratio_backup_events|configuratio_backup_events]] table when a backup occurs.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getDestination
 +
|-
 +
|destination
 +
|String
 +
|The destination
 +
getDetail
 +
|-
 +
|detail
 +
|String
 +
|The details
 +
getPartitionTablePostfix
 +
getSuccess
 +
|-
 +
|success
 +
|boolean
 +
|True if successful, false otherwise
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
|}
 +
<section end='ConfigurationBackupEvent' />
 +
 
 +
 
 +
== TunnelStatusEvent ==
 +
<section begin='TunnelStatusEvent' />
 +
 
 +
These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_tunnel_stats|ipsec_tunnel_stats]] table periodically.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getInBytes
 +
|-
 +
|inBytes
 +
|long
 +
|The number of bytes received from this tunnel
 +
getOutBytes
 +
|-
 +
|outBytes
 +
|long
 +
|The number of bytes sent in this tunnel
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
getTunnelName
 +
|-
 +
|tunnelName
 +
|String
 +
|The name of this tunnel
 +
|}
 +
<section end='TunnelStatusEvent' />
 +
 
 +
 
 +
== IpsecVpnEvent ==
 +
<section begin='IpsecVpnEvent' />
 +
 
 +
These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_vpn_events|ipsec_vpn_events]] table when IPsec connection event occurs.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getEventType
 +
|-
 +
|eventType
 +
|IpsecVpnEvent$EventType
 +
|The event type
 +
getLocalAddress
 +
|-
 +
|localAddress
 +
|String
 +
|The local host address
 +
getPartitionTablePostfix
 +
getRemoteAddress
 +
|-
 +
|remoteAddress
 +
|String
 +
|The remote host address
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
getTunnelDescription
 +
|-
 +
|tunnelDescription
 +
|String
 +
|Description of tunnel
 +
|}
 +
<section end='IpsecVpnEvent' />
 +
 
 +
 
 +
== VirtualUserEvent ==
 +
<section begin='VirtualUserEvent' />
 +
 
 +
These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_user_events|ipsec_user_events]] table when a user event occurs.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getClientAddress
 +
|-
 +
|clientAddress
 +
|InetAddress
 +
|The client address
 +
getClientProtocol
 +
|-
 +
|clientProtocol
 +
|String
 +
|The client protocol
 +
getClientUsername
 +
|-
 +
|clientUsername
 +
|String
 +
|The client username
 +
getElapsedTime
 +
|-
 +
|elapsedTime
 +
|String
 +
|The elapsed time
 +
getEventId
 +
|-
 +
|eventId
 +
|Long
 +
|The event ID
 +
getNetInterface
 +
|-
 +
|netInterface
 +
|String
 +
|The net interface
 +
getNetProcess
 +
|-
 +
|netProcess
 +
|String
 +
|The net process
 +
getNetRXbytes
 +
|-
 +
|netRXbytes
 +
|Long
 +
|The number of RX (received) bytes
 +
getNetTXbytes
 +
|-
 +
|netTXbytes
 +
|Long
 +
|The number of TX (transmitted) bytes
 +
getPartitionTablePostfix
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
|}
 +
<section end='VirtualUserEvent' />
 +
 
 +
 
 +
== SslInspectorLogEvent ==
 +
<section begin='SslInspectorLogEvent' />
 +
 
 +
These events are created by [[SSL Inspector]] and update the [[Database_Schema#sessions|sessions]] table when a session is processed by SSL Inspector.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getDetail
 +
|-
 +
|detail
 +
|String
 +
|The details
 +
getPartitionTablePostfix
 +
getRuleId
 +
|-
 +
|ruleId
 +
|Integer
 +
|The rule ID
 +
getSessionEvent
 +
|-
 +
|sessionEvent
 +
|SessionEvent
 +
|The session event
 +
getStatus
 +
|-
 +
|status
 +
|String
 +
|The status
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
|}
 +
<section end='SslInspectorLogEvent' />
 +
 
 +
 
 +
== ApplicationControlLiteEvent ==
 +
<section begin='ApplicationControlLiteEvent' />
 +
 
 +
These events are created by [[Application Control Lite]] and update the [[Database_Schema#sessions|sessions]] table when application control lite identifies a session.
 +
 
 +
{| border="1" cellpadding="2" width="90%" align="center"
 +
! Attribute Name
 +
! Type
 +
! Description
 +
getBlocked
 +
|-
 +
|blocked
 +
|boolean
 +
|True if blocked, false otherwise
 +
getClass
 +
|-
 +
|class
 +
|Class
 +
|The class name
 +
getPartitionTablePostfix
 +
getProtocol
 +
|-
 +
|protocol
 +
|String
 +
|The protocol
 +
getSessionId
 +
|-
 +
|sessionId
 +
|Long
 +
|The session ID
 +
getTag
 +
getTimeStamp
 +
|-
 +
|timeStamp
 +
|Timestamp
 +
|The timestamp
 +
|}
 +
<section end='ApplicationControlLiteEvent' />
 +
 
 +
 
 +
}

Latest revision as of 15:36, 9 February 2020

All event data is stored in the Database Schema in a relational database. As Untangle and applications process traffic they create Event objects that add and modify content in the database. Each event has it's own class/object with certain fields that modify the database in a certain way.

The list below shows the classes used in the event logging and the attributes of each event object. These can be used to add alerts in Reports or for other event handling within Untangle.

SpamLogEvent


These events are created by Spam Blocker and update the mail_msgs table when an email is scanned.

Attribute Name Type Description

getAction

action SpamMessageAction The action

getClass

class Class The class name

getClientAddr

clientAddr InetAddress The client address

getClientPort

clientPort int The client port

getMessageId

messageId Long The message ID

getPartitionTablePostfix getReceiver

receiver String The receiver

getScore

score float The score

getSender

sender String The sender

getServerAddr

serverAddr InetAddress The server address

getServerPort

serverPort int The server port

getSmtpMessageEvent

smtpMessageEvent SmtpMessageEvent The parent SMTP message event

isSpam

isSpam boolean True if spam, false otherwise

getSubject

subject String The subject

getTag getTestsString

testsString String The tests string from the spam engine

getTimeStamp

timeStamp Timestamp The timestamp

getVendorName

vendorName String The application name


SpamSmtpTarpitEvent


These events are created by Spam Blocker and inserted to the smtp_tarpit_events table when a session is tarpitted.

Attribute Name Type Description

getIPAddr

IPAddr InetAddress The IP address

getClass

class Class The class name

getHostname

hostname String The hostname

getPartitionTablePostfix getSessionEvent

sessionEvent SessionEvent The session event

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp

getVendorName

vendorName String The application name


PrioritizeEvent


These events are created by the Bandwidth Control and update the session table when a session is prioritized.

Attribute Name Type Description

getClass

class Class The class name

getPartitionTablePostfix getPriority

priority int The priority

getRuleId

ruleId int The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


VirusFtpEvent


These events are created by Virus Blocker and update the ftp_events table when Virus Blocker scans an FTP transfer.

Attribute Name Type Description

getAppName

appName String The name of the application

getClass

class Class The class name

getClean

clean boolean True if clean, false otherwise

getPartitionTablePostfix getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp

getUri

uri String The URI

getVirusName

virusName String The virus name, if not clean


VirusHttpEvent


These events are created by Virus Blocker and update the http_events table when Virus Blocker scans an HTTP transfer.

Attribute Name Type Description

getAppName

appName String The name of the application

getClass

class Class The class name

getClean

clean boolean True if clean, false otherwise

getPartitionTablePostfix getRequestLine

requestLine RequestLine The request line

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp

getVirusName

virusName String The virus name, if not clean


VirusSmtpEvent


These events are created by Virus Blocker and update the mail_msgs table when Virus Blocker scans an email.

Attribute Name Type Description

getAction

action String The action

getAppName

appName String The name of the application

getClass

class Class The class name

getClean

clean boolean True if clean, false otherwise

getMessageId

messageId Long The message ID

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getVirusName

virusName String The virus name, if not clean


FirewallEvent


These events are created by Firewall and update the sessions table when a firewall rule matches a session.

Attribute Name Type Description

getBlocked

blocked boolean True if blocked, false otherwise

getClass

class Class The class name

getFlagged

flagged boolean True if flagged, false otherwise

getPartitionTablePostfix getRuleId

ruleId long The rule ID

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


OpenVpnStatusEvent


These events are created by OpenVPN and update the openvpn_stats table periodically.

Attribute Name Type Description

getAddress

address InetAddress The address

getBytesRxDelta

bytesRxDelta long The delta number of RX (received) bytes from the previous event

getBytesRxTotal

bytesRxTotal long The total number of RX (received) bytes

getBytesTxDelta

bytesTxDelta long The delta number of TX (transmitted) bytes from the previous event

getBytesTxTotal

bytesTxTotal long The total number of TX (transmitted) bytes

getClass

class Class The class name

getClientName

clientName String The client name

getEnd

end Timestamp The end

getPartitionTablePostfix getPoolAddress

poolAddress InetAddress The pool address

getPort

port int The port

getStart

start Timestamp The start

getTag getTimeStamp

timeStamp Timestamp The timestamp


OpenVpnEvent


These events are created by OpenVPN and update the openvpn_events table when OpenVPN processes a client action.

Attribute Name Type Description

getAddress

address InetAddress The address

getClass

class Class The class name

getClientName

clientName String The client name

getPartitionTablePostfix getPoolAddress

poolAddress InetAddress The pool address

getTag getTimeStamp

timeStamp Timestamp The timestamp

getType

type OpenVpnEvent$EventType The type


AdminLoginEvent


These events are created by the base system and inserted to the admin_logins table when an administrator login is attempted or successful.

Attribute Name Type Description

getClass

class Class The class name

getClientAddress

clientAddress InetAddress The client address

getLocal

local boolean 1 if login is done via local console, 0 otherwise

getLogin

login String The login username

getPartitionTablePostfix getReason

reason String The reason

getSucceeded

succeeded boolean 1 if successful, 0 otherwise

getTag getTimeStamp

timeStamp Timestamp The timestamp


AlertEvent


These events are created by Reports and inserted to the alerts table when an alert fires.

Attribute Name Type Description

getCausalRule

causalRule EventRule The causal rule

getCause

cause LogEvent The cause

getClass

class Class The class name

getDescription

description String The description

getEventSent

eventSent Boolean True if the event was sent, false otherwise

getJson

json String The JSON string

getPartitionTablePostfix getSummaryText

summaryText String The summary text

getTag getTimeStamp

timeStamp Timestamp The timestamp


InterfaceStatEvent


These events are created by the base system and inserted to the interface_stat_events table periodically with interface stats.

Attribute Name Type Description

getClass

class Class The class name

getInterfaceId

interfaceId int The interface ID

getPartitionTablePostfix getRxBytes

rxBytes double The total of received bytes

getRxRate

rxRate double The RX rate in byte/s

getTag getTimeStamp

timeStamp Timestamp The timestamp

getTxBytes

txBytes double The total of transmitted bytes

getTxRate

txRate double The TX rate in byte/s


LogEvent


These base class for all events.

Attribute Name Type Description

getClass

class Class The class name

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp


SystemStatEvent


These events are created by the base system and inserted to the server_events table periodically.

Attribute Name Type Description

getActiveHosts

activeHosts int The active host count

getClass

class Class The class name

getCpuSystem

cpuSystem float The system CPU utilization

getCpuUser

cpuUser float The user CPU utilization

getDiskFree

diskFree long The amount of disk free

getDiskFreePercent

diskFreePercent float The percentage of disk free

getDiskTotal

diskTotal long The total size of the disk

getDiskUsed

diskUsed long The amount of disk used

getDiskUsedPercent

diskUsedPercent float The percentage of disk used

getLoad1

load1 float The 1-minute CPU load

getLoad15

load15 float The 15-minute CPU load

getLoad5

load5 float The 5-minute CPU load

getMemBuffers

memBuffers long The amount of memory used by buffers

getMemCache

memCache long The amount of memory used by cache

getMemFree

memFree long The amount of free memory

getMemFreePercent

memFreePercent float The percentage of total memory that is free

getMemTotal

memTotal long The total amount of memory

getMemUsed

memUsed long The amount of used memory

getMemUsedPercent

memUsedPercent float The percentage of total memory that is used

getPartitionTablePostfix getSwapFree

swapFree long The amount of free swap

getSwapFreePercent

swapFreePercent float The percentage of total swap that is free

getSwapTotal

swapTotal long The total size of swap

getSwapUsed

swapUsed long The amount of used swap

getSwapUsedPercent

swapUsedPercent float The percentage of total swap that is used

getTag getTimeStamp

timeStamp Timestamp The timestamp


HostTableEvent


These events are created by the base system and inserted to the host_table_updates table when the host table is modified.

Attribute Name Type Description

getAddress

address InetAddress The address

getClass

class Class The class name

getKey

key String The key

getOldValue

oldValue String The old value

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getValue

value String The value


DeviceTableEvent


These events are created by the base system and inserted to the device_table_updates table when the device list is modified.

Attribute Name Type Description

getClass

class Class The class name

getDevice

device DeviceTableEntry The Device

getKey

key String The key

getMacAddress

macAddress String The MAC address

getOldValue

oldValue String The old value

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getValue

value String The value


SettingsChangesEvent


These events are created by the base system and inserted to the settings_changes table when settings are changed.

Attribute Name Type Description

getClass

class Class The class name

getHostname

hostname String The hostname

getPartitionTablePostfix getSettingsFile

settingsFile String The settings file

getTag getTimeStamp

timeStamp Timestamp The timestamp

getUsername

username String The username


UserTableEvent


These events are created by the base system and inserted to the user_table_updates table when the user table is modified.

Attribute Name Type Description

getClass

class Class The class name

getKey

key String The key

getOldValue

oldValue String The old value

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getUsername

username String The username

getValue

value String The value


SessionMinuteEvent


These events are created by the base system and update the session_minutes table each minute a session exists.

Attribute Name Type Description

getC2sBytes

c2sBytes long The number of bytes sent from the client to the server

getClass

class Class The class name

getPartitionTablePostfix getS2cBytes

s2cBytes long The number of bytes sent from the server to the client

getSessionId

sessionId long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


SessionEvent


These events are created by the base system and update the sessions table each time a session is created.

Attribute Name Type Description

getCClientAddr

CClientAddr InetAddress The client-side (pre-NAT) client address

getCClientPort

CClientPort Integer The client-side (pre-NAT) client port

getCServerAddr

CServerAddr InetAddress The client-side (pre-NAT) server address

getCServerPort

CServerPort Integer The client-side (pre-NAT) server port

getSClientAddr

SClientAddr InetAddress The server-side (post-NAT) client address

getSClientPort

SClientPort Integer The server-side (post-NAT) client port

getSServerAddr

SServerAddr InetAddress The server-side (post-NAT) server address

getSServerPort

SServerPort Integer The server-side (post-NAT) server port

getBypassed

bypassed boolean True if bypassed, false otherwise

getClass

class Class The class name

getClientCountry

clientCountry String The client country

getClientIntf

clientIntf Integer The client interface ID

getClientLatitude

clientLatitude Double The client latitude

getClientLongitude

clientLongitude Double The client longitude

getEntitled

entitled boolean The entitled status

getFilterPrefix

filterPrefix String The filter prefix if blocked by the filter rules

getHostname

hostname String The hostname

getIcmpType

icmpType Short The ICMP type

getLocalAddr

localAddr InetAddress The local host address

getPartitionTablePostfix getPolicyId

policyId Integer The policy ID

getPolicyRuleId

policyRuleId Integer The policy rule ID

getProtocol

protocol Short The protocol

getProtocolName

protocolName String The protocol name

getRemoteAddr

remoteAddr InetAddress The remote host address

getServerCountry

serverCountry String The server country

getServerIntf

serverIntf Integer The server interface ID

getServerLatitude

serverLatitude Double The server latitude

getServerLongitude

serverLongitude Double The server longitude

getSessionId

sessionId Long The session ID

getTag getTagsString

tagsString String The string value of all tags

getTimeStamp

timeStamp Timestamp The timestamp

getUsername

username String The username


SessionStatsEvent


These events are created by the base system and update the sessions table when a session ends with the updated stats.

Attribute Name Type Description

getC2pBytes

c2pBytes long The number of bytes sent from the client to Untangle

getClass

class Class The class name

getEndTime

endTime long The end time/date

getP2cBytes

p2cBytes long The number of bytes sent to the client from Untangle

getP2sBytes

p2sBytes long The number of bytes sent to the server from Untangle

getPartitionTablePostfix getS2pBytes

s2pBytes long The number of bytes sent from the server to Untangle

getSessionEvent

sessionEvent SessionEvent The session event

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


SessionNatEvent


These events are created by the base system and update the sessions table each time a session is NATd with the post-NAT information.

Attribute Name Type Description

getSClientAddr

SClientAddr InetAddress The server-side (post-NAT) client address

getSClientPort

SClientPort Integer The server-side (post-NAT) client port

getSServerAddr

SServerAddr InetAddress The server-side (post-NAT) server address

getSServerPort

SServerPort Integer The server-side (post-NAT) server port

getClass

class Class The class name

getPartitionTablePostfix getServerIntf

serverIntf Integer The server interface ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


QuotaEvent


These events are created by the Bandwidth Control and inserted or update the quotas table when quotas are given or exceeded.

Attribute Name Type Description

getAction

action int The action (1=Quota Given, 2=Quota Exceeded)

getClass

class Class The class name

getEntity

entity String The entity

getPartitionTablePostfix getQuotaSize

quotaSize long The quota size

getReason

reason String The reason

getTag getTimeStamp

timeStamp Timestamp The timestamp


SmtpMessageAddressEvent


These events are created by SMTP subsystem and inserted to the mail_addrs table for each address on each email.

Attribute Name Type Description

getAddr

addr String The address

getClass

class Class The class name

getKind

kind AddressKind The type for this address (F=From, T=To, C=CC, G=Envelope From, B=Envelope To, X=Unknown)

getMessageId

messageId Long The message ID

getPartitionTablePostfix getPersonal

personal String personal

getTag getTimeStamp

timeStamp Timestamp The timestamp


SmtpMessageEvent


These events are created by SMTP subsystem and inserted to the mail_msgs table for each email.

Attribute Name Type Description

getAddresses

addresses Set The addresses

getClass

class Class The class name

getEnvelopeFromAddress

envelopeFromAddress String The envelop FROM address

getEnvelopeToAddress

envelopeToAddress String The envelope TO address

getMessageId

messageId Long The message ID

getPartitionTablePostfix getReceiver

receiver String The receiver

getSender

sender String The sender

getSessionEvent

sessionEvent SessionEvent The session event

getSessionId

sessionId Long The session ID

getSubject

subject String The subject

getTag getTimeStamp

timeStamp Timestamp The timestamp

getTmpFile

tmpFile File The /tmp file


CaptureRuleEvent


These events are created by Captive Portal and update the sessions table when Captive Portal processes a session.

Attribute Name Type Description

getCaptured

captured boolean True if captured, false otherwise

getClass

class Class The class name

getPartitionTablePostfix getRuleId

ruleId Integer The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


CaptivePortalUserEvent


These events are created by Captive Portal and inserted to the captive_portal_user_events table when Captive Portal user takes an action.

Attribute Name Type Description

getAuthenticationType

authenticationType CaptivePortalSettings$AuthenticationType The authentication type

getAuthenticationTypeValue

authenticationTypeValue String The authentication type as a string

getClass

class Class The class name

getClientAddr

clientAddr String The client address

getEvent

event CaptivePortalUserEvent$EventType The event (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)

getEventValue

eventValue String The event value as a string (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT)

getLoginName

loginName String The login name

getPartitionTablePostfix getPolicyId

policyId Integer The policy ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


AdBlockerEvent


These events are created by Ad Blocker and update the http_events table when an ad is blocked.

Attribute Name Type Description

getAction

action Action The action

getClass

class Class The class name

getPartitionTablePostfix getReason

reason String The reason

getRequestId

requestId Long The request ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


CookieEvent


These events are created by Ad Blocker and update the http_events table when a cookie is blocked.

Attribute Name Type Description

getClass

class Class The class name

getIdentification

identification String The identification string

getPartitionTablePostfix getRequestId

requestId Long The request ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


HttpRequestEvent


These events are created by HTTP subsystem and inserted to the http_events table when a web request happens.

Attribute Name Type Description

getClass

class Class The class name

getContentLength

contentLength long The content length

getDomain

domain String The domain

getHost

host String The host

getMethod

method HttpMethod The HTTP method

getPartitionTablePostfix getReferer

referer String The referer

getRequestId

requestId Long The request ID

getRequestUri

requestUri URI The request URI

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


HttpResponseEvent


These events are created by HTTP subsystem and update the http_events table when a web response happens.

Attribute Name Type Description

getClass

class Class The class name

getContentFilename

contentFilename String The content filename

getContentLength

contentLength long The content length

getContentType

contentType String The content type

getHttpRequestEvent

httpRequestEvent HttpRequestEvent The corresponding HTTP request event

getPartitionTablePostfix getRequestLine

requestLine RequestLine The request line

getTag getTimeStamp

timeStamp Timestamp The timestamp


WebCacheEvent


These events are created by Web Cache and inserted to the web_cache_stats table periodically.

Attribute Name Type Description

getBypassCount

bypassCount long The number of bypasses

getClass

class Class The class name

getHitBytes

hitBytes long The number of bytes worth of hits

getHitCount

hitCount long The number of hits

getMissBytes

missBytes long The number of bytes worth of misses

getMissCount

missCount long The number of misses

getPartitionTablePostfix getPolicyId

policyId Long The policy ID

getSystemCount

systemCount long The number of system bypasses

getTag getTimeStamp

timeStamp Timestamp The timestamp


TunnelVpnStatusEvent


These events are created by Tunnel VPN and inserted to the tunnel_vpn_stats table periodically.

Attribute Name Type Description

getClass

class Class The class name

getInBytes

inBytes long The number of bytes received from this tunnel

getOutBytes

outBytes long The number of bytes sent in this tunnel

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getTunnelName

tunnelName String The name of this tunnel


TunnelVpnEvent


These events are created by Tunnel VPN and inserted to the tunnel_vpn_events table when a tunnel connection event occurs.

Attribute Name Type Description

getClass

class Class The class name

getEventType

eventType TunnelVpnEvent$EventType The event type

getLocalAddress

localAddress InetAddress The local host address

getPartitionTablePostfix getServerAddress

serverAddress InetAddress The server address

getTag getTimeStamp

timeStamp Timestamp The timestamp

getTunnelName

tunnelName String The name of this tunnel


IntrusionPreventionLogEvent


These events are created by Intrusion Prevention and inserted to the intrusion_prevention_events table when a rule matches.

Attribute Name Type Description

getBlocked

blocked boolean True if blocked, false otherwise

getCategory

category String The category

getClass

class Class The class name

getClassificationId

classificationId long The classification ID

getClasstype

classtype String The classtype

getDportIcode

dportIcode int The dportIcode

getEventId

eventId long The event ID

getEventMicrosecond

eventMicrosecond long The event microsecond

getEventSecond

eventSecond long The event second

getEventType

eventType long The event type

getGeneratorId

generatorId long The generator ID

getImpact

impact short The impact

getImpactFlag

impactFlag short The impact flag

getIpDestination

ipDestination InetAddress The IP address destination

getIpSource

ipSource InetAddress The IP address source

getMplsLabel

mplsLabel long The mplsLabel

getMsg

msg String The msg

getPadding

padding int The padding

getPartitionTablePostfix getPriorityId

priorityId long The priority ID

getProtocol

protocol short The protocol

getRid

rid String Rule ID

getSensorId

sensorId long The sensor ID

getSignatureId

signatureId long The signature ID

getSignatureRevision

signatureRevision long The signature revision

getSportItype

sportItype int The sportItype

getTag getTimeStamp

timeStamp Timestamp The timestamp

getVlanId

vlanId int The VLAN Id


ApplicationControlLogEvent


These events are created by Application Control and update the sessions table when application control identifies a session.

Attribute Name Type Description

getApplication

application String The application

getBlocked

blocked boolean True if blocked, false otherwise

getCategory

category String The category

getClass

class Class The class name

getConfidence

confidence Integer The confidence (0-100)

getDetail

detail String The details

getFlagged

flagged boolean True if flagged, false otherwise

getPartitionTablePostfix getProtochain

protochain String The protochain

getRuleId

ruleId Integer The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getState

state Integer The state

getTag getTimeStamp

timeStamp Timestamp The timestamp


LoginEvent


These events are created by Directory Connector and inserted to the directory_connector_login_events table for each login.

Attribute Name Type Description

getClass

class Class The class name

getClientAddr

clientAddr InetAddress The client address

getDomain

domain String The domain

getEvent

event String The event

getLoginName

loginName String The login name

getLoginType

loginType String W = Windows login, A=Active Directory, R=RADIUS, T=test

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp


WebFilterEvent


These events are created by Web Filter and update the http_events table when web filter processes a web request.

Attribute Name Type Description

getAppName

appName String The name of the application

getBlocked

blocked Boolean True if blocked, false otherwise

getCategory

category String The category

getCategoryId

categoryId Integer Numeric value of matching category

getClass

class Class The class name

getFlagged

flagged Boolean True if flagged, false otherwise

getPartitionTablePostfix getReason

reason Reason The reason

getRequestLine

requestLine RequestLine The request line

getRuleId

ruleId Integer The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


WebFilterQueryEvent


These events are created by Web Filter and inserted to the http_query_events table when web filter processes a search engine search.

Attribute Name Type Description

getAppName

appName String The name of the application

getBlocked

blocked Boolean True if blocked, false otherwise

getClass

class Class The class name

getContentLength

contentLength long The content length

getFlagged

flagged Boolean True if flagged, false otherwise

getHost

host String The host

getMethod

method HttpMethod The method

getPartitionTablePostfix getRequestId

requestId Long The request ID

getRequestUri

requestUri URI The request URI

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTerm

term String The search term/phrase

getTimeStamp

timeStamp Timestamp The timestamp


WanFailoverTestEvent


These events are created by WAN Failover and inserted to the wan_failover_test_events table when a test is run.

Attribute Name Type Description

getClass

class Class The class name

getDescription

description String The description

getInterfaceId

interfaceId int The interface ID

getName

name String The test name

getOsName

osName String The O/S interface name

getPartitionTablePostfix getSuccess

success Boolean True if successful, false otherwise

getTag getTimeStamp

timeStamp Timestamp The timestamp


WanFailoverEvent


These events are created by WAN Failover and inserted to the wan_failover_action_events table when WAN Failover takes an action.

Attribute Name Type Description

getAction

action WanFailoverEvent$Action The action

getClass

class Class The class name

getInterfaceId

interfaceId int The interface ID

getName

name String The name

getOsName

osName String The O/S interface name

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp


ThreatPreventionEvent


These events are created by Threat Prevention and inserted to the sessions table for each threat lookup.

Attribute Name Type Description

getBlocked

blocked boolean True if blocked, false otherwise

getClass

class Class The class name

getClientCategories

clientCategories int Client threat categories

getClientReputation

clientReputation int Client threat reputation

getFlagged

flagged boolean True if flagged, false otherwise

getPartitionTablePostfix getRuleId

ruleId long The rule ID

getServerCategories

serverCategories int Server threat categories

getServerReputation

serverReputation int Server threat reputation

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


ThreatPreventionHttpEvent


These events are created by Threat Prevention and inserted to the http_events table for each threat lookup.

Attribute Name Type Description

getBlocked

blocked Boolean True if blocked, false otherwise

getCategories

categories Integer Server threat categories

getClass

class Class The class name

getFlagged

flagged Boolean True if flagged, false otherwise

getPartitionTablePostfix getReputation

reputation Integer Server threat reputation

getRequestLine

requestLine RequestLine The request line

getRuleId

ruleId Integer The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getTag getTimeStamp

timeStamp Timestamp The timestamp


SpamLogEvent


These events are created by Spam Blocker and update the mail_msgs table when an email is scanned.

Attribute Name Type Description

getAction

action SpamMessageAction The action

getClass

class Class The class name

getClientAddr

clientAddr InetAddress The client address

getClientPort

clientPort int The client port

getMessageId

messageId Long The message ID

getPartitionTablePostfix getReceiver

receiver String The receiver

getScore

score float The score

getSender

sender String The sender

getServerAddr

serverAddr InetAddress The server address

getServerPort

serverPort int The server port

getSmtpMessageEvent

smtpMessageEvent SmtpMessageEvent The parent SMTP message event

isSpam

isSpam boolean True if spam, false otherwise

getSubject

subject String The subject

getTag getTestsString

testsString String The tests string from the spam engine

getTimeStamp

timeStamp Timestamp The timestamp

getVendorName

vendorName String The application name


SpamSmtpTarpitEvent


These events are created by Spam Blocker and inserted to the smtp_tarpit_events table when a session is tarpitted.

Attribute Name Type Description

getIPAddr

IPAddr InetAddress The IP address

getClass

class Class The class name

getHostname

hostname String The hostname

getPartitionTablePostfix getSessionEvent

sessionEvent SessionEvent The session event

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp

getVendorName

vendorName String The application name


ConfigurationBackupEvent


These events are created by Configuration Backup and inserted to the configuratio_backup_events table when a backup occurs.

Attribute Name Type Description

getClass

class Class The class name

getDestination

destination String The destination

getDetail

detail String The details

getPartitionTablePostfix getSuccess

success boolean True if successful, false otherwise

getTag getTimeStamp

timeStamp Timestamp The timestamp


TunnelStatusEvent


These events are created by IPsec VPN and inserted to the ipsec_tunnel_stats table periodically.

Attribute Name Type Description

getClass

class Class The class name

getInBytes

inBytes long The number of bytes received from this tunnel

getOutBytes

outBytes long The number of bytes sent in this tunnel

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp

getTunnelName

tunnelName String The name of this tunnel


IpsecVpnEvent


These events are created by IPsec VPN and inserted to the ipsec_vpn_events table when IPsec connection event occurs.

Attribute Name Type Description

getClass

class Class The class name

getEventType

eventType IpsecVpnEvent$EventType The event type

getLocalAddress

localAddress String The local host address

getPartitionTablePostfix getRemoteAddress

remoteAddress String The remote host address

getTag getTimeStamp

timeStamp Timestamp The timestamp

getTunnelDescription

tunnelDescription String Description of tunnel


VirtualUserEvent


These events are created by IPsec VPN and inserted to the ipsec_user_events table when a user event occurs.

Attribute Name Type Description

getClass

class Class The class name

getClientAddress

clientAddress InetAddress The client address

getClientProtocol

clientProtocol String The client protocol

getClientUsername

clientUsername String The client username

getElapsedTime

elapsedTime String The elapsed time

getEventId

eventId Long The event ID

getNetInterface

netInterface String The net interface

getNetProcess

netProcess String The net process

getNetRXbytes

netRXbytes Long The number of RX (received) bytes

getNetTXbytes

netTXbytes Long The number of TX (transmitted) bytes

getPartitionTablePostfix getTag getTimeStamp

timeStamp Timestamp The timestamp


SslInspectorLogEvent


These events are created by SSL Inspector and update the sessions table when a session is processed by SSL Inspector.

Attribute Name Type Description

getClass

class Class The class name

getDetail

detail String The details

getPartitionTablePostfix getRuleId

ruleId Integer The rule ID

getSessionEvent

sessionEvent SessionEvent The session event

getStatus

status String The status

getTag getTimeStamp

timeStamp Timestamp The timestamp


ApplicationControlLiteEvent


These events are created by Application Control Lite and update the sessions table when application control lite identifies a session.

Attribute Name Type Description

getBlocked

blocked boolean True if blocked, false otherwise

getClass

class Class The class name

getPartitionTablePostfix getProtocol

protocol String The protocol

getSessionId

sessionId Long The session ID

getTag getTimeStamp

timeStamp Timestamp The timestamp


}