visibility flow-collector netflow¶
NetFlow/IPFIX collector
netflow Specification¶
Type Configuration Resource Element Name netflow Element URI /axapi/v3/visibility/flow-collector/netflow Element Attributes netflow_attributes Statistics Data URI /axapi/v3/visibility/flow-collector/netflow/stats Schema netflow schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/flow-collector/netflow | ||
Get Object | GET | /axapi/v3/visibility/flow-collector/netflow | ||
Modify Object | POST | /axapi/v3/visibility/flow-collector/netflow | ||
Replace Object | PUT | /axapi/v3/visibility/flow-collector/netflow | ||
Delete Object | DELETE | /axapi/v3/visibility/flow-collector/netflow |
netflow attributes¶
sampling-enable
Type: Listtemplate
Description: template is a JSON Block. Please see below for template
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/netflow/template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘pkts-rcvd’: Total nflow packets received; ‘v9-templates-created’: Total v9 templates created; ‘v9-templates-deleted’: Total v9 templates deleted; ‘v10-templates-created’: Total v10(IPFIX) templates created; ‘v10-templates-deleted’: Total v10(IPFIX) templates deleted; ‘template-drop-exceeded’: Total templates dropped because of maximum limit; ‘template-drop-out-of-memory’: Total templates dropped becuase of out of memory; ‘frag-dropped’: Total nflow fragment packets droppped; ‘agent-not-found’: nflow pkts from not configured agents; ‘version-not-supported’: nflow version not supported; ‘unknown-dir’: nflow sample direction is unknown;
Type: string
Supported Values: all, pkts-rcvd, v9-templates-created, v9-templates-deleted, v10-templates-created, v10-templates-deleted, template-drop-exceeded, template-drop-out-of-memory, frag-dropped, agent-not-found, version-not-supported, unknown-dir
template¶
Specification Type object detail
Description: detail is a JSON Block. Please see below for template_detail
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/netflow/template/detail
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘templates-added-to-delq’: Netflow templates added to the delete queue; ‘templates-removed-from-delq’: Netflow templates removed from the delete queue;
Type: string
Supported Values: all, templates-added-to-delq, templates-removed-from-delq
template_detail¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stats data¶
Counter | Size | Description | |
---|---|---|---|
template-drop-exceeded | 8 | Total templates dropped because of maximum limit | |
pkts-rcvd | 8 | Total nflow packets received | |
agent-not-found | 8 | nflow pkts from not configured agents | |
v10-templates-deleted | 8 | Total v10(IPFIX) templates deleted | |
frag-dropped | 8 | Total nflow fragment packets droppped | |
version-not-supported | 8 | nflow version not supported | |
v9-templates-deleted | 8 | Total v9 templates deleted | |
v9-templates-created | 8 | Total v9 templates created | |
unknown-dir | 8 | nflow sample direction is unknown | |
v10-templates-created | 8 | Total v10(IPFIX) templates created | |
template-drop-out-of-memory | 8 | Total templates dropped becuase of out of memory |