API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Modify IPFIX Flow Exporter

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/ipfix-flow-exporter/

Flow exporter list for IPFIX flow exporter Configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Configuration to set the name of a flow exporter.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

exportersbody object

string
enum

Configure the destination type of the collector that will receive flow reports/template-packets for this flow exporter.

Show Details
COLLECTOR_HOSTNAME_OR_IP_ADDRSpecify collector hostname or ip as collector type, which maps to hostname-or-ip-addr destination type.
COLLECTOR_LOCALSpecify collector local as collector type, which maps to traffic-insight destination type.
Allowed:
string
length between 1 and 256

Configuration to set the description for the flow exporter.

boolean
Defaults to true

GW: Enable or disable IP Flow Collector.
Default: Disabled

string
enum
Defaults to IPFIX

Configure the export protocol this flow exporter will use when sending IPFIX flow reports to the collector.

Show Details
IPFIXSpecify IPFIX as the export protocol.
Allowed:
int32
5000 to 25000
Defaults to 15000

GW: Determines the maximum number of entries a managed device can cache before the log is exported to the IP Flow Collector.

string
length between 1 and 256

Configure the flow exporter's destination to be the hostname of the intended ipfix collector. 'ip' field must be set to null

length ≤ 9999

Configure the flow exporter's destination to be the IP of the intended IPFIX collector. 'hostname' field must be set to null

string
length between 1 and 256

Configure the flow exporter's destination to be the name of a Traffic Insight instance.

string
length between 1 and 64

Configuration to set the name of a flow exporter.

int64
0 to 4294967295
Defaults to 0

GW: Observation Domain. Allows the IP Flow Collector to group managed devices when receiving data sessions.
Default: Switch IP as 32 bit number

int32
0 to 65535
Defaults to 4739

AOS-CX: Configure the transport port this flow exporter will use when sending IPFIX flow reports/template-packets to the collector.
GW: Assigns the port used by the ip-flow-export-profile to export caches to the IP Flow Collector.

0 to 255

AOS-CX: Configure the transport protocol this flow exporter will use when sending IPFIX flow reports/template-packets to the collector.
GW: Determines the transport Protocol this ip-flow-export-profile will use when a cache is exported.

int32
0 to 30
Defaults to 15

GW: Determines the maximum time interval (in minutes) allowed before a managed device must export its cache to the IP Flow Collector.

int32
0 to 30
Defaults to 0

GW: Determines the maximum time interval (in minutes) to upload current cache snapshot.

int64
0 to 86400
Defaults to 0

AOS-CX: Configure the interval (in seconds) this flow exporter will use when sending IPFIX flow template-packets to the collector. In AOS-CX this corresponds to the template data timeout CLI for the flow exporter.
Range: 1-86400
GW: Determines the maximum time interval (in seconds) to upload IPFIX templates.
Range: 0-86400
Default: 0 (always)

string
length ≤ 9999

Configure the VRF this flow exporter will use when sending IPFIX flow reports/template-packets to the collector.

Responses

Updated 6 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago