.. _flowspec_protocol:

flowspec protocol
=================

Configure Protocol for a Flowspec


protocol Specification
----------------------

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

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

	 **Object Key(s)**                     *proto-attribute, proto-num*

	 **Collection Name**                   :ref:`1597_protocol_list`

	 **Collection URI**                    /axapi/v3/flowspec/{name}/protocol

	                                       

	 **Element Name**                      protocol

	 **Element URI**                       /axapi/v3/flowspec/{name}/protocol/{proto-attribute}+{proto-num}

	 **Element Attributes**                protocol_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`protocol schema <flowspec-protocol/flowspec-protocol.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}/protocol



.. raw:: html

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


:ref:`1597_protocol_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}/protocol



.. raw:: html

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


:ref:`1597_protocol_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}/protocol/{proto-attribute}+{proto-num}



.. raw:: html

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


:ref:`1597_protocol_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}/protocol



.. raw:: html

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


:ref:`1597_protocol_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}/protocol/{proto-attribute}+{proto-num}



.. raw:: html

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


:ref:`1597_protocol_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}/protocol/{proto-attribute}+{proto-num}



.. raw:: html

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


:ref:`1597_protocol_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}/protocol



.. raw:: html

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


:ref:`1597_protocol_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}/protocol/{proto-attribute}+{proto-num}



.. raw:: html

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


:ref:`1597_protocol_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1597_protocol_list:

protocol-list
-------------


    protocol-list is **JSON List** of :ref:`1597_protocol_attributes` 

        protocol-list : [

             { :ref:`1597_protocol_attributes` },

             { :ref:`1597_protocol_attributes` },

             ...

         ]

.. _1597_protocol_attributes:

protocol attributes
-------------------

    **proto-attribute**

        **Description** 'eq': Match only packets on a given protocol; 'gt': Match only packets with a greater protocol number; 'lt': Match only packets with a lower protocol number; 'range': match only packets in the range of protocol numbers; 

        **Type:** string

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

    **proto-num**

        **Description** Specify the protocol number(6 for TCP and 17 for UDP)

        **Type:** number

        **Range:** 0-255

    **proto-num-end**

        **Description** Specify the protocol number

        **Type:** number

        **Range:** 1-255

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters