.. _flowspec_filtering_action:

flowspec filtering-action
=========================

Configure Filtering Actions for a Flowspec


filtering-action Specification
------------------------------

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

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

	 **Element Name**                      filtering-action

	 **Element URI**                       /axapi/v3/flowspec/{name}/filtering-action

	 **Element Attributes**                filtering-action_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1590_filtering-action_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/flowspec_filtering_action_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/flowspec/{name}/filtering-action



.. raw:: html

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


:ref:`1590_filtering-action_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/flowspec_filtering_action_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/flowspec/{name}/filtering-action



.. raw:: html

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


:ref:`1590_filtering-action_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}/filtering-action



.. raw:: html

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


:ref:`1590_filtering-action_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/flowspec_filtering_action_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/flowspec/{name}/filtering-action



.. raw:: html

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


:ref:`1590_filtering-action_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/flowspec_filtering_action_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1590_filtering-action_attributes:

filtering-action attributes
---------------------------

    **copy-ip-host**

        **Description** Copy bit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **copy-ip-host-nlri**

        **Description** Copy bit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **copy-ipv6-host**

        **Description** Copy bit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **copy-ipv6-host-nlri**

        **Description** Copy bit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **dscp-val**

        **Description** Set DSCP value

        **Type:** number

        **Range:** 1-63

    **ecomm-custom-hex**

        **Description** Custom Extended Community in Hex

        **Type:** string

        **Maximum Length:** 48 characters

        **Maximum Length:** 2 characters

    **ip-host**

        **Description** IPv4 host address

        **Type:** string

        **Format:** ipv4-address

    **ip-host-nlri**

        **Description** IPv4 host address

        **Type:** string

        **Format:** ipv4-address

    **ip-host-rt**

        **Description** Type 0x8108 - Route Target IPv4

        **Type:** string

        **Format:** ipv4-address

    **ipv6-host**

        **Description** IPv6 host address

        **Type:** string

        **Format:** ipv6-address

    **ipv6-host-nlri**

        **Description** IPv6 host address

        **Type:** string

        **Format:** ipv6-address

    **next-hop-nlri-type**

        **Description** 'ip': Type 0x0800 - IPv4 Address; 'ipv6': Type 0x0800 - IPv6 Address; 

        **Type:** string

        **Supported Values:** ip, ipv6

    **next-hop-type**

        **Description** 'ip': Type 0x0800 - IPv4 Address; 'ipv6': Type 0x0800 - IPv6 Address; 

        **Type:** string

        **Supported Values:** ip, ipv6

    **redirect**

        **Description** 'next-hop-nlri': Type 0x0800 - IP encoded in MP_REACH_NLRI Next-hop network; 'next-hop': Type 0x0800 - Extended community Next-hop (Per v2 dated Feb 2015); 'vrf-route-target': Type 0x8008 - Redirect to VRF Route Target; 

        **Type:** string

        **Supported Values:** next-hop-nlri, next-hop, vrf-route-target

    **sample-log**

        **Description** Enable traffic sampling and logging

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **terminal-action**

        **Description** Evaluation stops after this rule if not set

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **traffic-class**

        **Description** Set IPv6 Traffic Class value

        **Type:** number

        **Range:** 1-128

    **traffic-marking**

        **Description** 'dscp': IPv4 DSCP; 'ipv6-traffic-class': IPv6 Traffic Class; 

        **Type:** string

        **Supported Values:** dscp, ipv6-traffic-class

    **traffic-rate**

        **Description** Type 0x8006 - Apply rate (in Bytes per second) for this class of traffic

        **Type:** number

        **Range:** 0-4294967295

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value-ip-host**

        **Description** 2-byte decimal value(local-administrator)

        **Type:** number

        **Range:** 1-65535

    **vrf-target-ip**

        **Description** 'ip': Type 0x8108 - Redirect to route-target IP; 

        **Type:** string

        **Supported Values:** ip

        **Mutual Exclusion:** vrf-target-ip and vrf-target-string are mutually exclusive

    **vrf-target-string**

        **Description** Type 0x8008(ASN-2:Index), 0x8208(ASN-4:Index) - Route Target AS

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** vrf-target-string and vrf-target-ip are mutually exclusive