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

Schema monitor schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/netflow/monitor	monitor attributes
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
GET /axapi/v3/netflow/monitor/a Reponse: { "monitor": { "name": "a", "disable": 0, "source-ip-use-mgmt": 0, "flow-timeout": 10, "protocol": "v9", "uuid": "0ed70120-9015-11e8-93ad-d1eebcf57329", "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
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
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¶

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

disable-log-by-destination

Description: disable-log-by-destination is a JSON Block. Please see below for disable-log-by-destination

Type: Object

Refernce Object: /axapi/v3/netflow/monitor/{name}/disable-log-by-destination

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 ‘v9’: Netflow version 9; ‘v10’: Netflow version 10 (IPFIX);

Type: string

Supported Values: v9, v10

Default: v9

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

sampling-enable

Type: List

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

sample¶

Specification

Type object

ethernet-list

Type: List

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

nat-pool-list

Type: List

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

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_nat-pool-list¶

Specification

Type list

Block object keys

pool-name

Description Name of nat pool

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sample_ethernet-list¶

Specification

Type list

Block object keys

ifindex

Description Ethernet interface number

Type: number

Format: interface

Range: 1-103

Refernce Object: /axapi/v3/interface/ethernet

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

service-group

Description Service-group for load balancing between multiple collector servers

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: service-group ip and ipv6 are mutually exclusive

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 service-group 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 service-group and ip are mutually exclusive

port6

Description Port number, default is 9996

Type: number

Range: 1-65535

Default: 9996

disable-log-by-destination¶

Specification

Type object

icmp

Description Disable logging for icmp traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

others

Description Disable logging for other L4 protocols

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-list

Type: List

udp-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

disable-log-by-destination_udp-list¶

Specification

Type list

Block object keys

udp-port-end

Description Port Range End

Type: number

udp-port-start

Description Destination Port (Single Destination Port or Port Range Start)

Type: number

disable-log-by-destination_tcp-list¶

Specification

Type list

Block object keys

tcp-port-end

Description Port Range End

Type: number

tcp-port-start

Description Destination Port (Single Destination Port or Port Range Start)

Type: number

record¶

Specification

Type object

dslite

Description DS-Lite Flow Record Template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nat44

Description NAT44 Flow Record Template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nat64

Description NAT64 Flow Record Template

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

port-batch-dslite

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-batch-nat44

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-batch-nat64

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-batch-v2-dslite

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-batch-v2-nat44

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-batch-v2-nat64

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-mapping-dslite

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-mapping-nat44

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

port-mapping-nat64

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

sesn-event-dslite

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

sesn-event-fw4

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

sesn-event-fw6

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

sesn-event-nat44

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

sesn-event-nat64

Description ‘both’: Export both creation and deletion events; ‘creation’: Export only creation events; ‘deletion’: Export only deletion events;

Type: string

Supported Values: both, creation, deletion

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; ‘packets-sent’: packets-sent; ‘bytes-sent’: bytes-sent; ‘nat44-records-sent’: nat44-records-sent; ‘nat44-records-sent-failure’: nat44-records-sent-failure; ‘nat64-records-sent’: nat64-records-sent; ‘nat64-records-sent-failure’: nat64-records-sent-failure; ‘dslite-records-sent’: dslite-records-sent; ‘dslite-records-sent-failure’: dslite-records-sent-failure; ‘session-event-nat44-records-sent’: session-event-nat44-records-sent; ‘session-event-nat44-records-sent-failure’: session-event-nat44-records-sent-failure; ‘session-event-nat64-records-sent’: session-event-nat64-records-sent; ‘session-event-nat64-records-sent-failure’: session-event-nat64-records-sent-failure; ‘session-event-dslite-records-sent’: session-event-dslite-records-sent; ‘session-event-dslite-records-sent-failure’: session-event-dslite-records-sent-failure; ‘port-mapping-nat44-records-sent’: port-mapping-nat44-records-sent; ‘port-mapping-nat44-records-sent-failure’: port-mapping-nat44-records-sent-failure; ‘port-mapping-nat64-records-sent’: port-mapping-nat64-records-sent; ‘port-mapping-nat64-records-sent-failure’: port-mapping-nat64-records-sent-failure; ‘port-mapping-dslite-records-sent’: port-mapping-dslite-records-sent; ‘port-mapping-dslite-records-sent-failure’: port-mapping-dslite-records-sent-failure; ‘netflow-v5-records-sent’: netflow-v5-records-sent; ‘netflow-v5-records-sent-failure’: netflow-v5-records-sent-failure; ‘netflow-v5-ext-records-sent’: netflow-v5-ext-records-sent; ‘netflow-v5-ext-records-sent-failure’: netflow-v5-ext-records-sent-failure;

Type: string

Supported Values: all, packets-sent, bytes-sent, nat44-records-sent, nat44-records-sent-failure, nat64-records-sent, nat64-records-sent-failure, dslite-records-sent, dslite-records-sent-failure, session-event-nat44-records-sent, session-event-nat44-records-sent-failure, session-event-nat64-records-sent, session-event-nat64-records-sent-failure, session-event-dslite-records-sent, session-event-dslite-records-sent-failure, session-event-fw4-records-sent, session-event-fw4-records-sent-failure, session-event-fw6-records-sent, session-event-fw6-records-sent-failure, port-mapping-nat44-records-sent, port-mapping-nat44-records-sent-failure, port-mapping-nat64-records-sent, port-mapping-nat64-records-sent-failure, port-mapping-dslite-records-sent, port-mapping-dslite-records-sent-failure, netflow-v5-records-sent, netflow-v5-records-sent-failure, netflow-v5-ext-records-sent, netflow-v5-ext-records-sent-failure, port-batching-nat44-records-sent, port-batching-nat44-records-sent-failure, port-batching-nat64-records-sent, port-batching-nat64-records-sent-failure, port-batching-dslite-records-sent, port-batching-dslite-records-sent-failure, port-batching-v2-nat44-records-sent, port-batching-v2-nat44-records-sent-failure, port-batching-v2-nat64-records-sent, port-batching-v2-nat64-records-sent-failure, port-batching-v2-dslite-records-sent, port-batching-v2-dslite-records-sent-failure, reduced-logs-by-destination

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-batching-v2-nat64-records-sent	8	port-batching-v2-nat64-records-sent
port-mapping-nat64-records-sent	8	port-mapping-nat64-records-sent
netflow-v5-records-sent	8	netflow-v5-records-sent
session-event-fw6-records-sent	8	session-event-fw6-records-sent
port-mapping-nat44-records-sent-failure	8	port-mapping-nat44-records-sent-failure
port-batching-dslite-records-sent	8	port-batching-dslite-records-sent
port-batching-v2-nat44-records-sent-failure	8	port-batching-v2-nat44-records-sent-failure
session-event-nat64-records-sent	8	session-event-nat64-records-sent
port-batching-nat64-records-sent-failure	8	port-batching-nat64-records-sent-failure
port-batching-v2-nat44-records-sent	8	port-batching-v2-nat44-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
packets-sent	8	packets-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
session-event-fw6-records-sent-failure	8	session-event-fw6-records-sent-failure
port-mapping-nat64-records-sent-failure	8	port-mapping-nat64-records-sent-failure
nat64-records-sent	8	nat64-records-sent
port-batching-v2-dslite-records-sent-failure	8	port-batching-v2-dslite-records-sent-failure
port-batching-dslite-records-sent-failure	8	port-batching-dslite-records-sent-failure
port-batching-nat64-records-sent	8	port-batching-nat64-records-sent
port-batching-nat44-records-sent	8	port-batching-nat44-records-sent
port-batching-v2-nat64-records-sent-failure	8	port-batching-v2-nat64-records-sent-failure
port-mapping-dslite-records-sent	8	port-mapping-dslite-records-sent
port-batching-nat44-records-sent-failure	8	port-batching-nat44-records-sent-failure
reduced-logs-by-destination	8	Reduced Logs by Destination Protocol and Port
bytes-sent	8	bytes-sent
session-event-dslite-records-sent-failure	8	session-event-dslite-records-sent-failure
nat44-records-sent-failure	8	nat44-records-sent-failure
dslite-records-sent	8	dslite-records-sent
port-batching-v2-dslite-records-sent	8	port-batching-v2-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
session-event-fw4-records-sent-failure	8	session-event-fw4-records-sent-failure
nat64-records-sent-failure	8	nat64-records-sent-failure