Get IPFIX Profile(v2.0)
GET/v2.0/api/tenants/:tenant_id/ipfixprofiles/:profile_id
List an IPFIX profile.
Request
Path Parameters
ID of the tenant.
ID of the IPFIX profile.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
collector_config CollectorConfig[]required
Collectors define the third-party applications which consume the exported flow records. Maximum 4 collectors can be configured.
The IPv4 address or the FQDN Schema (domain name) of the IPFIX collector.
The port number that matches the port on which the collector is configured to receive IPFIX records.
The ID of the IPFIX collector context. The device uses the IP address of the interface to which the collector context is bound as the source interface to export IPFIX flow records.
Max Message Size
Possible values: [tcp
, udp
]
The protocol type of the collector's config.
The description of the IPFIX profile configuration.
Export Cache Timeout specifies the time for which the ION device should cache a new flow record before exporting it. Value must be within 10 and 600 seconds.The default value is 30 seconds.
filters IPFixFilter[]
The filters configured to select a subset of flows from all the observed flows to export to a collector. Maximum of 8 filters per IPFIX profile.
The IDs of the applications that filter flow records.
dst_ports Port[]
The destination port ranges, if applicable, for TCP and UDP protocols.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
The destination prefix ID.
The ID of the IPFIX filter context that maps to an interface on the ION device.
Possible values: [P1_Video
, P1_Audio
, P1_Xact
, P1_Bulk
, P2_Video
, P2_Audio
, P2_Xact
, P2_Bulk
, P3_Video
, P3_Audio
, P3_Xact
, P3_Bulk
, P4_Video
, P4_Audio
, P4_Xact
, P4_Bulk
]
The types of priority traffic for the IPFIX config.
Possible values: [tcp
, udp
, ospf
, ipv6
, is-is-over-ipv4
, ipv6-nonxt
, etherip
, ipv6-icmp
, igmp
, udplite
, ipv6-opts
, icmp
, esp
, crtp
, ipip
, eigrp
, egp
, gre
, l2tpv3
, sctp
, ip-in-ip
, rsvp
, pim
, scps
, mpls-in-ip
, ah
, vrrp
, ipv6-route
, igp
, ipv6-frag
]
The possible protocols types for the IPFIX config.
Possible values: [audio
, video
]
The value of the RTP transport identifier is Prisma SD-WAN specific and is identified from the flow.
src_ports Port[]
The source port for the flow.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
The source prefix IDs.
Possible values: [lan_to_wan
, wan_to_lan
]
The diection of the WAN path.
The ID.
The IPFIX template ID.
The IPFIX profile name.
sampler IPFixSampler
Subset of flows to export from all the observed flows. The device forwards this subset to the filtering process to perform further selection if filters are configured.
Possible values: [time_based
, none
]
A time-based algorithm to configure the duration for sampling.
The length of the sampling interval during which flows are selected. The default value is 5 ms.
The spacing between the end of one sampling interval and the start of the next sampling interval. The default value is 5 ms.
A information field that can be added to identify the IPFIX config. Maximum 10 unique tags of length 1024 each are allowed.
{
"collector_config": [
{
"host": "string",
"host_port": 0,
"ipfixcollectorcontext_id": "string",
"max_message_size": 0,
"protocol": "tcp"
}
],
"export_cache_timeout": 0,
"filters": [
{
"app_def_ids": [
"string"
],
"dst_ports": [
{
"end": "string",
"start": "string"
}
],
"dst_prefixes_id": "string",
"ipfixfiltercontext_ids": [
"string"
],
"priority_traffic_types": [
"P1_Video"
],
"protocols": [
"tcp"
],
"rtp_transport_type": "audio",
"src_ports": [
{
"end": "string",
"start": "string"
}
],
"src_prefixes_id": "string",
"wan_path_direction": "lan_to_wan"
}
],
"id": "string",
"ipfixtemplate_id": "string",
"name": "string",
"sampler": {
"algorithm": "time_based",
"time_interval": 0,
"time_spacing": 0
},
"tags": [
"string"
]
}