.. _axdebug_filter_config:

axdebug filter-config
=====================

Global debug filter


filter-config Specification
---------------------------

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

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

	 **Object Key(s)**                     *number*

	 **Collection Name**                   :ref:`213_filter-config_list`

	 **Collection URI**                    /axapi/v3/axdebug/filter-config

	                                       

	 **Element Name**                      filter-config

	 **Element URI**                       /axapi/v3/axdebug/filter-config/{number}

	 **Element Attributes**                filter-config_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`filter-config schema <axdebug-filter-config/axdebug-filter-config.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/axdebug/filter-config



.. raw:: html

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


:ref:`213_filter-config_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/axdebug_filter_config_POST.txt
   :literal:




.. raw:: html

   </div></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/axdebug/filter-config



.. raw:: html

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


:ref:`213_filter-config_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/axdebug/filter-config/{number}



.. raw:: html

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


:ref:`213_filter-config_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/axdebug_filter_config_GET.txt
   :literal:




.. raw:: html

   </div></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/axdebug/filter-config



.. raw:: html

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


:ref:`213_filter-config_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/axdebug/filter-config/{number}



.. raw:: html

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


:ref:`213_filter-config_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/axdebug/filter-config/{number}



.. raw:: html

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


:ref:`213_filter-config_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/axdebug/filter-config



.. raw:: html

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


:ref:`213_filter-config_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/axdebug/filter-config/{number}



.. raw:: html

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


:ref:`213_filter-config_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _213_filter-config_list:

filter-config-list
------------------


    filter-config-list is **JSON List** of :ref:`213_filter-config_attributes` 

        filter-config-list : [

             { :ref:`213_filter-config_attributes` },

             { :ref:`213_filter-config_attributes` },

             ...

         ]

.. _213_filter-config_attributes:

filter-config attributes
------------------------

    **WORD0**

        **Description** WORD0 to compare

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** WORD0, hex, and integer are mutually exclusive

    **WORD1**

        **Description** WORD min value

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **WORD2**

        **Description** WORD max value

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **comp-hex**

        **Description** value to compare

        **Type:** string

        **Format:** time-hh:mm

        **Maximum Length:** 2 characters

        **Maximum Length:** 1 characters

    **dst**

        **Description** Destination

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** dst and l3-proto are mutually exclusive

    **dst-ip**

        **Description** dest IP

        **Type:** boolean

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

        **Default:** 0

    **dst-ipv4-address**

        **Description** dest ip address

        **Type:** string

        **Format:** ipv4-address

    **dst-mac**

        **Description** dest mac address

        **Type:** boolean

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

        **Default:** 0

    **dst-mac-addr**

        **Description** dest mac address

        **Type:** string

        **Format:** mac-address

    **dst-port**

        **Description** dest port number

        **Type:** boolean

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

        **Default:** 0

    **dst-port-num**

        **Description** dest Port number

        **Type:** number

        **Range:** 1-65535

    **hex**

        **Description** Define hex value

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** hex,integer,  word, and WORD0 are mutually exclusive

    **integer**

        **Description** Define decimal value

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** integer,hex,  word, and WORD0 are mutually exclusive

    **integer-comp**

        **Description** value to compare

        **Type:** number

        **Range:** 1-255

    **integer-max**

        **Description** max value

        **Type:** number

        **Range:** 1-255

    **integer-min**

        **Description** min value

        **Type:** number

        **Range:** 1-255

    **ip**

        **Description** IP

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** ip, l3-proto, and ipv6 are mutually exclusive

    **ipv4-address**

        **Description** ip address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

    **ipv6**

        **Description** IPV6

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** ipv6, l3-proto, and ip are mutually exclusive

    **ipv6-address**

        **Description** ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **l3-proto**

        **Description** 'arp': arp; 'neighbor': neighbor; 

        **Type:** string

        **Supported Values:** arp, neighbor

        **Mutual Exclusion:** l3-proto,dst, src, ip, ipv6, mac, port,  proto, and offset are mutually exclusive

    **length**

        **Description** byte length

        **Type:** number

        **Range:** 1-65535

    **mac**

        **Description** mac address

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** mac and l3-proto are mutually exclusive

    **mac-addr**

        **Description** mac address

        **Type:** string

        **Format:** mac-address

    **max-hex**

        **Description**  max value

        **Type:** string

        **Format:** time-hh:mm

        **Maximum Length:** 2 characters

        **Maximum Length:** 1 characters

    **min-hex**

        **Description**  min value

        **Type:** string

        **Format:** time-hh:mm

        **Maximum Length:** 2 characters

        **Maximum Length:** 1 characters

    **number**

        **Description** Specify filter id

        **Type:** number

        **Range:** 1-32

    **offset**

        **Description** byte offset

        **Type:** number

        **Range:** 0-65535

        **Mutual Exclusion:** offset and l3-proto are mutually exclusive

    **oper-range**

        **Description** 'gt': greater than; 'gte': greater than or equal to; 'se': smaller than or equal to; 'st': smaller than; 'eq': equal to; 'range': select a range; 

        **Type:** string

        **Supported Values:** gt, gte, se, st, eq, range

    **port**

        **Description** port configurations

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** port and l3-proto are mutually exclusive

    **port-num-max**

        **Description** max port number

        **Type:** number

        **Range:** 1-65535

    **port-num-min**

        **Description** min port number

        **Type:** number

        **Range:** 1-65535

    **prot-num**

        **Description** protocol number

        **Type:** number

        **Range:** 1-255

        **Mutual Exclusion:** prot-num and proto-val are mutually exclusive

    **proto**

        **Description** ip protocol number

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** proto and l3-proto are mutually exclusive

    **proto-val**

        **Description** 'icmp': icmp; 'icmpv6': icmpv6; 'tcp': tcp; 'udp': udp; 

        **Type:** string

        **Supported Values:** icmp, icmpv6, tcp, udp

        **Mutual Exclusion:** proto-val and prot-num are mutually exclusive

    **src**

        **Description** Src

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** src and l3-proto are mutually exclusive

    **src-ip**

        **Description** src IP

        **Type:** boolean

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

        **Default:** 0

    **src-ipv4-address**

        **Description** src ip address

        **Type:** string

        **Format:** ipv4-address

    **src-mac**

        **Description** src mac address

        **Type:** boolean

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

        **Default:** 0

    **src-mac-addr**

        **Description** src mac address

        **Type:** string

        **Format:** mac-address

    **src-port**

        **Description** src port number

        **Type:** boolean

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

        **Default:** 0

    **src-port-num**

        **Description** src Port number

        **Type:** number

        **Range:** 1-65535

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **word**

        **Description** Define hex value

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** word, hex, and integer are mutually exclusive