Skip to main content

Get IPFIX Template (v2.0)

GET 
/sdwan/v2.0/api/ipfixtemplates/:template_id

List an IPFIX template.

Request​

Path Parameters

    template_id stringrequired

    ID of the IPFIX template.

Responses​

Successful Operation

Schema
    description

    The IPFIX profile description when creating an IPFIX template.

    flow_fields string[]required

    Possible values: [INTERFACES, TIME_STAMPS, DST_IPV4_ADDRESS, DST_PORT, SRC_IPV4_ADDRESS, SRC_PORT, PROTOCOL, DSCP_MAP, DSCP_LAST, QOS_QUEUE, WAN_PATH, APP_DEF_ID, RTP_TRANSPORT_TYPE, TRANSPORT_TCP_WINDOWSIZE, CONNECTION_UNIFLOW_BYTES, CONNECTION_UNIFLOW_PACKETS, CONNECTION_BIFLOW_BYTES, CONNECTION_BIFLOW_PACKETS, CONNECTION_RTT, CONNECTION_NTT, CONNECTION_SRT, APPLICATION_HOST, CONNECTION_INIT, CONNECTION_XACT, CONNECTION_UDPTRT, MEDIA_CODEC, MEDIA_JITTER, MEDIA_LOSS, MEDIA_MOS, TROUBLESHOOT_TCP, TROUBLESHOOT_DECISION_MAP]

    The information elements exported by default in the flow record.

    generate_biflow boolean

    Generate flow report in both directions for a flow at an observation point.

    id string

    The ID of the IPFIX local prefix.

    name stringrequired

    The name of the IPFIX template. Max size = 128.

    option_export_timeout int32

    Indicates how often the device sends flow templates to a collector. This is only applicable when the connection to a collector uses the UDP protocol. The default value is 600 seconds.

    options string[]required

    Possible values: [APP_DEF_ID_TABLE, LINK_QUALITY_METRICS, WAN_PATH_ID_TABLE, TYPE_INFO_FOR_IPFIX_IE, DEVICE_IDENTIFICATION]

    When selected, Options allows export of additional information to the collector that would not be possible with Flow Fields alone. Maz size = 8.

    tags string[]

    A information field that can be added to identify the IPFIX local prefix. Maximum 10 Unique tags of length 1024 each are allowed.

    template_export_timeout int32

    Indicates how often the device sends the option record information to a collector. This is only applicable when the connection to a collector uses the UDP protocol. The default value is 600 seconds.

Loading...