.. _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
.. _2311_netflow_attributes: netflow attributes ------------------ **collector** **Description:** collector is a **JSON Block**. Please see below for :ref:`2311_collector` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/collector ` **common** **Description:** common is a **JSON Block**. Please see below for :ref:`2311_common` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/common ` **monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name} ` **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/template/{name} ` **use-partition** **Description:** use-partition is a **JSON Block**. Please see below for :ref:`2311_use-partition` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/use-partition ` .. _2311_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:`2311_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:`2311_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:`2311_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 **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/netflow-monitor-tmpl ` **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:`2311_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:`2311_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:`2311_monitor-list_sample` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample ` **sampling-enable** **Type:** List **scope** **Description** 'global': Netflow monitor is activated globally (Default); 'firewall-rule': Netflow monitor is only activated when referenced by a firewall rule; **Type:** string **Supported Values:** global, firewall-rule **Default:** global **source-address** **Description:** source-address is a **JSON Block**. Please see below for :ref:`2311_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 .. _2311_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 .. _2311_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; 'fw-ddos-entry-creation': Export FW iDDoS Entry Created Record; 'fw-ddos-entry-deletion': Export FW iDDoS Entry Deleted Record; 'fw-session-limit-exceeded': Export FW Session Limit Exceeded Record; 'cgn-ddos-l3-entry-creation': Export CGN iDDoS L3 Entry Creation; 'cgn-ddos-l3-entry-deletion': Export CGN iDDoS L3 Entry Deletion; 'cgn-ddos-l4-entry-creation': Export CGN iDDoS L4 Entry Creation; 'cgn-ddos-l4-entry-deletion': Export CGN iDDoS L4 Entry Deletion; 'gtp-rate-limit-periodic': Export GTP Rate Limit Periodic; **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, fw-ddos-entry-creation, fw-ddos-entry-deletion, fw-session-limit-exceeded, cgn-ddos-l3-entry-creation, cgn-ddos-l3-entry-deletion, cgn-ddos-l4-entry-creation, cgn-ddos-l4-entry-deletion, gtp-rate-limit-periodic **ipfix-template** **Description** Custom IPFIX Template **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/netflow/template ` .. _2311_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} ` **nat-pool-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/nat-pool/{pool-name} ` **ve-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/netflow/monitor/{name}/sample/ve/{ve-num} ` .. _2311_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 ` .. _2311_monitor-list_sample_nat-pool-list: monitor-list_sample_nat-pool-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _2311_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 **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2311_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 .. _2311_monitor-list_destination: monitor-list_destination ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-cfg** **Description:** ip-cfg is a **JSON Block**. Please see below for :ref:`2311_monitor-list_destination_ip-cfg` **Type:** Object **ipv6-cfg** **Description:** ipv6-cfg is a **JSON Block**. Please see below for :ref:`2311_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 .. _2311_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, service-group, and ipv6 are mutually exclusive **port4** **Description** Port number, default is 9996 **Type:** number **Range:** 1-65535 **Default:** 9996 .. _2311_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, service-group, and ip are mutually exclusive **port6** **Description** Port number, default is 9996 **Type:** number **Range:** 1-65535 **Default:** 9996 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 .. _2311_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 **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 .. _2311_monitor-list_sampling-enable: monitor-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'packets-sent': Sent Packets Count; 'bytes-sent': Sent Bytes Count; 'nat44-records-sent': NAT44 Flow Records Sent; 'nat44-records-sent-failure': NAT44 Flow Records Failed; 'nat64-records-sent': NAT64 Flow Records Sent; 'nat64-records-sent-failure': NAT64 Flow Records Failed; 'dslite-records-sent': Dslite Flow Records Sent; 'dslite-records-sent-failure': Dslite Flow Records Failed; 'session-event-nat44-records-sent': Nat44 Session Event Records Sent; 'session-event-nat44-records-sent-failure': Nat44 Session Event Records Failed; 'session-event-nat64-records-sent': Nat64 Session Event Records Sent; 'session-event-nat64-records-sent-failure': Nat64 Session Event Records Falied; 'session-event-dslite-records-sent': Dslite Session Event Records Sent; 'session-event-dslite-records-sent-failure': Dslite Session Event Records Failed; 'session-event-fw4-records-sent': FW4 Session Event Records Sent; 'session-event-fw4-records-sent-failure': FW4 Session Event Records Failed; 'session-event-fw6-records-sent': FW6 Session Event Records Sent; 'session-event-fw6-records-sent-failure': FW6 Session Event Records Failed; 'port-mapping-nat44-records-sent': Port Mapping Nat44 Event Records Sent; 'port-mapping-nat44-records-sent-failure': Port Mapping Nat44 Event Records Failed; 'port-mapping-nat64-records-sent': Port Mapping Nat64 Event Records Sent; 'port-mapping-nat64-records-sent-failure': Port Mapping Nat64 Event Records Failed; 'port-mapping-dslite-records-sent': Port Mapping Dslite Event Records Sent; 'port-mapping-dslite-records-sent-failure': Port Mapping Dslite Event Records failed; 'netflow-v5-records-sent': Netflow v5 Records Sent; 'netflow-v5-records-sent-failure': Netflow v5 Records Failed; 'netflow-v5-ext-records-sent': Netflow v5 Ext Records Sent; 'netflow-v5-ext-records-sent-failure': Netflow v5 Ext Records Failed; 'port-batching-nat44-records-sent': Port Batching Nat44 Records Sent; 'port-batching-nat44-records-sent-failure': Port Batching Nat44 Records Failed; 'port-batching-nat64-records-sent': Port Batching Nat64 Records Sent; 'port-batching-nat64-records-sent-failure': Port Batching Nat64 Records Failed; 'port-batching-dslite-records-sent': Port Batching Dslite Records Sent; 'port-batching-dslite-records-sent-failure': Port Batching Dslite Records Failed; 'port-batching-v2-nat44-records-sent': Port Batching V2 Nat44 Records Sent; 'port-batching-v2-nat44-records-sent-failure': Port Batching V2 Nat44 Records Failed; 'port-batching-v2-nat64-records-sent': Port Batching V2 Nat64 Records Sent; 'port-batching-v2-nat64-records-sent-failure': Port Batching V2 Nat64 Records Failed; 'port-batching-v2-dslite-records-sent': Port Batching V2 Dslite Records Sent; 'port-batching-v2-dslite-records-sent-failure': Port Batching V2 Dslite Records Falied; 'custom-session-event-nat44-creation-records-sent': Custom Nat44 Session Creation Records Sent; 'custom-session-event-nat44-creation-records-sent-failure': Custom Nat44 Session Creation Records Failed; 'custom-session-event-nat64-creation-records-sent': Custom Nat64 Session Creation Records Sent; 'custom-session-event-nat64-creation-records-sent-failure': Custom Nat64 Session Creation Records Failed; 'custom-session-event-dslite-creation-records-sent': Custom Dslite Session Creation Records Sent; 'custom-session-event-dslite-creation-records-sent-failure': Custom Dslite Session Creation Records Failed; 'custom-session-event-nat44-deletion-records-sent': Custom Nat44 Session Deletion Records Sent; 'custom-session-event-nat44-deletion-records-sent-failure': Custom Nat44 Session Deletion Records Failed; 'custom-session-event-nat64-deletion-records-sent': Custom Nat64 Session Deletion Records Sent; 'custom-session-event-nat64-deletion-records-sent-failure': Custom Nat64 Session Deletion Records Failed; 'custom-session-event-dslite-deletion-records-sent': Custom Dslite Session Deletion Records Sent; 'custom-session-event-dslite-deletion-records-sent-failure': Custom Dslite Session Deletion Records Failed; 'custom-session-event-fw4-creation-records-sent': Custom FW4 Session Creation Records Sent; 'custom-session-event-fw4-creation-records-sent-failure': Custom FW4 Session Creation Records Failed; 'custom-session-event-fw6-creation-records-sent': Custom FW6 Session Creation Records Sent; 'custom-session-event-fw6-creation-records-sent-failure': Custom FW6 Session Creation Records Failed; 'custom-session-event-fw4-deletion-records-sent': Custom FW4 Session Deletion Records Sent; 'custom-session-event-fw4-deletion-records-sent-failure': Custom FW4 Session Deletion Records Failed; 'custom-session-event-fw6-deletion-records-sent': Custom FW6 Session Deletion Records Sent; 'custom-session-event-fw6-deletion-records-sent-failure': Custom FW6 Session Deletion Records Failed; 'custom-deny-reset-event-fw4-records-sent': Custom FW4 Deny/Reset Event Records Sent; 'custom-deny-reset-event-fw4-records-sent-failure': Custom FW4 Deny/Reset Event Records Failed; 'custom-deny-reset-event-fw6-records-sent': Custom FW6 Deny/Reset Event Records Sent; 'custom-deny-reset-event-fw6-records-sent-failure': Custom FW6 Deny/Reset Event Records Failed; 'custom-port-mapping-nat44-creation-records-sent': Custom Nat44 Port Map Creation Records Sent; 'custom-port-mapping-nat44-creation-records-sent-failure': Custom Nat44 Port Map Creation Records Failed; 'custom-port-mapping-nat64-creation-records-sent': Custom Nat64 Port Map Creation Records Sent; 'custom-port-mapping-nat64-creation-records-sent-failure': Custom Nat64 Port Map Creation Records Failed; 'custom-port-mapping-dslite-creation-records-sent': Custom Dslite Port Map Creation Records Sent; 'custom-port-mapping-dslite-creation-records-sent-failure': Custom Dslite Port Map Creation Records Failed; 'custom-port-mapping-nat44-deletion-records-sent': Custom Nat44 Port Map Deletion Records Sent; 'custom-port-mapping-nat44-deletion-records-sent-failure': Custom Nat44 Port Map Deletion Records Failed; 'custom-port-mapping-nat64-deletion-records-sent': Custom Nat64 Port Map Deletion Records Sent; 'custom-port-mapping-nat64-deletion-records-sent-failure': Custom Nat64 Port Map Deletion Records Failed; 'custom-port-mapping-dslite-deletion-records-sent': Custom Dslite Port Map Deletion Records Sent; 'custom-port-mapping-dslite-deletion-records-sent-failure': Custom Dslite Port Map Deletion Records Failed; 'custom-port-batching-nat44-creation-records-sent': Custom Nat44 Port Batch Creation Records Sent; 'custom-port-batching-nat44-creation-records-sent-failure': Custom Nat44 Port Batch Creation Records Failed; 'custom-port-batching-nat64-creation-records-sent': Custom Nat64 Port Batch Creation Records Sent; 'custom-port-batching-nat64-creation-records-sent-failure': Custom Nat64 Port Batch Creation Records Failed; 'custom-port-batching-dslite-creation-records-sent': Custom Dslite Port Batch Creation Records Sent; 'custom-port-batching-dslite-creation-records-sent-failure': Custom Dslite Port Batch Creation Records Failed; 'custom-port-batching-nat44-deletion-records-sent': Custom Nat44 Port Batch Deletion Records Sent; 'custom-port-batching-nat44-deletion-records-sent-failure': Custom Nat44 Port Batch Deletion Records Failed; 'custom-port-batching-nat64-deletion-records-sent': Custom Nat64 Port Batch Deletion Records Sent; 'custom-port-batching-nat64-deletion-records-sent-failure': Custom Nat64 Port Batch Deletion Records Failed; 'custom-port-batching-dslite-deletion-records-sent': Custom Dslite Port Batch Deletion Records Sent; 'custom-port-batching-dslite-deletion-records-sent-failure': Custom Dslite Port Batch Deletion Records Failed; 'custom-port-batching-v2-nat44-creation-records-sent': Custom Nat44 Port Batch V2 Creation Records Sent; **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, custom-session-event-nat44-creation-records-sent, custom-session-event-nat44-creation-records-sent-failure, custom-session-event-nat64-creation-records-sent, custom-session-event-nat64-creation-records-sent-failure, custom-session-event-dslite-creation-records-sent, custom-session-event-dslite-creation-records-sent-failure, custom-session-event-nat44-deletion-records-sent, custom-session-event-nat44-deletion-records-sent-failure, custom-session-event-nat64-deletion-records-sent, custom-session-event-nat64-deletion-records-sent-failure, custom-session-event-dslite-deletion-records-sent, custom-session-event-dslite-deletion-records-sent-failure, custom-session-event-fw4-creation-records-sent, custom-session-event-fw4-creation-records-sent-failure, custom-session-event-fw6-creation-records-sent, custom-session-event-fw6-creation-records-sent-failure, custom-session-event-fw4-deletion-records-sent, custom-session-event-fw4-deletion-records-sent-failure, custom-session-event-fw6-deletion-records-sent, custom-session-event-fw6-deletion-records-sent-failure, custom-deny-reset-event-fw4-records-sent, custom-deny-reset-event-fw4-records-sent-failure, custom-deny-reset-event-fw6-records-sent, custom-deny-reset-event-fw6-records-sent-failure, custom-port-mapping-nat44-creation-records-sent, custom-port-mapping-nat44-creation-records-sent-failure, custom-port-mapping-nat64-creation-records-sent, custom-port-mapping-nat64-creation-records-sent-failure, custom-port-mapping-dslite-creation-records-sent, custom-port-mapping-dslite-creation-records-sent-failure, custom-port-mapping-nat44-deletion-records-sent, custom-port-mapping-nat44-deletion-records-sent-failure, custom-port-mapping-nat64-deletion-records-sent, custom-port-mapping-nat64-deletion-records-sent-failure, custom-port-mapping-dslite-deletion-records-sent, custom-port-mapping-dslite-deletion-records-sent-failure, custom-port-batching-nat44-creation-records-sent, custom-port-batching-nat44-creation-records-sent-failure, custom-port-batching-nat64-creation-records-sent, custom-port-batching-nat64-creation-records-sent-failure, custom-port-batching-dslite-creation-records-sent, custom-port-batching-dslite-creation-records-sent-failure, custom-port-batching-nat44-deletion-records-sent, custom-port-batching-nat44-deletion-records-sent-failure, custom-port-batching-nat64-deletion-records-sent, custom-port-batching-nat64-deletion-records-sent-failure, custom-port-batching-dslite-deletion-records-sent, custom-port-batching-dslite-deletion-records-sent-failure, custom-port-batching-v2-nat44-creation-records-sent **counters2** **Description** 'custom-port-batching-v2-nat44-creation-records-sent-failure': Custom Nat44 Port Batch V2 Creation Records Failed; 'custom-port-batching-v2-nat64-creation-records-sent': Custom Nat64 Port Batch V2 Creation Records Sent; 'custom-port-batching-v2-nat64-creation-records-sent-failure': Custom Nat64 Port Batch V2 Creation Records Failed; 'custom-port-batching-v2-dslite-creation-records-sent': Custom Dslite Port Batch V2 Creation Records Sent; 'custom-port-batching-v2-dslite-creation-records-sent-failure': Custom Dslite Port Batch V2 Creation Records Failed; 'custom-port-batching-v2-nat44-deletion-records-sent': Custom Nat44 Port Batch V2 Deletion Records Sent; 'custom-port-batching-v2-nat44-deletion-records-sent-failure': Custom Nat44 Port Batch V2 Deletion Records Failed; 'custom-port-batching-v2-nat64-deletion-records-sent': Custom Nat64 Port Batch V2 Deletion Records Sent; 'custom-port-batching-v2-nat64-deletion-records-sent-failure': Custom Nat64 Port Batch V2 Deletion Records Failed; 'custom-port-batching-v2-dslite-deletion-records-sent': Custom Dslite Port Batch V2 Deletion Records Sent; 'custom-port-batching-v2-dslite-deletion-records-sent-failure': Custom Dslite Port Batch V2 Deletion Records Failed; 'reduced-logs-by-destination': Reduced Logs by Destination Protocol and Port; 'custom-gtp-c-tunnel-event-records-sent': Custom GTP C Tunnel Records Sent; 'custom-gtp-c-tunnel-event-records-sent-failure': Custom GTP C Tunnel Records Sent Failure; 'custom-gtp-u-tunnel-event-records-sent': Custom GTP U Tunnel Records Sent; 'custom-gtp-u-tunnel-event-records-sent-failure': Custom GTP U Tunnel Records Sent Failure; 'custom-gtp-deny-event-records-sent': Custom GTP Deny Records Sent; 'custom-gtp-deny-event-records-sent-failure': Custom GTP Deny Records Sent Failure; 'custom-gtp-info-event-records-sent': Custom GTP Info Records Sent; 'custom-gtp-info-event-records-sent-failure': Custom GTP Info Records Sent Failure; 'custom-fw-iddos-entry-created-records-sent': Custom FW iDDoS Entry Created Records Sent; 'custom-fw-iddos-entry-created-records-sent-failure': Custom FW iDDoS Entry Created Records Sent Failure; 'custom-fw-iddos-entry-deleted-records-sent': Custom FW iDDoS Entry Deleted Records Sent; 'custom-fw-iddos-entry-deleted-records-sent-failure': Custom FW iDDoS Entry Deleted Records Sent Failure; 'custom-fw-sesn-limit-exceeded-records-sent': Custom FW Session Limit Exceeded Records Sent; 'custom-fw-sesn-limit-exceeded-records-sent-failure': Custom FW Session Limit Exceeded Records Sent Failure; 'custom-nat-iddos-l3-entry-created-records-sent': Custom NAT iDDoS L3 Entry Created Records Sent; 'custom-nat-iddos-l3-entry-created-records-sent-failure': Custom NAT iDDoS L3 Entry Created Records Sent Failure; 'custom-nat-iddos-l3-entry-deleted-records-sent': Custom NAT iDDoS L3 Entry Deleted Records Sent; 'custom-nat-iddos-l3-entry-deleted-records-sent-failure': Custom NAT iDDoS L3 Entry Deleted Records Sent Failure; 'custom-nat-iddos-l4-entry-created-records-sent': Custom NAT iDDoS L4 Entry Created Records Sent; 'custom-nat-iddos-l4-entry-created-records-sent-failure': Custom NAT iDDoS L4 Entry Created Records Sent Failure; 'custom-nat-iddos-l4-entry-deleted-records-sent': Custom NAT iDDoS L4 Entry Deleted Records Sent; 'custom-nat-iddos-l4-entry-deleted-records-sent-failure': Custom NAT iDDoS L4 Entry Deleted Records Sent Failure; 'custom-gtp-rate-limit-periodic-records-sent': Custom GTP Rate Limit Periodic Records Sent; 'custom-gtp-rate-limit-periodic-records-sent-failure': Custom GTP Rate Limit Periodic Records Sent Failure; 'ddos-general-stat-records-sent': ddos-general-stat-records-sent; 'ddos-general-stat-records-sent-failure': ddos-general-stat-records-sent-failure; 'ddos-http-stat-records-sent': ddos-http-stat-records-sent; 'ddos-http-stat-records-sent-failure': ddos-http-stat-records-sent-failure; **Type:** string **Supported Values:** custom-port-batching-v2-nat44-creation-records-sent-failure, custom-port-batching-v2-nat64-creation-records-sent, custom-port-batching-v2-nat64-creation-records-sent-failure, custom-port-batching-v2-dslite-creation-records-sent, custom-port-batching-v2-dslite-creation-records-sent-failure, custom-port-batching-v2-nat44-deletion-records-sent, custom-port-batching-v2-nat44-deletion-records-sent-failure, custom-port-batching-v2-nat64-deletion-records-sent, custom-port-batching-v2-nat64-deletion-records-sent-failure, custom-port-batching-v2-dslite-deletion-records-sent, custom-port-batching-v2-dslite-deletion-records-sent-failure, reduced-logs-by-destination, custom-gtp-c-tunnel-event-records-sent, custom-gtp-c-tunnel-event-records-sent-failure, custom-gtp-u-tunnel-event-records-sent, custom-gtp-u-tunnel-event-records-sent-failure, custom-gtp-deny-event-records-sent, custom-gtp-deny-event-records-sent-failure, custom-gtp-info-event-records-sent, custom-gtp-info-event-records-sent-failure, custom-fw-iddos-entry-created-records-sent, custom-fw-iddos-entry-created-records-sent-failure, custom-fw-iddos-entry-deleted-records-sent, custom-fw-iddos-entry-deleted-records-sent-failure, custom-fw-sesn-limit-exceeded-records-sent, custom-fw-sesn-limit-exceeded-records-sent-failure, custom-nat-iddos-l3-entry-created-records-sent, custom-nat-iddos-l3-entry-created-records-sent-failure, custom-nat-iddos-l3-entry-deleted-records-sent, custom-nat-iddos-l3-entry-deleted-records-sent-failure, custom-nat-iddos-l4-entry-created-records-sent, custom-nat-iddos-l4-entry-created-records-sent-failure, custom-nat-iddos-l4-entry-deleted-records-sent, custom-nat-iddos-l4-entry-deleted-records-sent-failure, custom-gtp-rate-limit-periodic-records-sent, custom-gtp-rate-limit-periodic-records-sent-failure, ddos-general-stat-records-sent, ddos-general-stat-records-sent-failure, ddos-http-stat-records-sent, ddos-http-stat-records-sent-failure .. _2311_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 disable template resend based on record-count) **Type:** number **Range:** 0-1000000 **Default:** 1000 **timeout** **Description** To set time interval to resend template (number of seconds: default is 1800, 0 means disable template resend based on timeout) **Type:** number **Range:** 0-86400 **Default:** 1800 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2311_collector: collector ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **template** **Description:** template is a **JSON Block**. Please see below for :ref:`2311_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:`2311_collector_template-detail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/netflow/collector/template-detail ` .. _2311_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 .. _2311_collector_template: collector_template ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2311_collector_template_sampling-enable: collector_template_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'v9-templates-created': Netflow v9 Templates Created; 'v9-templates-deleted': Netflow v9 Templates Deleted; 'v10-templates-created': Netflow v10(IPFIX) Templates Created; 'v10-templates-deleted': Netflow v10(IPFIX) Templates Deleted; 'template-drop-exceeded': Netflow Templates Dropped Maximum Limit Reached; 'template-drop-out-of-memory': Netflow Templates Dropped OOM; 'templates-added-to-delq': Netflow Templates Added To Delete Queue; 'templates-removed-from-delq': Netflow Templates Removed From Delete Queue; **Type:** string **Supported Values:** all, v9-templates-created, v9-templates-deleted, v10-templates-created, v10-templates-deleted, template-drop-exceeded, template-drop-out-of-memory, templates-added-to-delq, templates-removed-from-delq .. _2311_use-partition: use-partition ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **part-name** **Description** Dedicated partition name **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/partition ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2311_template-list: template-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **information-element-blk** **Type:** List **ipfix-template-id** **Description** Custom IPFIX Template ID **Type:** number **Range:** 2001-3000 **name** **Description** IPFIX CUSTOM Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 .. _2311_template-list_information-element-blk: template-list_information-element-blk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **information-element** **Description** 'fwd-tuple-vnp-id': Session forward tuple partition id (ID: 33028); 'rev-tuple-vnp-id': Session reverse tuple partition id (ID: 33029); 'source-ipv4-address': IPv4 source address in the IP packet header (ID: 8); 'source-ipv4-prefix-len': Prefix length for IPv4 source address(ID: 9); 'dest-ipv4-address': IPv4 destination address in the IP packet header (ID: 12); 'dest-ipv4-prefix-len': Prefix length for IPv4 dest address(ID: 13); 'source-ipv6-address': IPv6 source address in the IP packet header (ID: 27); 'source-ipv6-prefix-len': Prefix length for IPv6 source address(ID:29); 'dest-ipv6-address': IPv6 destination address in the IP packet header (ID:28); 'dest-ipv6-prefix-len': Prefix length for IPv6 dest address (ID:30); 'post-nat-source-ipv4-address': IPv4 natted source address (ID: 225); 'post-nat-dest-ipv4-address': IPv4 natted destination address(ID: 226); 'post-nat-source-ipv6-address': IPv6 natted source address (ID: 281); 'post-nat-dest-ipv6-address': IPv6 natted destination address (ID: 282); 'source-port': Source port identifier in the transport header (ID: 7); 'dest-port': Destination port identifier in the transport header (ID: 11); 'post-nat-source-port': L4 natted source port(ID: 227); 'post-nat-dest-port': L4 natted destination port (ID: 228); 'fwd-tuple-type': Session forward tuple type (ID: 33024); 'rev-tuple-type': Session reverse tuple type (ID: 33025); 'ip-proto': Value of the protocol number in the IP packet header (ID: 4); 'flow-direction': Flow direction: 0:inbound(To an outside interface)/1:outbound(To an inside interface) (ID: 61); 'tcp-control-bits': Cumulative of all the TCP flags seen for this flow (ID: 6); 'fwd-bytes': Incoming bytes associated with an IP Flow (ID: 1); 'fwd-packets': Incoming packets associated with an IP Flow (ID: 2); 'rev-bytes': Delta bytes in reverse direction of bidirectional flow record (ID: 32769); 'rev-packets': Delta packets in reverse direction of bidirectional flow record (ID: 32770); 'in-port': Incoming interface port (ID: 10); 'out-port': Outcoming interface port (ID: 14); 'in-interface': Incoming interface name e.g. ethernet 0 (ID: 82); 'out-interface': Outcoming interface name e.g. ethernet 0 (ID: 32850); 'port-range-start': Port number identifying the start of a range of ports (ID: 361); 'port-range-end': Port number identifying the end of a range of ports (ID: 362); 'port-range-step-size': Step size in a port range (ID: 363); 'port-range-num-ports': Number of ports in a port range (ID: 364); 'rule-name': Rule Name (ID: 33034); 'rule-set-name': Rule-Set Name (ID: 33035); 'fw-source-zone': Firewall Source Zone Name (ID: 33036); 'fw-dest-zone': Firewall Dest Zone Name (ID: 33037); 'application-id': Application ID (ID: 95); 'application-name': Application Name (ID: 96); 'imsi': Subscriber Attribute IMSI (ID: 455); 'msisdn': Subscriber Attribute MSISDN (ID: 456); 'imei': Subscriber Attribute IMEI (ID: 33030); 'radius-custom1': Radius Attribute Custom 1 (ID: 33031); 'radius-custom2': Radius Attribute Custom 2(ID: 33032); 'radius-custom3': Radius Attribute Custom 3 (ID:33033); 'radius-custom4': Radius Attribute Custom 4 (ID: 33067); 'radius-custom5': Radius Attribute Custom 5(ID: 33068); 'radius-custom6': Radius Attribute Custom 6 (ID:33069); 'flow-start-msec': The absolute timestamp of the first packet of the flow (ID: 152); 'flow-duration-msec': Difference in time between the first observed packet of this flow and the last observed packet of this flow (4 bytes) (ID: 161); 'flow-duration-msec-64': Difference in time between the first observed packet of this flow and the last observed packet of this flow (8 bytes) (ID: 33039); 'flow-end-msec': The absolute timestamp of the last packet of the flow (ID: 153); 'nat-event': Indicates a NAT event (ID: 230); 'fw-event': Indicates a FW session event(ID: 233); 'fw-deny-reset-event': Indicates a FW deny/reset event (ID: 33038); 'cgn-flow-direction': Flow direction: 0:inbound(To an outside interface)/1:outbound(To an inside interface)/2:hairpin(From an inside interface to an inside interface) (ID: 33040); 'fw-dest-fqdn': Firewall matched fqdn(ID: 33041); 'flow-end-reason': A10 flow end reason(ID: 33042); 'gtp-deny-reason': Indicates a GTP deny event (ID: 33043); 'gtp-apn': Indicates GTP APN (ID: 33044); 'gtp-steid': Indicates GTP Source TEID (ID: 33045); 'gtp-dteid': Indicates GTP Destination TEID (ID: 33046); 'gtp-selection-mode': Indicates GTP Selection Mode (ID: 33047); 'gtp-mcc': Indicates the MCC of the Serving Network (ID: 33048); 'gtp-mnc': Indicates the MNC of the serving network (ID: 33049); 'gtp-rat-type': Indicates the RAT Type received in the GTP Control packet (ID: 33050); 'gtp-pdn-pdp-type': Indicates the PDN/PDP Type in the GTP Control Packet (ID: 33051); 'gtp-uli': Indicates the User Location Information (ID: 33052); 'gtp-enduser-v4-addr': Indicates the Subscriber IPv4 Address (ID: 33053); 'gtp-enduser-v6-addr': Indicates the Subscriber IPv6 Address (ID: 33054); 'gtp-bearer-id-or-nsapi': Indicates the EPS Bearer ID or NSAPI of the Subscriber (ID: 33055); 'gtp-qci': Indicates the QoS Profile or Traffic Class of the subscriber (ID: 33056); 'gtp-info-event-ind': Indicates a GTP Info event(ID: 33057); 'gtp-restarted-node-ipv4': Restarted S5 Node IPV4 Address(ID: 33058); 'gtp-restarted-node-ipv6': Restarted S5 Node IPV6 Address(ID: 33059); 'gtp-c-tunnels-removed-with-node-restart': Indicates GTP-C tunnels removed by Node restart (ID: 33060); 'radius-imsi': Subscriber Attribute IMSI (Deprecated Field) (ID: 455); 'radius-msisdn': Subscriber Attribute MSISDN (Deprecated Field) (ID: 456); 'radius-imei': Subscriber Attribute IMEI (Deprecated Field) (ID: 33030); 'event-time-msec': The absolute time in milliseconds of an event observation(ID: 323); 'security-event-type': Type of security event(ID: 33063); 'limit-exceeded-count': Limit exceeded count for FW concurrent session(ID: 33062); 'rate-limit-key': Rate Limit Key(ID: 33064); 'rate-limit-type': Rate Limit Type(ID: 33065); 'rate-limit-drop-count': Rate Limit Drop Count(ID: 33066); **Type:** string **Supported Values:** fwd-tuple-vnp-id, rev-tuple-vnp-id, source-ipv4-address, source-ipv4-prefix-len, dest-ipv4-address, dest-ipv4-prefix-len, source-ipv6-address, source-ipv6-prefix-len, dest-ipv6-address, dest-ipv6-prefix-len, post-nat-source-ipv4-address, post-nat-dest-ipv4-address, post-nat-source-ipv6-address, post-nat-dest-ipv6-address, source-port, dest-port, post-nat-source-port, post-nat-dest-port, fwd-tuple-type, rev-tuple-type, ip-proto, flow-direction, tcp-control-bits, fwd-bytes, fwd-packets, rev-bytes, rev-packets, in-port, out-port, in-interface, out-interface, port-range-start, port-range-end, port-range-step-size, port-range-num-ports, rule-name, rule-set-name, fw-source-zone, fw-dest-zone, application-id, application-name, imsi, msisdn, imei, radius-custom1, radius-custom2, radius-custom3, radius-custom4, radius-custom5, radius-custom6, flow-start-msec, flow-duration-msec, flow-duration-msec-64, flow-end-msec, nat-event, fw-event, fw-deny-reset-event, cgn-flow-direction, fw-dest-fqdn, flow-end-reason, gtp-deny-reason, gtp-apn, gtp-steid, gtp-dteid, gtp-selection-mode, gtp-mcc, gtp-mnc, gtp-rat-type, gtp-pdn-pdp-type, gtp-uli, gtp-enduser-v4-addr, gtp-enduser-v6-addr, gtp-bearer-id-or-nsapi, gtp-qci, gtp-info-event-ind, gtp-restarted-node-ipv4, gtp-restarted-node-ipv6, gtp-c-tunnels-removed-with-node-restart, radius-imsi, radius-msisdn, radius-imei, event-time-msec, security-event-type, limit-exceeded-count, rate-limit-key, rate-limit-type, rate-limit-drop-count .. _2311_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 **nat44_tpl_1001** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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 **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 .. _2311_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