Options Information Elements
Focus
Focus

Options Information Elements

Table of Contents

Options Information Elements

Options Information Elements describes the options available for the IPFIX template flow record in Prisma SD-WAN.
Where Can I Use This?What Do I Need?
  • Prisma SD-WAN
  • Active Prisma SD-WAN license
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.
OptionsInformation ElementElementIdDescriptionData TypeData Type Semantics
APP_DEF_ID_TABLEApplication 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
applicationIdIANA 95From 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.
applicationNameIANA 96
WAN_PATH_ID_TABLEThe 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.
cgnxWanPathName1100 CGNXSpecifies the name of a WAN Path. The name includes path type, circuit name, and possibly remote endpoint information.stringdefault
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.
cgnxLqmPathIdentifier1060 CGNXThe value of the path identifier is Prisma SD-WAN specific and is generated during configuration of the WAN element.unsigned64 Identifier
observationTimeSecondsIANA 322This Information Element specifies the absolute time in seconds of an observation. dateTimeSeconds default
cgnxLqmRemoteSiteIdentifier1061 CGNXIndicates 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.
unsigned64Identifier
cgnxRttSumMilliseconds1011 CGNXSpecifies the sum of round trip times for an application in milliseconds. unsigned32default
cgnxLqmDownLinkJitterMilliseconds1062 CGNXThe downward jitter associated with the path in milliseconds for the observation period.float32quantity
cgnxLqmDownLinkPacketLoss1063 CGNXThe downward packet loss associated with the path as a percentage for the observation period.float32quantity
cgnxLqmDownLinkMos1064 CGNXThe downward packet loss associated with the path as a percentage for the observation period.float32quantity
cgnxLqmUpLinkJitterMilliseconds1065 CGNXThe upward jitter associated with the path in milliseconds for the observation period.float32quantity
cgnxLqmUpLinkPacketLoss1063 CGNXThe downward packet loss associated with the path as a percentage for the observation period.float32quantity
cgnxLqmUpLinkMos1067 CGNXThe upward MOS associated with the path for the observation period. Value 1 - 5.float32quantity
cgnxLqmRttLatencyMilliseconds1068 CGNXThe RTT latency associated with the path in milliseconds for the observation period.float32quantity
cgnxLqmLinkHealthy1069 CGNXThe overall health associated with the path for the observation periodfloat32quantity
cgnxLqmBadLinkHealthReasonBitmapThe overall health associated with the path for the observation period.
DEVICE_IDENTIFICATIONDevice 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.
cgnxElementIdentifier1101 CGNXSpecifies the Prisma SD-WAN ID that is uniquely associated with the device that is exporting the IPFIX records.unsigned64identifier
cgnxSiteIdentifier1102 CGNXSpecifies the Prisma SD-WAN ID that is uniquely associated with the site that the element resides. unsigned64identifier
cgnxTenantIdentifier1103 CGNXSpecifies the Prisma SD-WAN ID that is uniquely associated with the tenant that owns the element. unsigned64identifier
cgnxElementName1104 CGNXSpecifies the Name that has been configured for the device that is exporting the IPFIX records.stringdefault