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

Create List

POST

/axapi/v3/netflow/monitor/

monitor Attributes

Get Object

GET

/axapi/v3/netflow/monitor/{name}

monitor Attributes

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

Replace List

PUT

/axapi/v3/netflow/monitor/

monitor-list

Delete Object

DELETE

/axapi/v3/netflow/monitor/{name}

monitor Attributes

Get Stats

GET

/axapi/v3/netflow/monitor/{name}/stats

stats data

monitor-list

monitor-list is JSON List of monitor Attributes

monitor-list : [

monitor Attributes

destination

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

Type: Object

Reference 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

Required: Yes

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

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

resend-template

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

Type: Object

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

sample

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

Type: Object

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

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

source-address

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

Type: Object

Reference 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

uuid

Description: uuid of the object

Type: string

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

destination

Specification
Type object

ip-cfg

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

Type: Object

ipv6-cfg

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

Type: Object

service-group

Description: Service-group for load balancing between multiple collector servers

Type: string

Format: string-rlx

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

uuid

Description: uuid of the object

Type: string

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

sample

Specification
Type object

ethernet-list

Description: ethernet-list is a JSON List . Please see below for l454_ethernet-list

Type: List

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

nat-pool-list

Description: nat-pool-list is a JSON List . Please see below for l454_nat-pool-list

Type: List

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

ve-list

Description: ve-list is a JSON List . Please see below for l454_ve-list

Type: List

Reference 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

ve-num

Description: VE interface number

Type: number

Range: 2-4094

Reference 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

uuid

Description: uuid of the object

Type: string

sample.ethernet-list

Specification
Type list
Block object keys

ifindex

Description: Ethernet interface number

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

uuid

Description: uuid of the object

Type: string

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

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, 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

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

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