.. _capture_config:

capture-config
==============

Packet Capture-Configuration


capture-config Specification
----------------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`234_capture-config_list`

	 **Collection URI**                    /axapi/v3/capture-config

	                                       

	 **Element Name**                      capture-config

	 **Element URI**                       /axapi/v3/capture-config/{name}

	 **Element Attributes**                capture-config_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/capture-config/{name}/oper

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



.. raw:: html

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


:ref:`234_capture-config_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/capture-config



.. raw:: html

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


:ref:`234_capture-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/capture-config/{name}



.. raw:: html

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


:ref:`234_capture-config_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/capture-config



.. raw:: html

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


:ref:`234_capture-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/capture-config/{name}



.. raw:: html

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


:ref:`234_capture-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/capture-config/{name}



.. raw:: html

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


:ref:`234_capture-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/capture-config



.. raw:: html

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


:ref:`234_capture-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/capture-config/{name}



.. raw:: html

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


:ref:`234_capture-config_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _234_capture-config_list:

capture-config-list
-------------------


    capture-config-list is **JSON List** of :ref:`234_capture-config_attributes` 

        capture-config-list : [

             { :ref:`234_capture-config_attributes` },

             { :ref:`234_capture-config_attributes` },

             ...

         ]

.. _234_capture-config_attributes:

capture-config attributes
-------------------------

    **count**

        **Description** Specify maximum packet number. (default 0 for unlimited)

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

        **Mutual Exclusion:** count and file-history-size are mutually exclusive

    **enable**

        **Description** Enable capture-config

        **Type:** boolean

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

        **Default:** 0

    **file-history-size**

        **Description** (Default) Specify pcapng file history size in MB (default 10)

        **Type:** number

        **Range:** 1-6144

        **Mutual Exclusion:** file-history-size, file-size, and count are mutually exclusive

    **file-size**

        **Description** Specify pcapng filesize in MB (default 10)

        **Type:** number

        **Range:** 1-6144

        **Mutual Exclusion:** file-size and file-history-size are mutually exclusive

    **filter**

        **Description** Filter packets to save using Berkeley Packet Filter syntax

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1024 characters

        **Maximum Length:** 1 characters

    **length**

        **Description** Packet length Bytes to capture (Default 128)

        **Type:** number

        **Range:** 64-1518

    **name**

        **Description** capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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