.. _ddos_dst_zone_port_range_virtualhosts_virtualhost_oper:

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

Operational Status for the object virtualhost


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

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

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

	 **Collection Name**                   :ref:`967_virtualhost_list`

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

	                                       

	 **Element Name**                      virtualhost

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

	 **Element Attributes**                virtualhost_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`virtualhost schema <ddos-dst-zone-port-range-virtualhosts-virtualhost-oper/ddos-dst-zone-port-range-virtualhosts-virtualhost-oper.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/{vhost}



.. raw:: html

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


:ref:`967_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/{vhost}



.. raw:: html

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


:ref:`967_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}/oper



.. raw:: html

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


:ref:`967_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/{vhost}



.. raw:: html

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


:ref:`967_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}/oper



.. raw:: html

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


:ref:`967_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}/oper



.. raw:: html

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


:ref:`967_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/{vhost}



.. raw:: html

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


:ref:`967_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}/oper



.. raw:: html

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


:ref:`967_virtualhost_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _967_virtualhost_list:

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


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

        virtualhost-list : [

             { :ref:`967_virtualhost_attributes` },

             { :ref:`967_virtualhost_attributes` },

             ...

         ]

.. _967_virtualhost_attributes:

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`967_oper` 

        **Type:** Object

    **vhost**

        **Description** name for virtualhost

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _967_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **app-stat**

        **Description** 

        **Type:** boolean

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

    **authenticated**

        **Description** 

        **Type:** boolean

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

    **black-listed**

        **Description** 

        **Type:** boolean

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

    **class-list**

        **Description** 

        **Type:** string

    **ddos_entry_list**

        **Type:** List

    **domain-name**

        **Description** 

        **Type:** string

    **entry-displayed-count**

        **Description** 

        **Type:** number

    **exceeded**

        **Description** 

        **Type:** boolean

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

    **hw-blacklisted**

        **Description** 

        **Type:** boolean

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

    **indicator-detail**

        **Description** 

        **Type:** boolean

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

    **indicators**

        **Description** 

        **Type:** boolean

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

    **ipv6**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **l4-ext-rate**

        **Description** 

        **Type:** boolean

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

    **level**

        **Description** 

        **Type:** boolean

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

    **overflow-policy**

        **Description** 

        **Type:** boolean

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

    **reporting-status**

        **Description** 

        **Type:** number

    **service-displayed-count**

        **Description** 

        **Type:** number

    **sources**

        **Description** 

        **Type:** boolean

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

    **sources-all-entries**

        **Description** 

        **Type:** boolean

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

    **subnet-ip-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-cidr

    **subnet-ipv6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address-plen

    **suffix-request-rate**

        **Description** 

        **Type:** boolean

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

    **white-listed**

        **Description** 

        **Type:** boolean

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

.. _967_oper_ddos_entry_list:

oper_ddos_entry_list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **age**

        **Description** 

        **Type:** number

    **app-stat1-limit**

        **Description** 

        **Type:** string

    **app-stat2-limit**

        **Description** 

        **Type:** string

    **app-stat3-limit**

        **Description** 

        **Type:** string

    **app-stat4-limit**

        **Description** 

        **Type:** string

    **app-stat5-limit**

        **Description** 

        **Type:** string

    **app-stat6-limit**

        **Description** 

        **Type:** string

    **app-stat7-limit**

        **Description** 

        **Type:** string

    **app-stat8-limit**

        **Description** 

        **Type:** string

    **bl-reasoning-rcode**

        **Description** 

        **Type:** string

    **bl-reasoning-timestamp**

        **Description** 

        **Type:** string

    **bw-state**

        **Description** 

        **Type:** string

    **connection-limit**

        **Description** 

        **Type:** string

    **connection-rate-limit**

        **Description** 

        **Type:** string

    **current-app-stat1**

        **Description** 

        **Type:** string

    **current-app-stat2**

        **Description** 

        **Type:** string

    **current-app-stat3**

        **Description** 

        **Type:** string

    **current-app-stat4**

        **Description** 

        **Type:** string

    **current-app-stat5**

        **Description** 

        **Type:** string

    **current-app-stat6**

        **Description** 

        **Type:** string

    **current-app-stat7**

        **Description** 

        **Type:** string

    **current-app-stat8**

        **Description** 

        **Type:** string

    **current-connection-rate**

        **Description** 

        **Type:** string

    **current-connections**

        **Description** 

        **Type:** string

    **current-frag-packet-rate**

        **Description** 

        **Type:** string

    **current-kBit-rate**

        **Description** 

        **Type:** string

    **current-packet-rate**

        **Description** 

        **Type:** string

    **debug-str**

        **Description** 

        **Type:** string

    **dst-address-str**

        **Description** 

        **Type:** string

        **Format:** string-rlx

    **dynamic-entry-count**

        **Description** 

        **Type:** string

    **dynamic-entry-limit**

        **Description** 

        **Type:** string

    **dynamic-entry-warn-state**

        **Description** 

        **Type:** string

    **frag-packet-rate-limit**

        **Description** 

        **Type:** string

    **http-filter-rates**

        **Type:** List

    **is-app-stat1-exceed**

        **Description** 

        **Type:** number

    **is-app-stat2-exceed**

        **Description** 

        **Type:** number

    **is-app-stat3-exceed**

        **Description** 

        **Type:** number

    **is-app-stat4-exceed**

        **Description** 

        **Type:** number

    **is-app-stat5-exceed**

        **Description** 

        **Type:** number

    **is-app-stat6-exceed**

        **Description** 

        **Type:** number

    **is-app-stat7-exceed**

        **Description** 

        **Type:** number

    **is-app-stat8-exceed**

        **Description** 

        **Type:** number

    **is-connection-rate-exceed**

        **Description** 

        **Type:** number

    **is-connections-exceed**

        **Description** 

        **Type:** number

    **is-frag-packet-rate-exceed**

        **Description** 

        **Type:** number

    **is-kBit-rate-exceed**

        **Description** 

        **Type:** number

    **is-packet-rate-exceed**

        **Description** 

        **Type:** number

    **is_auth_passed**

        **Description** 

        **Type:** string

    **kBit-rate-limit**

        **Description** 

        **Type:** string

    **level**

        **Description** 

        **Type:** number

    **lockup-time**

        **Description** 

        **Type:** number

    **packet-rate-limit**

        **Description** 

        **Type:** string

    **response-size-rates**

        **Type:** List

    **sflow-source-id**

        **Description** 

        **Type:** number

.. _967_oper_ddos_entry_list_response-size-rates:

oper_ddos_entry_list_response-size-rates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **current-response-size-rate**

        **Description** 

        **Type:** string

    **is-response-size-rate-limit-exceed**

        **Description** 

        **Type:** number

    **response-size-rate-limit**

        **Description** 

        **Type:** string

    **response-size-rate-name**

        **Description** 

        **Type:** string

.. _967_oper_ddos_entry_list_http-filter-rates:

oper_ddos_entry_list_http-filter-rates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **current-http-filter-rate**

        **Description** 

        **Type:** string

    **http-filter-rate-limit**

        **Description** 

        **Type:** string

    **http-filter-rate-name**

        **Description** 

        **Type:** string

    **is-http-filter-rate-limit-exceed**

        **Description** 

        **Type:** number