.. _netflow_monitor: netflow monitor =============== Configure NetFlow Monitor monitor Specification --------------------- ===================================== =============================================================== **Parameter** **Value** ===================================== =============================================================== **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`2308_monitor_list` **Collection URI** /axapi/v3/netflow/monitor **Element Name** monitor **Element URI** /axapi/v3/netflow/monitor/{name} **Element Attributes** monitor_attributes **Partition Visibility** shared **Statistics Data URI** /axapi/v3/netflow/monitor/{name}/stats **Operational Data URI** /axapi/v3/netflow/monitor/{name}/oper **Schema** :download:`monitor schema ` ===================================== =============================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/netflow/monitor .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/netflow/monitor .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/netflow/monitor/{name} .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/netflow/monitor .. raw:: html :ref:`2308_monitor_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/netflow/monitor/{name} .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/netflow/monitor/{name} .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/netflow/monitor .. raw:: html :ref:`2308_monitor_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/netflow/monitor/{name} .. raw:: html :ref:`2308_monitor_attributes` .. raw:: html
.. _2308_monitor_list: monitor-list ------------ monitor-list is **JSON List** of :ref:`2308_monitor_attributes` monitor-list : [ { :ref:`2308_monitor_attributes` }, { :ref:`2308_monitor_attributes` }, ... ] .. _2308_monitor_attributes: monitor attributes ------------------ **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:`2308_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:`2308_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:`2308_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:`2308_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:`2308_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:`2308_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:`2308_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 .. _2308_custom-record: 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 .. _2308_custom-record_custom-cfg: 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 ` .. _2308_sample: 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} ` .. _2308_sample_ve-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 ` .. _2308_sample_nat-pool-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 .. _2308_sample_ethernet-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 .. _2308_source-address: 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 .. _2308_destination: destination ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-cfg** **Description:** ip-cfg is a **JSON Block**. Please see below for :ref:`2308_destination_ip-cfg` **Type:** Object **ipv6-cfg** **Description:** ipv6-cfg is a **JSON Block**. Please see below for :ref:`2308_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 .. _2308_destination_ip-cfg: 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 .. _2308_destination_ipv6-cfg: 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 .. _2308_disable-log-by-destination: 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 .. _2308_disable-log-by-destination_ip-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 .. _2308_disable-log-by-destination_ip-list_tcp-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 .. _2308_disable-log-by-destination_ip-list_udp-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 .. _2308_disable-log-by-destination_tcp-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 .. _2308_disable-log-by-destination_ip6-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 .. _2308_disable-log-by-destination_ip6-list_tcp-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 .. _2308_disable-log-by-destination_ip6-list_udp-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 .. _2308_disable-log-by-destination_udp-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 .. _2308_record: 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 .. _2308_sampling-enable: 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 .. _2308_resend-template: 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