.. _flowspec_port:

flowspec port
=============

Configure Port for a Flowspec


port Specification
------------------

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

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

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

	 **Collection Name**                   :ref:`1596_port_list`

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

	                                       

	 **Element Name**                      port

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

	 **Element Attributes**                port_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1596_port_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}/port



.. raw:: html

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


:ref:`1596_port_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}/port/{port-attribute}+{port-num}



.. raw:: html

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


:ref:`1596_port_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}/port



.. raw:: html

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


:ref:`1596_port_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}/port/{port-attribute}+{port-num}



.. raw:: html

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


:ref:`1596_port_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}/port/{port-attribute}+{port-num}



.. raw:: html

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


:ref:`1596_port_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}/port



.. raw:: html

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


:ref:`1596_port_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}/port/{port-attribute}+{port-num}



.. raw:: html

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


:ref:`1596_port_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1596_port_list:

port-list
---------


    port-list is **JSON List** of :ref:`1596_port_attributes` 

        port-list : [

             { :ref:`1596_port_attributes` },

             { :ref:`1596_port_attributes` },

             ...

         ]

.. _1596_port_attributes:

port attributes
---------------

    **port-attribute**

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

        **Type:** string

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

    **port-num**

        **Description** Specify the port number

        **Type:** number

        **Range:** 1-65535

    **port-num-end**

        **Description** Specify the port number

        **Type:** number

        **Range:** 2-65535

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters