Create IPFIX Template (v2.0)
POST/sdwan/v2.0/api/ipfixtemplates
Create an IPFIX template.
Request
- application/json
Body
The IPFIX profile description when creating an IPFIX template.
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 flow report in both directions for a flow at an observation point.
The ID of the IPFIX local prefix.
The name of the IPFIX template. Max size = 128.
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.
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.
A information field that can be added to identify the IPFIX local prefix. Maximum 10 Unique tags of length 1024 each are allowed.
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.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The IPFIX profile description when creating an IPFIX template.
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 flow report in both directions for a flow at an observation point.
The ID of the IPFIX local prefix.
The name of the IPFIX template. Max size = 128.
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.
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.
A information field that can be added to identify the IPFIX local prefix. Maximum 10 Unique tags of length 1024 each are allowed.
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.
{
"flow_fields": [
"INTERFACES"
],
"generate_biflow": true,
"id": "string",
"name": "string",
"option_export_timeout": 0,
"options": [
"APP_DEF_ID_TABLE"
],
"tags": [
"string"
],
"template_export_timeout": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_REQUEST_DUPLICATE_KEY"
},
{
"code": "NAME_REQD"
},
{
"code": "DESCRIPTION_EXCEEDS_LIMIT"
},
{
"code": "INVALID_TAG"
},
{
"code": "IPFIX_TEMPLATE_INVALID_FLOW_FIELDS"
},
{
"code": "IPFIX_TEMPLATE_FLOW_FIELDS_REQD"
},
{
"code": "IPFIX_TEMPLATE_INVALID_OPTIONS"
},
{
"code": "IPFIX_TEMPLATE_INVALID_TEMPLATE_EXPORT_TIMEOUT"
},
{
"code": "IPFIX_TEMPLATE_INVALID_OPTION_EXPORT_TIMEOUT"
},
{
"code": "IPFIX_TEMPLATE_DUPLICATE_FLOW_FIELDS"
},
{
"code": "IPFIX_TEMPLATE_DUPLICATE_OPTIONS"
}
]
}
}