netflow monitor

Configure NetFlow Monitor

monitor Specification

Type	Collection
Object Key(s)	name
Collection Name	monitor-list
Collection URI	/axapi/v3/netflow/monitor
Element Name	monitor
Element URI	/axapi/v3/netflow/monitor/{name}
Element Attributes	monitor_attributes
Statistics Data URI	/axapi/v3/netflow/monitor/{name}/stats
Operational Data URI	/axapi/v3/netflow/monitor/{name}/oper
Schema	monitor schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/netflow/monitor	monitor attributes	example close
POST /axapi/v3/netflow/monitor/ Payload: { "monitor": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/netflow/monitor	monitor attributes
Get Object	GET	/axapi/v3/netflow/monitor/{name}	monitor attributes	example close
GET /axapi/v3/netflow/monitor/a Reponse: { "monitor": { "name": "a", "disable": 0, "source-ip-use-mgmt": 0, "flow-timeout": 10, "counter-polling-interval": 60, "uuid": "e103035a-7d13-11ea-84ed-001fa00614a0", "user-tag": "a", "a10-url": "/axapi/v3/netflow/monitor/a" } }
Get List	GET	/axapi/v3/netflow/monitor	monitor-list
Modify Object	POST	/axapi/v3/netflow/monitor/{name}	monitor attributes
Replace Object	PUT	/axapi/v3/netflow/monitor/{name}	monitor attributes	example close
PUT /axapi/v3/netflow/monitor/a Payload: { "monitor": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/netflow/monitor	monitor-list
Delete Object	DELETE	/axapi/v3/netflow/monitor/{name}	monitor attributes	example close
DELETE /axapi/v3/netflow/monitor/a Reponse: { "response": { "status": "OK" } }

monitor-list

monitor-list is JSON List of monitor attributes

monitor-list : [

{ monitor attributes },

{ monitor attributes },

…

]

monitor attributes

counter-polling-interval

Description Configure the interval to export global counters (Number of seconds: default is 60)

Type: number

Range: 1-3600

Default: 60

destination

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

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/destination

disable

Description Disable this netflow monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

flow-timeout

Description Configure timeout value to export flow records periodically for long-live session ( Number of minutes: default is 10, 0 means only send flow record when session is deleted)

Type: number

Range: 0-1440

Default: 10

name

Description Name of netflow monitor

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

protocol

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

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/protocol

record

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

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/record

resend-template

Description: resend-template is a JSON Block. Please see below for resend-template

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/resend-template

sample

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

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/sample

source-address

Description: source-address is a JSON Block. Please see below for source-address

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/source-address

source-ip-use-mgmt

Description Use management interface’s IP address for source ip of netflow packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protocol

Specification
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

version

Description ‘v9’: Netflow version 9; ‘v10’: Netflow version 10 (IPFIX);

Type: string

Supported Values: v9, v10

Default: v9

source-address

Specification
Type	object

ip

Description Specify source IP address

Type: string

Format: ipv4-address

ipv6

Description Specify source IPv6 address

Type: string

Format: ipv6-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

destination

Specification
Type	object

ip-cfg

Description: ip-cfg is a JSON Block. Please see below for destination_ip-cfg

Type: Object

ipv6-cfg

Description: ipv6-cfg is a JSON Block. Please see below for destination_ipv6-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

destination_ip-cfg

Specification
Type	object

ip

Description IP address of netflow collector

Type: string

Format: ipv4-address

Mutual Exclusion: ip and ipv6 are mutually exclusive

port4

Description Port number, default is 9996

Type: number

Range: 1-65535

Default: 9996

destination_ipv6-cfg

Specification
Type	object

ipv6

Description IPv6 address of netflow collector

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6 and ip are mutually exclusive

port6

Description Port number, default is 9996

Type: number

Range: 1-65535

Default: 9996

sample

Specification
Type	object

ethernet-list

Type: List

Refernce Object: /axapi/v3/netflow/monitor/{name}/sample/ethernet/{ifindex}

ve-list

Type: List

Refernce Object: /axapi/v3/netflow/monitor/{name}/sample/ve/{ve-num}

sample_ve-list

Specification
Type	list
Block object keys

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-num

Description VE interface number

Type: number

Range: 2-4094

Refernce Object: /axapi/v3/interface/ve

sample_ethernet-list

Specification
Type	list
Block object keys

ifindex

Description Ethernet interface number

Type: number

Format: interface

Range: 3-227

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

record

Specification
Type	object

ddos-general-stat

Description General DDOS statistics

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ddos-http-stat

Description HTTP DDOS statistics

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

netflow-v5

Description NetFlow V5 Flow Record Template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

netflow-v5-ext

Description Extended NetFlow V5 Flow Record Template, supports ipv6

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

resend-template

Specification
Type	object

records

Description To resend template once for each number of records (Number of records: default is 1000, 0 means never resend template)

Type: number

Range: 0-1000000

Default: 1000

timeout

Description To set time interval to resend template (number of seconds: default is 1800, 0 means never resend template)

Type: number

Range: 0-86400

Default: 1800

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

stats data

	Counter	Size	Description
	port-mapping-nat64-records-sent	8	port-mapping-nat64-records-sent
	netflow-v5-records-sent	8	netflow-v5-records-sent
	port-mapping-nat44-records-sent-failure	8	port-mapping-nat44-records-sent-failure
	ddos-http-stat-records-sent-failure	8	ddos-http-stat-records-sent-failure
	session-event-nat64-records-sent	8	session-event-nat64-records-sent
	netflow-v5-ext-records-sent-failure	8	netflow-v5-ext-records-sent-failure
	port-mapping-dslite-records-sent-failure	8	port-mapping-dslite-records-sent-failure
	session-event-dslite-records-sent	8	session-event-dslite-records-sent
	netflow-v5-ext-records-sent	8	netflow-v5-ext-records-sent
	dslite-records-sent-failure	8	dslite-records-sent-failure
	session-event-nat44-records-sent	8	session-event-nat44-records-sent
	port-mapping-nat64-records-sent-failure	8	port-mapping-nat64-records-sent-failure
	nat64-records-sent	8	nat64-records-sent
	ddos-http-stat-records-sent	8	ddos-http-stat-records-sent
	ddos-general-stat-records-sent	8	ddos-general-stat-records-sent
	port-mapping-dslite-records-sent	8	port-mapping-dslite-records-sent
	bytes-sent	8	bytes-sent
	session-event-dslite-records-sent-failure	8	session-event-dslite-records-sent-failure
	ddos-general-stat-records-sent-failure	8	ddos-general-stat-records-sent-failure
	nat44-records-sent-failure	8	nat44-records-sent-failure
	dslite-records-sent	8	dslite-records-sent
	port-mapping-nat44-records-sent	8	port-mapping-nat44-records-sent
	session-event-nat44-records-sent-failure	8	session-event-nat44-records-sent-failure
	session-event-nat64-records-sent-failure	8	session-event-nat64-records-sent-failure
	nat44-records-sent	8	nat44-records-sent
	packets-sent	8	packets-sent
	nat64-records-sent-failure	8	nat64-records-sent-failure
	netflow-v5-records-sent-failure	8	netflow-v5-records-sent-failure

operational data

	Counter	Size	Description
	status	string	status
	source-ip-use-mgmt	string	source-ip-use-mgmt
	protocol	string	protocol
	resend-template-timeout	string	resend-template-timeout
	destination	string	destination
	counter-polling-interval	string	counter-polling-interval
	filter	string	filter
	resend-template-per-records	string	resend-template-per-records
	flow-timeout	string	flow-timeout
	source-ip-addr	string	source-ip-addr