.. _ddos_zone_src_port_template: ddos zone-src-port-template =========================== Define a DDOS src template zone-src-port-template Specification ------------------------------------ ===================================== ==================================================================== **Parameter** **Value** ===================================== ==================================================================== **Type** *Intermediate Resource* **Element Name** zone-src-port-template **Element URI** /axapi/v3/ddos/zone-src-port-template **Element Attributes** zone-src-port-template_attributes **Partition Visibility** shared **Schema** :download:`zone-src-port-template schema ` ===================================== ==================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/ddos/zone-src-port-template .. raw:: html zone-src-port-template_attributes .. raw:: html
.. _1244_zone-src-port-template_attributes: zone-src-port-template attributes --------------------------------- **dns-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/dns/{name} ` **tcp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/tcp/{name} ` **udp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/udp/{name} ` .. _1244_udp-list: udp-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/udp/{name}/filter/{udp-filter-name} ` **filter-match-type** **Description** 'default': Stop matching on drop/blacklist action; 'stop-on-first-match': Stop matching on first match; **Type:** string **Supported Values:** default, stop-on-first-match **Default:** default **max-payload-size-cfg** **Description:** max-payload-size-cfg is a **JSON Block**. Please see below for :ref:`1244_udp-list_max-payload-size-cfg` **Type:** Object **min-payload-size-cfg** **Description:** min-payload-size-cfg is a **JSON Block**. Please see below for :ref:`1244_udp-list_min-payload-size-cfg` **Type:** Object **name** **Description** DDOS UDP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ntp-monlist-cfg** **Description:** ntp-monlist-cfg is a **JSON Block**. Please see below for :ref:`1244_udp-list_ntp-monlist-cfg` **Type:** Object **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 .. _1244_udp-list_ntp-monlist-cfg: udp-list_ntp-monlist-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ntp-monlist** **Description** Take action for ntp monlist request/response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ntp-monlist-action** **Description** 'drop': Drop packets for ntp-monlist (Default); 'blacklist-src': Blacklist-src for ntp-monlist; 'ignore': Ignore ntp-monlist; **Type:** string **Supported Values:** drop, blacklist-src, ignore **Mutual Exclusion:** ntp-monlist-action and ntp-monlist-action-list-name are mutually exclusive **ntp-monlist-action-list-name** **Description** Configure action-list to take for ntp-monlist **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** ntp-monlist-action-list-name and ntp-monlist-action are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ddos/action-list ` .. _1244_udp-list_max-payload-size-cfg: udp-list_max-payload-size-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **max-payload-size** **Description** Maximum UDP payload size for each single packet **Type:** number **Range:** 1-1470 **max-payload-size-action** **Description** 'drop': Drop packets for max-payload-size exceed (Default); 'blacklist-src': Blacklist-src for max-payload-size exceed; 'ignore': Do nothing for max-payload-size exceed; **Type:** string **Supported Values:** drop, blacklist-src, ignore **Mutual Exclusion:** max-payload-size-action and max-payload-size-action-list-name are mutually exclusive **max-payload-size-action-list-name** **Description** Configure action-list to take for max-payload-size exceed **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **Mutual Exclusion:** max-payload-size-action-list-name and max-payload-size-action are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ddos/action-list ` .. _1244_udp-list_min-payload-size-cfg: udp-list_min-payload-size-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **min-payload-size** **Description** Minimum UDP payload size for each single packet **Type:** number **Range:** 1-1470 **min-payload-size-action** **Description** 'drop': Drop packets for min-payload-size (Default); 'blacklist-src': Blacklist-src for min-payload-size; 'ignore': Do nothing for min-payload-size exceed; **Type:** string **Supported Values:** drop, blacklist-src, ignore **Mutual Exclusion:** min-payload-size-action and min-payload-size-action-list-name are mutually exclusive **min-payload-size-action-list-name** **Description** Configure action-list to take for min-payload-size exceed **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **Mutual Exclusion:** min-payload-size-action-list-name and min-payload-size-action are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ddos/action-list ` .. _1244_udp-list_filter-list: udp-list_filter-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **byte-offset-filter** **Description** Filter using Berkeley Packet Filter syntax **Type:** string **Format:** string-rlx **Maximum Length:** 1275 characters **Maximum Length:** 1 characters **udp-filter-action** **Description** 'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; **Type:** string **Supported Values:** drop, ignore, blacklist-src, authenticate-src **Mutual Exclusion:** udp-filter-action and udp-filter-action-list-name are mutually exclusive **udp-filter-action-list-name** **Description** Configure action-list to take **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** udp-filter-action-list-name and udp-filter-action are mutually exclusive **udp-filter-inverse-match** **Description** Inverse the result of the matching **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **udp-filter-name** **Description** **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **udp-filter-regex** **Description** Regex Expression **Type:** string **Format:** string-rlx **Maximum Length:** 1275 characters **Maximum Length:** 1 characters **udp-filter-seq** **Description** Sequence number **Type:** number **Range:** 1-200 **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 .. _1244_dns-list: dns-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-resolution-check** **Description:** query-resolution-check is a **JSON Block**. Please see below for :ref:`1244_dns-list_query-resolution-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/dns/{name}/query-resolution-check ` **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 .. _1244_dns-list_query-resolution-check: dns-list_query-resolution-check ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **big-response-action** **Description** 'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; **Type:** string **Supported Values:** default, blacklist-src **Default:** default **big-response-size** **Description** Max DNS response size (in Bytes) **Type:** number **Range:** 1-4096 **domain-lockup-action** **Description** 'default': Default, No action for future connections; 'blacklist-src': Blacklist the external server for future connections; **Type:** string **Supported Values:** default, blacklist-src **Default:** default **session-timeout-value** **Description** max session timeout (secs) between DNS external server and Protected object **Type:** number **Range:** 1-30 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1244_tcp-list: tcp-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/zone-src-port-template/tcp/{name}/filter/{tcp-filter-name} ` **filter-match-type** **Description** 'default': Stop matching on drop/blacklist action; 'stop-on-first-match': Stop matching on first match; **Type:** string **Supported Values:** default, stop-on-first-match **Default:** default **name** **Description** **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 .. _1244_tcp-list_filter-list: tcp-list_filter-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **byte-offset-filter** **Description** Filter using Berkeley Packet Filter syntax **Type:** string **Format:** string-rlx **Maximum Length:** 1275 characters **Maximum Length:** 1 characters **tcp-filter-action** **Description** 'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; **Type:** string **Supported Values:** drop, ignore, blacklist-src, authenticate-src **Mutual Exclusion:** tcp-filter-action and tcp-filter-action-list-name are mutually exclusive **tcp-filter-action-list-name** **Description** Configure action-list to take **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-filter-action-list-name and tcp-filter-action are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ddos/action-list ` **tcp-filter-inverse-match** **Description** Inverse the result of the matching **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-filter-name** **Description** **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **tcp-filter-regex** **Description** Regex Expression **Type:** string **Format:** string-rlx **Maximum Length:** 1275 characters **Maximum Length:** 1 characters **tcp-filter-seq** **Description** Sequence number **Type:** number **Range:** 1-200 **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