Create IPFIX Config (v2.0)

POST 
/sdwan/v2.0/api/sites/:site_id/elements/:element_id/ipfix

Create an IPFIX config.

Request

Path Parameters

site_id stringrequired

ID of the site.

element_id stringrequired

ID of the element.

application/json

Body

collector_config CollectorConfig[]
Collectors define the third-party applications which consume the exported flow records. Maximum 4 collectors can be configured.
Array [
host string
The IPv4 address or the FQDN Schema (domain name) of the IPFIX collector.
host_port int32
The port number that matches the port on which the collector is configured to receive IPFIX records.
ipfixcollectorcontext_id string
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 int32
Max Message Size
protocol string
Possible values: [tcp, udp]
The protocol type of the collector's config.
]
description

The description of the IPFIX profile configuration.

export_cache_timeout integer

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.
Array [
app_def_ids string[]
The IDs of the applications that filter flow records.
dst_ports Port[]
The destination port ranges, if applicable, for TCP and UDP protocols.
Array [
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
dst_prefixes_id string
The destination prefix ID.
ipfixfiltercontext_ids string[]
The ID of the IPFIX filter context that maps to an interface on the ION device.
priority_traffic_types string[]
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.
protocols string[]
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.
rtp_transport_type string
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.
Array [
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
src_prefixes_id string
The source prefix IDs.
wan_path_direction string
Possible values: [lan_to_wan, wan_to_lan]
The diection of the WAN path.
]
id string

The ID.

ipfixprofile_id stringrequired

The IPFIX profile configuration ID.

ipfixtemplate_id string

The IPFIX template ID.

name stringrequired

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.

algorithm string

Possible values: [time_based, none]

A time-based algorithm to configure the duration for sampling.

time_interval integer

The length of the sampling interval during which flows are selected. The default value is 5 ms.

time_spacing integer

The spacing between the end of one sampling interval and the start of the next sampling interval. The default value is 5 ms.

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

collector_config CollectorConfig[]
Collectors define the third-party applications which consume the exported flow records. Maximum 4 collectors can be configured.
Array [
host string
The IPv4 address or the FQDN Schema (domain name) of the IPFIX collector.
host_port int32
The port number that matches the port on which the collector is configured to receive IPFIX records.
ipfixcollectorcontext_id string
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 int32
Max Message Size
protocol string
Possible values: [tcp, udp]
The protocol type of the collector's config.
]
description

The description of the IPFIX profile configuration.

export_cache_timeout integer

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.
Array [
app_def_ids string[]
The IDs of the applications that filter flow records.
dst_ports Port[]
The destination port ranges, if applicable, for TCP and UDP protocols.
Array [
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
dst_prefixes_id string
The destination prefix ID.
ipfixfiltercontext_ids string[]
The ID of the IPFIX filter context that maps to an interface on the ION device.
priority_traffic_types string[]
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.
protocols string[]
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.
rtp_transport_type string
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.
Array [
end string
The end port range must be between 1 and 65535.
start string
The start port range must be between 1 and 65535.
]
src_prefixes_id string
The source prefix IDs.
wan_path_direction string
Possible values: [lan_to_wan, wan_to_lan]
The diection of the WAN path.
]
id string

The ID.

ipfixprofile_id stringrequired

The IPFIX profile configuration ID.

ipfixtemplate_id string

The IPFIX template ID.

name stringrequired

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.

algorithm string

Possible values: [time_based, none]

A time-based algorithm to configure the duration for sampling.

time_interval integer

The length of the sampling interval during which flows are selected. The default value is 5 ms.

time_spacing integer

The spacing between the end of one sampling interval and the start of the next sampling interval. The default value is 5 ms.

tags string[]

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

Example (from schema)

{
  "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",
  "ipfixprofile_id": "string",
  "ipfixtemplate_id": "string",
  "name": "string",
  "sampler": {
    "algorithm": "time_based",
    "time_interval": 0,
    "time_spacing": 0
  },
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_REQUEST_DUPLICATE_KEY"
      },
      {
        "code": "NAME_REQD"
      },
      {
        "code": "DESCRIPTION_EXCEEDS_LIMIT"
      },
      {
        "code": "INVALID_TAG"
      },
      {
        "code": "IPFIX_COLLECTOR_INVALID_MAX_MESSAGE_SIZE"
      },
      {
        "code": "IPFIX_COLLECTOR_INVALID_PROTOCOL"
      },
      {
        "code": "IPFIX_COLLECTOR_HOST_REQUIRED"
      },
      {
        "code": "IPFIX_COLLECTOR_INVALID_HOST_PORT"
      },
      {
        "code": "IPFIX_COLLECTOR_DUPLICATE_HOST_PORT"
      },
      {
        "code": "IPFIX_COLLECTOR_INVALID_HOST"
      },
      {
        "code": "IPFIX_SAMPLER_INVALID_ALGORITHM"
      },
      {
        "code": "IPFIX_SAMPLER_INVALID_TIME_INTERVAL"
      },
      {
        "code": "IPFIX_SAMPLER_INVALID_TIME_SPACING"
      },
      {
        "code": "IPFIX_FILTERS_MAX_SIZE"
      },
      {
        "code": "IPFIX_INVALID_EXPORT_CACHE_TIMEOUT"
      },
      {
        "code": "IPFIX_FILTER_INVALID_CONTEXT_IDS"
      },
      {
        "code": "IPFIX_FILTER_DST_PORTS_MAX_SIZE_EXCEED"
      },
      {
        "code": "IPFIX_FILTER_SRC_PORTS_MAX_SIZE_EXCEED"
      },
      {
        "code": "IPFIX_FILTER_INVALID_WAN_PATH_DIRECTION"
      },
      {
        "code": "IPFIX_FILTER_INVALID_APPDEF_IDS"
      },
      {
        "code": "IPFIX_FILTER_INVALID_RTP_TRANSPORT_TYPE"
      },
      {
        "code": "IPFIX_FILTER_INVALID_PROTOCOLS"
      },
      {
        "code": "IPFIX_FILTER_DUPLICATE_PROTOCOLS"
      },
      {
        "code": "IPFIX_FILTER_INVALID_PRIORITY_TRAFFIC_TYPES"
      },
      {
        "code": "IPFIX_FILTER_DUPLICATE_PRIORITY_TRAFFIC_TYPES"
      },
      {
        "code": "IPFIX_FILTER_INVALID_PROTOCOL_PORT"
      },
      {
        "code": "IPFIX_FILTER_DUPLICATE_PORT_RANGE"
      },
      {
        "code": "IPFIX_PORT_INVALID_VALUE"
      },
      {
        "code": "IPFIX_INVALID_FILTER_CONTEXT_IDS"
      },
      {
        "code": "IPFIX_INVALID_COLLECTOR_CONTEXT_IDS"
      },
      {
        "code": "IPFIX_INVALID_APPDEF_IDS"
      },
      {
        "code": "IPFIX_INVALID_PREFIX_IDS"
      },
      {
        "code": "IPFIX_PORT_INVALID_RANGE"
      },
      {
        "code": "IPFIX_INVALID_FILTER"
      },
      {
        "code": "IPFIX_INVALID_TEMPLATE_ID"
      },
      {
        "code": "IPFIX_CONFIG_INVALID_COLLECTOR_CONFIG"
      },
      {
        "code": "IPFIX_CONFIG_PROFILE_ID_REQUIRED"
      },
      {
        "code": "IPFIX_INVALID_PROFILE_ID"
      },
      {
        "code": "IPFIX_CONFIG_MAX_EXCEEDED"
      },
      {
        "code": "IPFIX_CONFIG_UNSUPPORTED_SWVERSION"
      },
      {
        "code": "IPFIX_SAMPLER_INVALID_ALGORITHM_TIME_BASED_CONFIG"
      },
      {
        "code": "IPFIX_SAMPLER_INVALID_ALGORITHM_NONE_CONFIG"
      }
    ]
  }
}

Loading...