Applies To:
Show Versions
BIG-IP AFM
- 11.5.10, 11.5.9, 11.5.8, 11.5.7, 11.5.6, 11.5.5, 11.5.4, 11.5.3, 11.5.2, 11.5.1
IPFIX Templates for AFM SIP Events
Overview: IPFIX Templates for AFM SIP Events
The IP Flow Information Export (IPFIX) Protocol is a logging mechanism for IP events. This appendix defines the IPFIX Information Elements (IEs) and Templates used to log F5’s Application Firewall Manager (AFM) events related to the Session Initiation Protocol (SIP). An IE is the smallest form of useful information in an IPFIX log message, such as an IP address or a timestamp for the event. An IPFIX template is an ordered collection of specific IEs used to record one IP event, such as the acceptance of a SIP session.
About IPFIX Information Elements for AFM SIP events
Information Elements (IEs) are individual fields in an IPFIX template. An IPFIX template describes a single Advanced Firewall Manager™ (AFM™) SIP event.
IANA-defined IPFIX information elements
IANA maintains a list of standard IPFIX Information Elements (IEs), each with a unique Element Identifier. The F5® AFM™ SIP implementation uses a subset of these IEs to publish AFM SIP events. This subset is summarized in the table.
| Information Element (IE) | Size (Bytes) | IANA ID |
|---|---|---|
| destinationIPv4Address | 4 | 12 |
| destinationIPv6Address | 16 | 28 |
| destinationTransportPort | 2 | 11 |
| ingressVRFID | 4 | 234 |
| observationTimeMilliseconds | 8 | 323 |
| sourceIPv4Address | 4 | 8 |
| sourceIPv6Address | 16 | 27 |
| sourceTransportPort | 2 | 7 |
IPFIX enterprise Information Elements
IPFIX provides for enterprises to define their own Information Elements. F5® currently uses the following non-standard IEs for AFM™ events:
| Information Element (IE) | Size (Bytes) |
|---|---|
| action | Variable |
| attackEvent | Variable |
| attackId | 4 |
| attackName | Variable |
| bigipHostName | Variable |
| bigipMgmtIPv4Address | 4 |
| bigipMgmtIPv6Address | 16 |
| contextName | Variable |
| deviceProduct | Variable |
| deviceVendor | Variable |
| deviceVersion | Variable |
| errdefsMsgNo | 4 |
| flowId | 8 |
| ipfixMsgNo | 4 |
| messageSeverity | 1 |
| msgName | Variable |
| packetsDropped | 4 |
| packetsReceived | 4 |
| partitionName | Variable |
| sipCallee | Variable |
| sipCaller | Variable |
| sipMethodName | Variable |
| vlanName | Variable |
About individual IPFIX Templates for each event
This section enumerates the IPFIX templates used by F5 to publish AFM SIP Events.
IPFIX template for SIP security
| Information Element (IE) | Size (Bytes) | Notes |
|---|---|---|
| action | Variable | This IE is omitted for NetFlow v9. |
| bigipHostName | Variable | This IE is omitted for NetFlow v9. |
| bigipMgmtIPv4Address | 4 | |
| bigipMgmtIPv6Address | 16 | |
| contextName | Variable | This IE is omitted for NetFlow v9. |
| observationTimeMilliseconds | 8 | |
| destinationIPv4Address | 4 | |
| destinationIPv6Address | 16 | |
| destinationTransportPort | 2 | |
| deviceProduct | Variable | This IE is omitted for NetFlow v9. |
| deviceVendor | Variable | This IE is omitted for NetFlow v9. |
| deviceVersion | Variable | This IE is omitted for NetFlow v9. |
| errdefsMsgNo | 4 | |
| flowId | 8 | |
| ipfixMsgNo | 4 | |
| messageSeverity | 1 | |
| partitionName | Variable | This IE is omitted for NetFlow v9. |
| ingressVRFID | 4 | |
| sipCallee | Variable | This IE is omitted for NetFlow v9. |
| sipCaller | Variable | This IE is omitted for NetFlow v9. |
| sipMethodName | Variable | This IE is omitted for NetFlow v9. |
| sourceIPv4Address | 4 | |
| sourceIPv6Address | 16 | |
| sourceTransportPort | 2 | |
| vlanName | Variable | This IE is omitted for NetFlow v9. |
| msgName | Variable | This IE is omitted for NetFlow v9. |
IPFIX template for SIP DoS
| Information Element (IE) | Size (Bytes) | Notes |
|---|---|---|
| action | Variable | This IE is omitted for NetFlow v9. |
| attackEvent | Variable | This IE is omitted for NetFlow v9. |
| attackId | 4 | |
| attackName | Variable | This IE is omitted for NetFlow v9. |
| bigipHostName | Variable | This IE is omitted for NetFlow v9. |
| bigipMgmtIPv4Address | 4 | |
| bigipMgmtIPv6Address | 16 | |
| contextName | Variable | This IE is omitted for NetFlow v9. |
| observationTimeMilliseconds | 8 | |
| destinationIPv4Address | 4 | |
| destinationIPv6Address | 16 | |
| destinationTransportPort | 2 | |
| deviceProduct | Variable | This IE is omitted for NetFlow v9. |
| deviceVendor | Variable | This IE is omitted for NetFlow v9. |
| deviceVersion | Variable | This IE is omitted for NetFlow v9. |
| errdefsMsgNo | 4 | |
| flowId | 8 | |
| ipfixMsgNo | 4 | |
| messageSeverity | 1 | |
| partitionName | Variable | This IE is omitted for NetFlow v9. |
| ingressVRFID | 4 | |
| sipCallee | Variable | This IE is omitted for NetFlow v9. |
| sipCaller | Variable | This IE is omitted for NetFlow v9. |
| sipMethodName | Variable | This IE is omitted for NetFlow v9. |
| sourceIPv4Address | 4 | |
| sourceIPv6Address | 16 | |
| sourceTransportPort | 2 | |
| vlanName | Variable | This IE is omitted for NetFlow v9. |
| msgName | Variable | This IE is omitted for NetFlow v9. |
| packetsDropped | 4 | |
| packetsReceived | 4 |
