visibility flow-collector¶

sFlow/Netflow collector

flow-collector Specification¶

Parameter Value

Type Intermediate Resource

Element Name flow-collector

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

Element Attributes flow-collector_attributes

Partition Visibility shared

Schema flow-collector schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/visibility/flow-collector	flow-collector_attributes

flow-collector attributes¶

netflow

Description: netflow is a JSON Block. Please see below for netflow

Type: Object

Reference Object: /axapi/v3/visibility/flow-collector/netflow

sflow

Description: sflow is a JSON Block. Please see below for sflow

Type: Object

Reference Object: /axapi/v3/visibility/flow-collector/sflow

netflow¶

Specification Value

Type object

sampling-enable

Type: List

template

Description: template is a JSON Block. Please see below for netflow_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

netflow_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

netflow_template¶

Specification Value

Type object

detail

Description: detail is a JSON Block. Please see below for netflow_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

netflow_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

netflow_template_detail¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sflow¶

Specification Value

Type object

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sflow_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘pkts-received’: Total sflow pkts received; ‘frag-dropped’: Total sflow fragment packets droppped; ‘agent-not-found’: sflow pkts from not configured agents; ‘version-not-supported’: sflow version not supported; ‘unknown-dir’: sflow sample direction is unknown;

Type: string

Supported Values: all, pkts-received, frag-dropped, agent-not-found, version-not-supported, unknown-dir