.. _ddos_zone_profile_oper:

ddos zone-profile oper
======================

Operational Status for the object zone-profile


zone-profile Specification
--------------------------

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

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

	 **Collection Name**                   :ref:`467_zone-profile_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-profile/{profile-name}

	                                       

	 **Element Name**                      zone-profile

	 **Element URI**                       /axapi/v3/ddos/zone-profile/{profile-name}/oper

	 **Element Attributes**                zone-profile_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`zone-profile schema <ddos-zone-profile-oper/ddos-zone-profile-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/zone-profile/{profile-name}



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}/oper



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}/oper



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}/oper



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}



.. raw:: html

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


:ref:`467_zone-profile_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/zone-profile/{profile-name}/oper



.. raw:: html

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


:ref:`467_zone-profile_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _467_zone-profile_list:

zone-profile-list
-----------------


    zone-profile-list is **JSON List** of :ref:`467_zone-profile_attributes` 

        zone-profile-list : [

             { :ref:`467_zone-profile_attributes` },

             { :ref:`467_zone-profile_attributes` },

             ...

         ]

.. _467_zone-profile_attributes:

zone-profile attributes
-----------------------

    **ip-proto**

        **Description:** ip-proto is a **JSON Block**.  Please see below for :ref:`467_ip-proto` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto <ddos_zone_profile>`

    **oper**

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

        **Type:** Object

    **port-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol} <ddos_zone_profile>`

    **port-range-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num}/port-range/{port-range-start}+{port-range-end}+{protocol} <ddos_zone_profile>`

    **profile-name**

        **Description** Profile for DDoS zone thresholds

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _467_oper:

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

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

    **ports**

        **Type:** List

    **profile-name**

        **Description** 

        **Type:** string

.. _467_oper_ports:

oper_ports
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicators**

        **Type:** List

    **port-num**

        **Description** 

        **Type:** number

    **port-protocol**

        **Description** 

        **Type:** string

.. _467_oper_ports_indicators:

oper_ports_indicators
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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

.. _467_port-range-list:

port-range-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num}/port-range/{port-range-start}+{port-range-end}+{protocol}/indicator/{indicator-name} <ddos_zone_profile>`

    **oper**

        **Type:** Object

    **port-range-end**

        **Description** Port-Range End Port Number

        **Type:** number

        **Range:** 2-65535

    **port-range-start**

        **Description** Port-Range Start Port Number

        **Type:** number

        **Range:** 1-65535

    **protocol**

        **Description** 'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 'sip-tcp': SIP-TCP Port; 'sip-udp': SIP-UDP Port; 'quic': QUIC Port; 

        **Type:** string

        **Supported Values:** dns-tcp, dns-udp, http, tcp, udp, ssl-l4, sip-tcp, sip-udp, quic

.. _467_port-range-list_indicator-list:

port-range-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'concurrent-conns': concurrent-conns; 'conn-miss-rate': conn-miss-rate; 'syn-rate': syn-rate; 'fin-rate': fin-rate; 'rst-rate': rst-rate; 'small-window-ack-rate': small-window-ack-rate; 'empty-ack-rate': empty-ack-rate; 'small-payload-rate': small-payload-rate; 'syn-fin-ratio': syn-fin-ratio; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`467_port-range-list_indicator-list_oper` 

        **Type:** Object

.. _467_port-range-list_indicator-list_oper:

port-range-list_indicator-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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

.. _467_port-list:

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

	 **Block object keys**             

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

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/indicator/{indicator-name} <ddos_zone_profile>`

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`467_port-list_oper` 

        **Type:** Object

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

    **port-protocol**

        **Description** 'dns-tcp': dns-tcp; 'dns-udp': dns-udp; 'sip-tcp': sip-tcp; 'sip-udp': sip-udp; 'http': http; 'tcp': tcp; 'udp': udp; 'ssl-l4': ssl-l4; 'quic': quic; 

        **Type:** string

        **Supported Values:** dns-tcp, dns-udp, sip-tcp, sip-udp, http, tcp, udp, ssl-l4, quic

.. _467_port-list_oper:

port-list_oper
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **indicators**

        **Type:** List

    **port-num**

        **Description** 

        **Type:** number

    **port-protocol**

        **Description** 

        **Type:** string

.. _467_port-list_oper_indicators:

port-list_oper_indicators
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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

.. _467_port-list_indicator-list:

port-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'concurrent-conns': concurrent-conns; 'conn-miss-rate': conn-miss-rate; 'syn-rate': syn-rate; 'fin-rate': fin-rate; 'rst-rate': rst-rate; 'small-window-ack-rate': small-window-ack-rate; 'empty-ack-rate': empty-ack-rate; 'small-payload-rate': small-payload-rate; 'syn-fin-ratio': syn-fin-ratio; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`467_port-list_indicator-list_oper` 

        **Type:** Object

.. _467_port-list_indicator-list_oper:

port-list_indicator-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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

.. _467_ip-proto:

ip-proto
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Type:** Object

    **proto-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num}/proto-name/{protocol} <ddos_zone_profile>`

    **proto-number-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num} <ddos_zone_profile>`

.. _467_ip-proto_proto-number-list:

ip-proto_proto-number-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num}/indicator/{indicator-name} <ddos_zone_profile>`

    **oper**

        **Type:** Object

    **protocol-num**

        **Description** Protocol Number

        **Type:** number

        **Range:** 0-255

.. _467_ip-proto_proto-number-list_indicator-list:

ip-proto_proto-number-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'frag-rate': frag-rate; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, frag-rate, cpu-utilization, interface-utilization

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`467_ip-proto_proto-number-list_indicator-list_oper` 

        **Type:** Object

.. _467_ip-proto_proto-number-list_indicator-list_oper:

ip-proto_proto-number-list_indicator-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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

.. _467_ip-proto_proto-name-list:

ip-proto_proto-name-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/ip-proto/proto-number/{protocol-num}/proto-name/{protocol}/indicator/{indicator-name} <ddos_zone_profile>`

    **oper**

        **Type:** Object

    **protocol**

        **Description** 'icmp-v4': ip-proto icmp-v4; 'icmp-v6': ip-proto icmp-v6; 'gre': ip-proto gre; 'ipv4-encap': ip-proto IPv4 Encapsulation; 'ipv6-encap': ip-proto IPv6 Encapsulation; 

        **Type:** string

        **Supported Values:** icmp-v4, icmp-v6, gre, ipv4-encap, ipv6-encap

.. _467_ip-proto_proto-name-list_indicator-list:

ip-proto_proto-name-list_indicator-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-name**

        **Description** 'pkt-rate': pkt-rate; 'pkt-drop-rate': pkt-drop-rate; 'pkt-drop-ratio': pkt-drop-ratio; 'bytes-to-bytes-from-ratio': bytes-to-bytes-from-ratio; 'frag-rate': frag-rate; 'cpu-utilization': cpu-utilization; 'interface-utilization': interface-utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, frag-rate, cpu-utilization, interface-utilization

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`467_ip-proto_proto-name-list_indicator-list_oper` 

        **Type:** Object

.. _467_ip-proto_proto-name-list_indicator-list_oper:

ip-proto_proto-name-list_indicator-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **indicator-name**

        **Description** 

        **Type:** string

    **src-threshold**

        **Description** 

        **Type:** string

    **src-threshold-auto**

        **Description** 

        **Type:** boolean

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

    **zone-threshold**

        **Description** 

        **Type:** string

    **zone-threshold-auto**

        **Description** 

        **Type:** boolean

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