netflow¶

Configure NetFlow/IPFIX

netflow Specification¶

Type Intermediate Resource

Element Name netflow

Element URI /axapi/v3/netflow

Element Attributes netflow_attributes

Schema netflow schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/netflow	netflow_attributes

netflow attributes¶

common

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

Type: Object

Refernce Object: /axapi/v3/netflow/common

monitor-list

Type: List

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

monitor-list¶

Specification

Type list

Block object keys

destination

Description: destination is a JSON Block. Please see below for monitor-list_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 monitor-list_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 monitor-list_record

Type: Object

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

resend-template

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

Type: Object

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

sample

Description: sample is a JSON Block. Please see below for monitor-list_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 monitor-list_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

monitor-list_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}

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_destination¶

Specification

Type object

ip-cfg

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

Type: Object

ipv6-cfg

Description: ipv6-cfg is a JSON Block. Please see below for monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

monitor-list_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

common¶

Specification

Type object

max-packet-queue-time

Description Configure netflow packet queue time (Max packet queue time(*20ms). Default:50( *20ms = 1s)))

Type: number

Range: 0-50

Default: 50

reset-time-on-flow-record

Description Reset session start time to current time on each flow timeout export for long-lasting session (default: disabled).

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