Options Information Elements

The table below describes the options available for the IPFIX template flow record. The flow information elements are based on the IANA IP Flow Information Export (IPFIX) entity definitions included at https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-elements.
Options
Information Element
ElementId
Description
Data Type
Data Type Semantics
APP_DEF_ID_TABLE
Application Name Option Records: This Options Template Record contains the following Information Elements:
  • Scope = applicationId : IANA 95.
  • applicationName : IANA 96. A more detailed example of this can be found in RFC 6759- Section 6.8
applicationId
IANA 95
From RFC 5101: The scope, which is only available in the Options Template Set, gives the context of the reported Information Elements in the Data Records.
applicationName
IANA 96
WAN_PATH_ID_TABLE
The WAN Path Name Option Template Record contains the following Information Elements:
  • Scope = cgnxWanPath. The Prisma SD-WAN ID associated with the WAN Path.
  • cgnxWanPathName - A generated descriptive name to associate with the cgnxWanPath.
cgnxWanPathName
1100 CGNX
Specifies the name of a WAN Path. The name includes path type, circuit name, and possibly remote endpoint information.
string
default
LINK_QUALITY_METRICS
The LQM Options Template Record contains the following Information Elements:
  • Scope = 'Link' (cgnxLqmPathIdentifier), and 'Time Stamp' (observationTimeSeconds)
  • Information Element(s) for various Link Quality Metrics as described below.
cgnxLqmPathIdentifier
1060 CGNX
The value of the path identifier is Prisma SD-WAN specific and is generated during configuration of the WAN element.
unsigned64
Identifier
observationTimeSeconds
IANA 322
This Information Element specifies the absolute time in seconds of an observation.
dateTimeSeconds
default
cgnxLqmRemoteSiteIdentifier
1061 CGNX
Indicates the value of the remote site identifier generated during configuration of the WAN element.
An identifier value of 0 represents the aggregated LQM information for the associated path identifier. Only Private WAN paths will have a non-zero remote site identifier. This is a scope element for the option template.
unsigned64
Identifier
cgnxRttSumMilliseconds
1011 CGNX
Specifies the sum of round trip times for an application in milliseconds.
unsigned32
default
cgnxLqmDownLinkJitterMilliseconds
1062 CGNX
The downward jitter associated with the path in milliseconds for the observation period.
float32
quantity
cgnxLqmDownLinkPacketLoss
1063 CGNX
The downward packet loss associated with the path as a percentage for the observation period.
float32
quantity
cgnxLqmDownLinkMos
1064 CGNX
The downward packet loss associated with the path as a percentage for the observation period.
float32
quantity
cgnxLqmUpLinkJitterMilliseconds
1065 CGNX
The upward jitter associated with the path in milliseconds for the observation period.
float32
quantity
cgnxLqmUpLinkPacketLoss
1063 CGNX
The downward packet loss associated with the path as a percentage for the observation period.
float32
quantity
cgnxLqmUpLinkMos
1067 CGNX
The upward MOS associated with the path for the observation period. Value 1 - 5.
float32
quantity
cgnxLqmRttLatencyMilliseconds
1068 CGNX
The RTT latency associated with the path in milliseconds for the observation period.
float32
quantity
cgnxLqmLinkHealthy
1069 CGNX
The overall health associated with the path for the observation period
float32
quantity
cgnxLqmBadLinkHealthReasonBitmap
The overall health associated with the path for the observation period.
DEVICE_IDENTIFICATION
Device Identification Information Option Record: The Identification Information Option Template Record contains the following Information Elements:
  • Scope = cgnxElementIdentifier. The Prisma SD-WAN ID associated with the device to uniquely identify it.
  • cgnxSiteIdentifier, cgnxTenantIdentifier - Additional identification information needed to make use of the REST API to interact with the controller to gather detailed information.
  • cgnxElementName - Information that can be useful to present to the user.
cgnxElementIdentifier
1101 CGNX
Specifies the Prisma SD-WAN ID that is uniquely associated with the device that is exporting the IPFIX records.
unsigned64
identifier
cgnxSiteIdentifier
1102 CGNX
Specifies the Prisma SD-WAN ID that is uniquely associated with the site that the element resides.
unsigned64
identifier
cgnxTenantIdentifier
1103 CGNX
Specifies the Prisma SD-WAN ID that is uniquely associated with the tenant that owns the element.
unsigned64
identifier
cgnxElementName
1104 CGNX
Specifies the Name that has been configured for the device that is exporting the IPFIX records.
string
default

Recommended For You