.. _flowspec_icmp_code:

flowspec icmp-code
==================

Configure ICMP Code for a Flowspec


icmp-code Specification
-----------------------

	===================================== ===============================================================================================
	 **Parameter**                         **Value** 

	===================================== ===============================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *icmp-code-attribute, code*

	 **Collection Name**                   :ref:`1592_icmp-code_list`

	 **Collection URI**                    /axapi/v3/flowspec/{name}/icmp-code

	                                       

	 **Element Name**                      icmp-code

	 **Element URI**                       /axapi/v3/flowspec/{name}/icmp-code/{icmp-code-attribute}+{code}

	 **Element Attributes**                icmp-code_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`icmp-code schema <flowspec-icmp-code/flowspec-icmp-code.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/flowspec/{name}/icmp-code



.. raw:: html

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


:ref:`1592_icmp-code_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/flowspec/{name}/icmp-code



.. raw:: html

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


:ref:`1592_icmp-code_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/flowspec/{name}/icmp-code/{icmp-code-attribute}+{code}



.. raw:: html

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


:ref:`1592_icmp-code_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/flowspec/{name}/icmp-code



.. raw:: html

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


:ref:`1592_icmp-code_list`



.. 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/flowspec/{name}/icmp-code/{icmp-code-attribute}+{code}



.. raw:: html

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


:ref:`1592_icmp-code_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/flowspec/{name}/icmp-code/{icmp-code-attribute}+{code}



.. raw:: html

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


:ref:`1592_icmp-code_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/flowspec/{name}/icmp-code



.. raw:: html

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


:ref:`1592_icmp-code_list`



.. 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/flowspec/{name}/icmp-code/{icmp-code-attribute}+{code}



.. raw:: html

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


:ref:`1592_icmp-code_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1592_icmp-code_list:

icmp-code-list
--------------


    icmp-code-list is **JSON List** of :ref:`1592_icmp-code_attributes` 

        icmp-code-list : [

             { :ref:`1592_icmp-code_attributes` },

             { :ref:`1592_icmp-code_attributes` },

             ...

         ]

.. _1592_icmp-code_attributes:

icmp-code attributes
--------------------

    **code**

        **Description** Specify the ICMP Code

        **Type:** number

        **Range:** 0-255

    **code-end**

        **Description** Specify the ICMP Code

        **Type:** number

        **Range:** 1-255

    **icmp-code-attribute**

        **Description** 'eq': Match only packets on a given ICMP Code; 'gt': Match only packets with a greater ICMP Code; 'lt': Match only packets with a lower ICMP Code; 'range': match only packets in the range of ICMP Codes; 

        **Type:** string

        **Supported Values:** eq, gt, lt, range

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters