.. _ip_frag:

ip frag
=======

IP fragmentation parameters


frag Specification
------------------

	===================================== ================================================
	===================================== ================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      frag

	 **Element URI**                       /axapi/v3/ip/frag

	 **Element Attributes**                frag_attributes

	 **Statistics Data URI**               /axapi/v3/ip/frag/stats

	 **Schema**                             :download:`frag schema <ip-frag/ip-frag.txt>`
	===================================== ================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ip/frag



.. raw:: html

   </td><td valign = 'top'>


:ref:`1176_frag_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ip/frag



.. raw:: html

   </td><td valign = 'top'>


:ref:`1176_frag_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ip/frag



.. raw:: html

   </td><td valign = 'top'>


:ref:`1176_frag_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ip/frag



.. raw:: html

   </td><td valign = 'top'>


:ref:`1176_frag_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ip/frag



.. raw:: html

   </td><td valign = 'top'>


:ref:`1176_frag_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1176_frag_attributes:

frag attributes
---------------

    **buff**

        **Description** Max buff used for fragmentation (Buffer Value(10000-3000000))

        **Type:** number

        **Range:** 10000-3000000

    **cpu-threshold**

        **Description:** cpu-threshold is a **JSON Block**.  Please see below for :ref:`1176_cpu-threshold` 

        **Type:** Object

    **max-packets-per-reassembly**

        **Description** Max number of fragmented packets allowed per reassembly(0 is unlimited) (default 0)

        **Type:** number

        **Range:** 2-16

    **max-reassembly-sessions**

        **Description** Max number of pending reassembly sessions allowed (default 100000)

        **Type:** number

        **Range:** 1-200000

    **sampling-enable**

        **Type:** List

    **timeout**

        **Description** Fragmentation timeout (in milliseconds 4 - 65535 (default is 60000))

        **Type:** number

        **Range:** 4-65535

        **Default:** 60000

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1176_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **counters1**

        **Description** 'all': all; 'session-inserted': Session Inserted; 'session-expired': Session Expired; 'icmp-rcv': ICMP Received; 'icmpv6-rcv': ICMPv6 Received; 'udp-rcv': UDP Received; 'tcp-rcv': TCP Received; 'ipip-rcv': IP-in-IP Received; 'ipv6ip-rcv': IPv6-in-IP Received; 'other-rcv': Other Received; 'icmp-dropped': ICMP Dropped; 'icmpv6-dropped': ICMPv6 Dropped; 'udp-dropped': UDP Dropped; 'tcp-dropped': TCP Dropped; 'ipip-dropped': IP-in-IP Dropped; 'ipv6ip-dropped': IPv6-in-IP Dropped; 'other-dropped': Other Dropped; 'overlap-error': Overlapping Fragment Dropped; 'bad-ip-len': Bad IP Length; 'too-small': Fragment Too Small Drop; 'first-tcp-too-small': First TCP Fragment Too Small Drop; 'first-l4-too-small': First L4 Fragment Too Small Drop; 'total-sessions-exceeded': Total Sessions Exceeded Drop; 'no-session-memory': Out of Session Memory; 'fast-aging-set': Fragmentation Fast Aging Set; 'fast-aging-unset': Fragmentation Fast Aging Unset; 'fragment-queue-success': Fragment Queue Success; 'unaligned-len': Payload Length Unaligned; 'exceeded-len': Payload Length Out of Bounds; 'duplicate-first-frag': Duplicate First Fragment; 'duplicate-last-frag': Duplicate Last Fragment; 'total-fragments-exceeded': Total Queued Fragments Exceeded; 'fragment-queue-failure': Fragment Queue Failure; 'reassembly-success': Fragment Reassembly Success; 'max-len-exceeded': Fragment Max Data Length Exceeded; 'reassembly-failure': Fragment Reassembly Failure; 'policy-drop': MTU Exceeded Policy Drop; 'error-drop': Fragment Processing Drop; 'high-cpu-threshold': High CPU Threshold Reached; 'low-cpu-threshold': Low CPU Threshold Reached; 'cpu-threshold-drop': High CPU Drop; 'ipd-entry-drop': DDoS Protection Drop; 'max-packets-exceeded': Too Many Packets Per Reassembly Drop; 'session-packets-exceeded': Session Max Packets Exceeded; 'frag-session-count': Fragmentation Session Count; 'sctp-rcv': SCTP Received; 'sctp-dropped': SCTP Dropped; 'first-gtp-packet-too-small': First GTP Fragment Too Small Drop; 

        **Type:** string

        **Supported Values:** all, session-inserted, session-expired, icmp-rcv, icmpv6-rcv, udp-rcv, tcp-rcv, ipip-rcv, ipv6ip-rcv, other-rcv, icmp-dropped, icmpv6-dropped, udp-dropped, tcp-dropped, ipip-dropped, ipv6ip-dropped, other-dropped, overlap-error, bad-ip-len, too-small, first-tcp-too-small, first-l4-too-small, total-sessions-exceeded, no-session-memory, fast-aging-set, fast-aging-unset, fragment-queue-success, unaligned-len, exceeded-len, duplicate-first-frag, duplicate-last-frag, total-fragments-exceeded, fragment-queue-failure, reassembly-success, max-len-exceeded, reassembly-failure, policy-drop, error-drop, high-cpu-threshold, low-cpu-threshold, cpu-threshold-drop, ipd-entry-drop, max-packets-exceeded, session-packets-exceeded, frag-session-count, sctp-rcv, sctp-dropped, first-gtp-packet-too-small

.. _1176_cpu-threshold:

cpu-threshold
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **high**

        **Description** When CPU usage reaches this value, it will stop processing fragments (default: 75%)

        **Type:** number

        **Range:** 0-100

        **Default:** 75

    **low**

        **Description** When CPU usage remains under this value, it will resume processing fragments (default: 60%)

        **Type:** number

        **Range:** 0-100

        **Default:** 60

.. _1176_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - cpu-threshold-drop
      - 8
      - High CPU Drop

   *  - 
      - icmpv6-rcv
      - 8
      - ICMPv6 Received

   *  - 
      - tcp-rcv
      - 8
      - TCP Received

   *  - 
      - other-rcv
      - 8
      - Other Received

   *  - 
      - udp-dropped
      - 8
      - UDP Dropped

   *  - 
      - bad-ip-len
      - 8
      - Bad IP Length

   *  - 
      - first-l4-too-small
      - 8
      - First L4 Fragment Too Small Drop

   *  - 
      - no-session-memory
      - 8
      - Out of Session Memory

   *  - 
      - unaligned-len
      - 8
      - Payload Length Unaligned

   *  - 
      - icmp-dropped
      - 8
      - ICMP Dropped

   *  - 
      - udp-rcv
      - 8
      - UDP Received

   *  - 
      - exceeded-len
      - 8
      - Payload Length Out of Bounds

   *  - 
      - fragment-queue-success
      - 8
      - Fragment Queue Success

   *  - 
      - first-gtp-packet-too-small
      - 8
      - First GTP Fragment Too Small Drop

   *  - 
      - fragment-queue-failure
      - 8
      - Fragment Queue Failure

   *  - 
      - total-fragments-exceeded
      - 8
      - Total Queued Fragments Exceeded

   *  - 
      - tcp-dropped
      - 8
      - TCP Dropped

   *  - 
      - low-cpu-threshold
      - 8
      - Low CPU Threshold Reached

   *  - 
      - ipip-dropped
      - 8
      - IP-in-IP Dropped

   *  - 
      - total-sessions-exceeded
      - 8
      - Total Sessions Exceeded Drop

   *  - 
      - error-drop
      - 8
      - Fragment Processing Drop

   *  - 
      - overlap-error
      - 8
      - Overlapping Fragment Dropped

   *  - 
      - ipv6ip-rcv
      - 8
      - IPv6-in-IP Received

   *  - 
      - session-expired
      - 8
      - Session Expired

   *  - 
      - sctp-rcv
      - 8
      - SCTP Received

   *  - 
      - policy-drop
      - 8
      - MTU Exceeded Policy Drop

   *  - 
      - icmp-rcv
      - 8
      - ICMP Received

   *  - 
      - session-packets-exceeded
      - 8
      - Session Max Packets Exceeded

   *  - 
      - duplicate-first-frag
      - 8
      - Duplicate First Fragment

   *  - 
      - reassembly-success
      - 8
      - Fragment Reassembly Success

   *  - 
      - sctp-dropped
      - 8
      - SCTP Dropped

   *  - 
      - ipd-entry-drop
      - 8
      - DDoS Protection Drop

   *  - 
      - too-small
      - 8
      - Fragment Too Small Drop

   *  - 
      - ipv6ip-dropped
      - 8
      - IPv6-in-IP Dropped

   *  - 
      - session-inserted
      - 8
      - Session Inserted

   *  - 
      - max-len-exceeded
      - 8
      - Fragment Max Data Length Exceeded

   *  - 
      - max-packets-exceeded
      - 8
      - Too Many Packets Per Reassembly Drop

   *  - 
      - other-dropped
      - 8
      - Other Dropped

   *  - 
      - first-tcp-too-small
      - 8
      - First TCP Fragment Too Small Drop

   *  - 
      - high-cpu-threshold
      - 8
      - High CPU Threshold Reached

   *  - 
      - fast-aging-set
      - 8
      - Fragmentation Fast Aging Set

   *  - 
      - ipip-rcv
      - 8
      - IP-in-IP Received

   *  - 
      - icmpv6-dropped
      - 8
      - ICMPv6 Dropped

   *  - 
      - fast-aging-unset
      - 8
      - Fragmentation Fast Aging Unset

   *  - 
      - reassembly-failure
      - 8
      - Fragment Reassembly Failure

   *  - 
      - duplicate-last-frag
      - 8
      - Duplicate Last Fragment