.. _ddos_exec_script:

ddos exec-script
================

Execute scripts


exec-script Specification
-------------------------

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

	===================================== =========================================================
	 **Type**                              *operational*

	 **Element Name**                      exec-script

	 **Element URI**                       /axapi/v3/ddos/exec-script

	 **Element Attributes**                exec-script_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ddos/exec-script/stats

	 **Schema**                             :download:`exec-script schema <ddos-exec-script/ddos-exec-script.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'>


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ddos/exec-script



.. raw:: html

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


:ref:`1056_exec-script_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1056_exec-script_attributes:

exec-script attributes
----------------------

    **alert-type**

        **Description** 1: UDP Pkt Rate 2: TCP Pkt Rate 3: ICMP Pkt Rate

        **Type:** number

        **Range:** 1-3

    **exec-script-ip-portocol**

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

        **Type:** string

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

    **exec-script-port-other-protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **level**

        **Description** Current Level

        **Type:** number

        **Range:** 1-4

    **mock**

        **Description** Use mock data

        **Type:** boolean

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

        **Default:** 0

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

    **port-other**

        **Description** 'other': other; 

        **Type:** string

        **Supported Values:** other

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

    **protocol-num**

        **Description** Protocol Number

        **Type:** number

        **Range:** 0-255

    **script**

        **Description** Specify script to execute

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **src-ip**

        **Type:** List

    **src-ipv6**

        **Type:** List

    **threshold**

        **Description** Threshold

        **Type:** number

        **Range:** 1-3000

    **timeout**

        **Description** Timeout (Default: 10 seconds, Mock Default: 2 seconds)

        **Type:** number

        **Range:** 1-31

    **zone**

        **Description** DST Zone name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _1056_src-ip:

src-ip
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ip-addr**

        **Description** Specify IP address

        **Type:** string

        **Format:** ipv4-address

    **subnet-ip-addr**

        **Description** IP Subnet

        **Type:** string

        **Format:** ipv4-cidr

.. _1056_src-ipv6:

src-ipv6
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ip6-addr**

        **Description** Specify IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **subnet-ipv6-addr**

        **Description** IPV6 Subnet

        **Type:** string

        **Format:** ipv6-address-plen