.. _ddos_dst_entry_capture_config:

ddos dst entry capture-config
=============================

Specify packet capture-config


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

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

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

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

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

	 **Collection URI**                    /axapi/v3/ddos/dst/entry/{dst-entry-name}/capture-config

	                                       

	 **Element Name**                      capture-config

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

	 **Element Attributes**                capture-config_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`capture-config schema <ddos-dst-entry-capture-config/ddos-dst-entry-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/ddos/dst/entry/{dst-entry-name}/capture-config



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config/{name}



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config/{name}



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config/{name}



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config



.. raw:: html

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


:ref:`715_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/ddos/dst/entry/{dst-entry-name}/capture-config/{name}



.. raw:: html

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


:ref:`715_capture-config_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _715_capture-config_list:

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


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

        capture-config-list : [

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

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

             ...

         ]

.. _715_capture-config_attributes:

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

    **mode**

        **Description** 'drop': Apply capture-config to dropped packets; 'forward': Apply capture-config to forwarded packets; 'all': Apply capture-config to both dropped and forwarded packets; 

        **Type:** string

        **Supported Values:** drop, forward, all

    **name**

        **Description** Capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/capture-config <capture_config>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters