.. _ddos_dst_zone_port_range_virtualhosts_virtualhost:

ddos dst zone port-range virtualhosts virtualhost
=================================================

Configure mitigation for virtualhost


virtualhost Specification
-------------------------

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

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

	 **Object Key(s)**                     *vhost*

	 **Collection Name**                   :ref:`969_virtualhost_list`

	 **Collection URI**                    /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost

	                                       

	 **Element Name**                      virtualhost

	 **Element URI**                       /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}

	 **Element Attributes**                virtualhost_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}/stats

	 **Operational Data URI**              /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}/oper

	 **Schema**                             :download:`virtualhost schema <ddos-dst-zone-port-range-virtualhosts-virtualhost/ddos-dst-zone-port-range-virtualhosts-virtualhost.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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost



.. raw:: html

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


:ref:`969_virtualhost_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/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}



.. raw:: html

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


:ref:`969_virtualhost_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _969_virtualhost_list:

virtualhost-list
----------------


    virtualhost-list is **JSON List** of :ref:`969_virtualhost_attributes` 

        virtualhost-list : [

             { :ref:`969_virtualhost_attributes` },

             { :ref:`969_virtualhost_attributes` },

             ...

         ]

.. _969_virtualhost_attributes:

virtualhost attributes
----------------------

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

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

        **Default:** 0

    **glid-cfg**

        **Description:** glid-cfg is a **JSON Block**.  Please see below for :ref:`969_glid-cfg` 

        **Type:** Object

    **level-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/virtualhosts/virtualhost/{vhost}/level/{level-num} <ddos_dst_zone>`

    **servername**

        **Type:** List

    **servername-list**

        **Description** Class List to match servername (Class List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **servername-match-any**

        **Description** Match when there is no SNI or other servernames are not matched

        **Type:** boolean

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

        **Default:** 0

    **source-tracking**

        **Description** 'follow': enable creation of source entries when source-tracking-all is enabled (default); 'enable': enable creation of source entries on this virtualhost; 'disable': disable creation of source entries on this virtualhost; 

        **Type:** string

        **Supported Values:** follow, enable, disable

        **Default:** follow

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

    **vhost**

        **Description** name for virtualhost

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _969_servername:

servername
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **host-match-string**

        **Description** SNI String

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **match-type**

        **Description** 'contains': match servername extension when contains this string; 'ends-with': match servername extension when ends with this string; 'equals': match servername extension when equals this string; 'starts-with': match servername extension when starts with this string; 

        **Type:** string

        **Supported Values:** contains, ends-with, equals, starts-with

.. _969_glid-cfg:

glid-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **glid-action**

        **Description** 'drop': Drop packets for glid exceed (Default); 'ignore': Do nothing for glid exceed; 

        **Type:** string

        **Supported Values:** drop, ignore

.. _969_level-list:

level-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **glid-action**

        **Description** 'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src, ignore

    **level-num**

        **Description** '0': Default policy level; 

        **Type:** string

        **Supported Values:** 0

    **src-default-glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

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

    **zone-template**

        **Description:** zone-template is a **JSON Block**.  Please see below for :ref:`969_level-list_zone-template` 

        **Type:** Object

.. _969_level-list_zone-template:

level-list_zone-template
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ssl-l4**

        **Description** DDOS ssl-l4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS tcp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters