visibility flow-collector netflow¶

NetFlow/IPFIX collector

netflow Specification¶

Parameter Value

Type Configuration Resource

Element Name netflow

Element URI /axapi/v3/visibility/flow-collector/netflow

Element Attributes netflow_attributes

Partition Visibility shared

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	netflow attributes
POST /axapi/v3/visibility/flow-collector/netflow Payload: { "netflow": { "sampling-enable": [ { "counters1": "all" } ] } }
Get Object	GET	/axapi/v3/visibility/flow-collector/netflow	netflow attributes
GET /axapi/v3/visibility/flow-collector/netflow Reponse: { "netflow": { "uuid": "db1e46e4-6612-11d9-9a27-692335d4f00d", "sampling-enable": [ { "counters1": "all" } ], "template": { "uuid": "db1e47b6-6612-11d9-9a27-692335d4f00d", "detail": { "uuid": "db1e4874-6612-11d9-9a27-692335d4f00d", "a10-url": "/axapi/v3/visibility/flow-collector/netflow/template/detail" }, "a10-url": "/axapi/v3/visibility/flow-collector/netflow/template" }, "a10-url": "/axapi/v3/visibility/flow-collector/netflow" } }
Modify Object	POST	/axapi/v3/visibility/flow-collector/netflow	netflow attributes
Replace Object	PUT	/axapi/v3/visibility/flow-collector/netflow	netflow attributes
PUT /axapi/v3/visibility/flow-collector/netflow Payload: { "netflow": { "sampling-enable": [ { "counters1": "pkts-rcvd" } ] } }
Delete Object	DELETE	/axapi/v3/visibility/flow-collector/netflow	netflow attributes
DELETE /axapi/v3/visibility/flow-collector/netflow Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

netflow attributes¶

sampling-enable

Type: List

template

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 Value

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 dropped; ‘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 Value

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: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template_sampling-enable¶

Specification Value

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 Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters