.. _netflow: netflow ======= Configure NetFlow/IPFIX netflow Specification --------------------- ===================================== ================================================ **Parameter** **Value** ===================================== ================================================ **Type** *Intermediate Resource* **Element Name** netflow **Element URI** /axapi/v3/netflow **Element Attributes** netflow_attributes **Partition Visibility** shared **Schema** :download:`netflow schema ` ===================================== ================================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/netflow .. raw:: html netflow_attributes .. raw:: html
.. _1158_netflow_attributes: netflow attributes ------------------ **collector** **Description:** collector is a **JSON Block**. Please see below for :ref:`1158_collector` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/collector ` **common** **Description:** common is a **JSON Block**. Please see below for :ref:`1158_common` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/common ` **monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name} ` .. _1158_monitor-list: monitor-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counter-polling-interval** **Description** Configure the interval to export global counters (Number of seconds: default is 60) **Type:** number **Range:** 1-3600 **Default:** 60 **custom-record** **Description:** custom-record is a **JSON Block**. Please see below for :ref:`1158_monitor-list_custom-record` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/custom-record ` **destination** **Description:** destination is a **JSON Block**. Please see below for :ref:`1158_monitor-list_destination` **Type:** Object **Reference Object:** :doc:`/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 :ref:`1158_monitor-list_disable-log-by-destination` **Type:** Object **Reference Object:** :doc:`/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 :ref:`1158_monitor-list_record` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/record ` **resend-template** **Description:** resend-template is a **JSON Block**. Please see below for :ref:`1158_monitor-list_resend-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/resend-template ` **sample** **Description:** sample is a **JSON Block**. Please see below for :ref:`1158_monitor-list_sample` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample ` **source-address** **Description:** source-address is a **JSON Block**. Please see below for :ref:`1158_monitor-list_source-address` **Type:** Object **Reference Object:** :doc:`/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 .. _1158_monitor-list_custom-record: monitor-list_custom-record ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **custom-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_monitor-list_custom-record_custom-cfg: monitor-list_custom-record_custom-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **event** **Description** 'sesn-event-nat44-creation': Export NAT44 session creation events; 'sesn-event-nat44-deletion': Export NAT44 session deletion events; 'sesn-event-nat64-creation': Export NAT64 session creation events; 'sesn-event-nat64-deletion': Export NAT64 session deletion events; 'sesn-event-dslite-creation': Export Dslite session creation events; 'sesn-event-dslite-deletion': Export Dslite session deletion events; 'sesn-event-fw4-creation': Export FW4 session creation events; 'sesn-event-fw4-deletion': Export FW4 session deletion events; 'sesn-event-fw6-creation': Export FW6 session creation events; 'sesn-event-fw6-deletion': Export FW6 session deletion events; 'deny-reset-event-fw4': Export FW4 Deny Reset events; 'deny-reset-event-fw6': Export FW6 Deny Reset events; 'port-mapping-nat44-creation': Export NAT44 Port Mapping Creation Event; 'port-mapping-nat44-deletion': Export NAT44 Port Mapping Deletion Event; 'port-mapping-nat64-creation': Export NAT64 Port Mapping Creation Event; 'port-mapping-nat64-deletion': Export NAT64 Port Mapping Deletion Event; 'port-mapping-dslite-creation': Export Dslite Port Mapping Creation Event; 'port-mapping-dslite-deletion': Export Dslite Port Mapping Deletion Event; 'port-batch-nat44-creation': Export NAT44 Port Batch Creation Event; 'port-batch-nat44-deletion': Export NAT44 Port Batch Deletion Event; 'port-batch-nat64-creation': Export NAT64 Port Batch Creation Event; 'port-batch-nat64-deletion': Export NAT64 Port Batch Deletion Event; 'port-batch-dslite-creation': Export Dslite Port Batch Creation Event; 'port-batch-dslite-deletion': Export Dslite Port Batch Deletion Event; 'port-batch-v2-nat44-creation': Export NAT44 Port Batch v2 Creation Event; 'port-batch-v2-nat44-deletion': Export NAT44 Port Batch v2 Deletion Event; 'port-batch-v2-nat64-creation': Export NAT64 Port Batch v2 Creation Event; 'port-batch-v2-nat64-deletion': Export NAT64 Port Batch v2 Deletion Event; 'port-batch-v2-dslite-creation': Export Dslite Port Batch v2 Creation Event; 'port-batch-v2-dslite-deletion': Export Dslite Port Batch v2 Deletion Event; 'gtp-c-tunnel-event': Export GTP Control Tunnel Creation or Deletion Events; 'gtp-u-tunnel-event': Export GTP User Tunnel Creation or Deletion Events; 'gtp-deny-event': Export GTP Deny events on GTP C/U Tunnels; 'gtp-info-event': Export GTP Info events on GTP C/U Tunnels; **Type:** string **Supported Values:** sesn-event-nat44-creation, sesn-event-nat44-deletion, sesn-event-nat64-creation, sesn-event-nat64-deletion, sesn-event-dslite-creation, sesn-event-dslite-deletion, sesn-event-fw4-creation, sesn-event-fw4-deletion, sesn-event-fw6-creation, sesn-event-fw6-deletion, deny-reset-event-fw4, deny-reset-event-fw6, port-mapping-nat44-creation, port-mapping-nat44-deletion, port-mapping-nat64-creation, port-mapping-nat64-deletion, port-mapping-dslite-creation, port-mapping-dslite-deletion, port-batch-nat44-creation, port-batch-nat44-deletion, port-batch-nat64-creation, port-batch-nat64-deletion, port-batch-dslite-creation, port-batch-dslite-deletion, port-batch-v2-nat44-creation, port-batch-v2-nat44-deletion, port-batch-v2-nat64-creation, port-batch-v2-nat64-deletion, port-batch-v2-dslite-creation, port-batch-v2-dslite-deletion, gtp-c-tunnel-event, gtp-u-tunnel-event, gtp-deny-event, gtp-info-event .. _1158_monitor-list_sample: monitor-list_sample ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/ethernet/{ifindex} ` **ve-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/ve/{ve-num} ` .. _1158_monitor-list_sample_ve-list: monitor-list_sample_ve-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Reference Object:** :doc:`/axapi/v3/interface/ve ` .. _1158_monitor-list_sample_ethernet-list: monitor-list_sample_ethernet-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ifindex** **Description** Ethernet interface number **Type:** number **Format:** interface **Range:** 4-103 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_monitor-list_source-address: monitor-list_source-address ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_destination: monitor-list_destination ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-cfg** **Description:** ip-cfg is a **JSON Block**. Please see below for :ref:`1158_monitor-list_destination_ip-cfg` **Type:** Object **ipv6-cfg** **Description:** ipv6-cfg is a **JSON Block**. Please see below for :ref:`1158_monitor-list_destination_ipv6-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_monitor-list_destination_ip-cfg: monitor-list_destination_ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_destination_ipv6-cfg: monitor-list_destination_ipv6-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination: monitor-list_disable-log-by-destination ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/disable-log-by-destination/ip/{ipv4-addr} ` **ip6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/disable-log-by-destination/ip6/{ipv6-addr} ` **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 .. _1158_monitor-list_disable-log-by-destination_ip-list: monitor-list_disable-log-by-destination_ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv4-addr** **Description** Configure an IP subnet **Type:** string **Format:** ipv4-cidr **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 **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 .. _1158_monitor-list_disable-log-by-destination_ip-list_tcp-list: monitor-list_disable-log-by-destination_ip-list_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination_ip-list_udp-list: monitor-list_disable-log-by-destination_ip-list_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination_tcp-list: monitor-list_disable-log-by-destination_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination_ip6-list: monitor-list_disable-log-by-destination_ip6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-addr** **Description** Configure an IPv6 subnet **Type:** string **Format:** ipv6-address-plen **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 **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 .. _1158_monitor-list_disable-log-by-destination_ip6-list_tcp-list: monitor-list_disable-log-by-destination_ip6-list_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination_ip6-list_udp-list: monitor-list_disable-log-by-destination_ip6-list_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_disable-log-by-destination_udp-list: monitor-list_disable-log-by-destination_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_record: monitor-list_record ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_monitor-list_resend-template: monitor-list_resend-template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1158_collector: collector ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1158_collector_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/collector/template ` **template-detail** **Description:** template-detail is a **JSON Block**. Please see below for :ref:`1158_collector_template-detail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/collector/template-detail ` .. _1158_collector_template-detail: collector_template-detail ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_collector_template: collector_template ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_common: common ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **selector-algorithm-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/common/selector-algorithm/{algorithm-name} ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1158_common_selector-algorithm-list: common_selector-algorithm-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **algorithm-name** **Description** 'random': random; **Type:** string **Supported Values:** random **sampling-population** **Description** Configure sampling population for random algorithm **Type:** number **Range:** 1-1000000 **Default:** 1 **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