.. _system_icmp:

system icmp
===========

Display ICMP statistics


icmp Specification
------------------

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

	 **Element Name**                      icmp

	 **Element URI**                       /axapi/v3/system/icmp

	 **Element Attributes**                icmp_attributes

	 **Statistics Data URI**               /axapi/v3/system/icmp/stats

	 **Schema**                             :download:`icmp schema <system-icmp/system-icmp.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/system/icmp



.. raw:: html

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


:ref:`1604_icmp_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/system_icmp_POST.txt
   :literal:




.. raw:: html

   </div></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/system/icmp



.. raw:: html

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


:ref:`1604_icmp_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/system_icmp_GET.txt
   :literal:




.. raw:: html

   </div></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/system/icmp



.. raw:: html

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


:ref:`1604_icmp_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/system/icmp



.. raw:: html

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


:ref:`1604_icmp_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/system_icmp_PUT.txt
   :literal:




.. raw:: html

   </div></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/system/icmp



.. raw:: html

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


:ref:`1604_icmp_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/system_icmp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1604_icmp_attributes:

icmp attributes
---------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1604_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'num': Total number; 'inmsgs': In Messages; 'inerrors': In Errors; 'indestunreachs': In Destination Unreachable; 'intimeexcds': In TTL Exceeds; 'inparmprobs': In Parameter Problem; 'insrcquenchs': In Source Quench Error; 'inredirects': In Redirects; 'inechos': In Echo requests; 'inechoreps': In Echo replies; 'intimestamps': In Timestamp; 'intimestampreps': In Timestamp Rep; 'inaddrmasks': In Address Masks; 'inaddrmaskreps': In Address Mask Rep; 'outmsgs': Out Message; 'outerrors': Out Errors; 'outdestunreachs': Out Destination Unreachable; 'outtimeexcds': Out TTL Exceeds; 'outparmprobs': Out Parameter Problem; 'outsrcquenchs': Out Source Quench Error; 'outredirects': Out Redirects; 'outechos': Out Echo Requests; 'outechoreps': Out Echo Replies; 'outtimestamps': Out Time Stamp; 'outtimestampreps': Out Time Stamp Rep; 'outaddrmasks': Out Address Mask; 'outaddrmaskreps': Out Address Mask Rep; 

        **Type:** string

        **Supported Values:** all, num, inmsgs, inerrors, indestunreachs, intimeexcds, inparmprobs, insrcquenchs, inredirects, inechos, inechoreps, intimestamps, intimestampreps, inaddrmasks, inaddrmaskreps, outmsgs, outerrors, outdestunreachs, outtimeexcds, outparmprobs, outsrcquenchs, outredirects, outechos, outechoreps, outtimestamps, outtimestampreps, outaddrmasks, outaddrmaskreps

.. _1604_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - inechoreps
      - 2
      - In Echo replies

   *  - 
      - outaddrmaskreps
      - 2
      - Out Address Mask Rep

   *  - 
      - outtimestampreps
      - 2
      - Out Time Stamp Rep

   *  - 
      - inechos
      - 2
      - In Echo requests

   *  - 
      - num
      - 2
      - Total number

   *  - 
      - intimestampreps
      - 2
      - In Timestamp Rep

   *  - 
      - outechos
      - 2
      - Out Echo Requests

   *  - 
      - inaddrmasks
      - 2
      - In Address Masks

   *  - 
      - outsrcquenchs
      - 2
      - Out Source Quench Error

   *  - 
      - inerrors
      - 2
      - In Errors

   *  - 
      - inaddrmaskreps
      - 2
      - In Address Mask Rep

   *  - 
      - outmsgs
      - 2
      - Out Message

   *  - 
      - outtimestamps
      - 2
      - Out Time Stamp

   *  - 
      - outaddrmasks
      - 2
      - Out Address Mask

   *  - 
      - inparmprobs
      - 2
      - In Parameter Problem

   *  - 
      - insrcquenchs
      - 2
      - In Source Quench Error

   *  - 
      - inredirects
      - 2
      - In Redirects

   *  - 
      - outerrors
      - 2
      - Out Errors

   *  - 
      - inmsgs
      - 2
      - In Messages

   *  - 
      - outtimeexcds
      - 2
      - Out TTL Exceeds

   *  - 
      - outredirects
      - 2
      - Out Redirects

   *  - 
      - indestunreachs
      - 2
      - In Destination Unreachable

   *  - 
      - intimeexcds
      - 2
      - In TTL Exceeds

   *  - 
      - outparmprobs
      - 2
      - Out Parameter Problem

   *  - 
      - intimestamps
      - 2
      - In Timestamp

   *  - 
      - outechoreps
      - 2
      - Out Echo Replies

   *  - 
      - outdestunreachs
      - 2
      - Out Destination Unreachable