.. _axdebug:

axdebug
=======

Packet Trace Options


axdebug Specification
---------------------

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

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

	 **Element Name**                      axdebug

	 **Element URI**                       /axapi/v3/axdebug

	 **Element Attributes**                axdebug_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`216_axdebug_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_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/axdebug



.. raw:: html

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


:ref:`216_axdebug_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_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/axdebug



.. raw:: html

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


:ref:`216_axdebug_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



.. raw:: html

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


:ref:`216_axdebug_attributes`



.. 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



.. raw:: html

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


:ref:`216_axdebug_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _216_axdebug_attributes:

axdebug attributes
------------------

    **apply-config**

        **Description:** apply-config is a **JSON Block**.  Please see below for :ref:`216_apply-config` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/apply-config <axdebug_apply_config>`

    **capture**

        **Description:** capture is a **JSON Block**.  Please see below for :ref:`216_capture` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/capture <axdebug_capture>`

    **count**

        **Description** Maximum packets to capture per cpu. Default is 3000. (Maximum packets to capture. For umlimited, specify 0)

        **Type:** number

        **Range:** 0-65535

        **Default:** 3000

    **delete**

        **Description:** delete is a **JSON Block**.  Please see below for :ref:`216_delete` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/delete <axdebug_delete>`

    **exit**

        **Description:** exit is a **JSON Block**.  Please see below for :ref:`216_exit` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/exit <axdebug_exit>`

    **filter-config-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/axdebug/filter-config/{number} <axdebug_filter_config>`

    **inc-port-num**

        **Description** Port Numbers separated by commas(,) and hyphens(-) without spaces. ex: 4,5,10-30, or separated by spaces and double-quoted(")

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 511 characters

        **Maximum Length:** 1 characters

    **incoming**

        **Description** Incoming interface. (For all ports, don't specify port number.)

        **Type:** boolean

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

        **Default:** 0

    **length**

        **Description** Packet length to capture

        **Type:** number

        **Range:** 64-12000

        **Default:** 1518

    **maxfile**

        **Description** Maximum number of debug packet files. Default is 100

        **Type:** number

        **Range:** 1-65535

        **Default:** 100

    **out-port-num**

        **Description** Port Numbers separated by commas(,) and hyphens(-) without spaces. ex: 4,5,10-30, or separated by spaces and double-quoted(")

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 511 characters

        **Maximum Length:** 1 characters

    **outgoing**

        **Description** Outgoing interface (For all ports, don't specify port number.)

        **Type:** boolean

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

        **Default:** 0

    **pcapng-config**

        **Description:** pcapng-config is a **JSON Block**.  Please see below for :ref:`216_pcapng-config` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/pcapng-config <axdebug_pcapng_config>`

    **save-config**

        **Description:** save-config is a **JSON Block**.  Please see below for :ref:`216_save-config` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/axdebug/save-config <axdebug_save_config>`

    **sess-filter-dis**

        **Description** Disable session based filter

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Maximum number of minutes for a capture. Default is 5 minutes. For unlimited, specify 0

        **Type:** number

        **Range:** 0-65535

        **Default:** 5

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _216_delete:

delete
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **capture-file**

        **Description** Delete a capture file (Specify target filename to change)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **config-file**

        **Description** Delete AXDebug config file (Specify target filename to change)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _216_apply-config:

apply-config
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **config-file**

        **Description** config file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _216_save-config:

save-config
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **config-file**

        **Description** config file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **default**

        **Description** save to default config file

        **Type:** boolean

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

        **Default:** 0

.. _216_capture:

capture
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **brief**

        **Description** Print basic packet information

        **Type:** boolean

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

        **Default:** 0

    **current-slot**

        **Description** Only for current-slot of chassis

        **Type:** boolean

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

        **Default:** 0

    **detail**

        **Description** Include packet payload

        **Type:** boolean

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

        **Default:** 0

    **no-stop**

        **Description** Non-stop execution

        **Type:** boolean

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

        **Default:** 0

    **save**

        **Description** Save packets into file (Specify filename to save packets)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _216_exit:

exit
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **stop-capture**

        **Description** stop capture traffic

        **Type:** boolean

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

        **Default:** 0

.. _216_filter-config-list:

filter-config-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **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

.. _216_pcapng-config:

pcapng-config
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **exit**

        **Description** Exit from axdebug pcapng mode

        **Type:** boolean

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

        **Default:** 0

    **pcapng-enable**

        **Description** Enable pcapng

        **Type:** boolean

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

        **Default:** 0

    **ssl-key-enable**

        **Description** Enable ssl key tracking

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters