.. _ddos_network_object_sub_network: ddos network-object sub-network =============================== Configure sub-network in a DDos Network Object sub-network Specification ------------------------- ===================================== ====================================================================================== **Parameter** **Value** ===================================== ====================================================================================== **Type** *Intermediate Resource* **Element Name** sub-network **Element URI** /axapi/v3/ddos/network-object/{object-name}/sub-network **Element Attributes** sub-network_attributes **Partition Visibility** shared **Schema** :download:`sub-network schema ` ===================================== ====================================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/ddos/network-object/{object-name}/sub-network .. raw:: html sub-network_attributes .. raw:: html
.. _1143_sub-network_attributes: sub-network attributes ---------------------- **sub-network-v4-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/network-object/{object-name}/sub-network/sub-network-v4/{subnet-ip-addr} ` **sub-network-v6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ddos/network-object/{object-name}/sub-network/sub-network-v6/{subnet-ipv6-addr} ` .. _1143_sub-network-v4-list: sub-network-v4-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **breakdown-subnet-threshold** **Description:** breakdown-subnet-threshold is a **JSON Block**. Please see below for :ref:`1143_sub-network-v4-list_breakdown-subnet-threshold` **Type:** Object **host-anomaly-threshold** **Description:** host-anomaly-threshold is a **JSON Block**. Please see below for :ref:`1143_sub-network-v4-list_host-anomaly-threshold` **Type:** Object **sampling-enable** **Type:** List **sub-network-anomaly-threshold** **Description:** sub-network-anomaly-threshold is a **JSON Block**. Please see below for :ref:`1143_sub-network-v4-list_sub-network-anomaly-threshold` **Type:** Object **subnet-breakdown** **Description** additional layer of breakdown subnet **Type:** number **Range:** 25-31 **subnet-ip-addr** **Description** IPv4 Subnet/host, supported prefix range is from 24 to 32 **Type:** string **Format:** ipv4-cidr **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1143_sub-network-v4-list_sub-network-anomaly-threshold: sub-network-v4-list_sub-network-anomaly-threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **static-sub-network-bit-rate** **Description** Bit rate of the sub-network **Type:** number **Range:** 800-34359738360 **static-sub-network-pkt-rate** **Description** Packet rate of the sub-network **Type:** number **Range:** 1-2147483647 .. _1143_sub-network-v4-list_sampling-enable: sub-network-v4-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'packet_rate': PPS; 'bit_rate': B(bits)PS; **Type:** string **Supported Values:** all, packet_rate, bit_rate .. _1143_sub-network-v4-list_breakdown-subnet-threshold: sub-network-v4-list_breakdown-subnet-threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **breakdown-subnet-bit-rate** **Description** Bit rate of per host **Type:** number **Range:** 800-34359738360 **breakdown-subnet-pkt-rate** **Description** Packet rate of per host **Type:** number **Range:** 1-2147483647 .. _1143_sub-network-v4-list_host-anomaly-threshold: sub-network-v4-list_host-anomaly-threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **static-bit-rate-threshold** **Description** Bit rate of per host **Type:** number **Range:** 800-34359738360 **static-fin-rate-threshold** **Description** FIN packet rate of per host **Type:** number **Range:** 1-2147483647 **static-flow-count-threshold** **Description** Flow count of per host **Type:** number **Range:** 1-2147483647 **static-icmp-pkt-rate-threshold** **Description** ICMP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-pkt-rate-threshold** **Description** Packet rate of per host **Type:** number **Range:** 1-2147483647 **static-rev-bit-rate-threshold** **Description** Bit rate of per host **Type:** number **Range:** 800-34359738360 **static-rev-pkt-rate-threshold** **Description** Packet rate of per host **Type:** number **Range:** 1-2147483647 **static-rst-rate-threshold** **Description** RST packet rate of per host **Type:** number **Range:** 1-2147483647 **static-syn-rate-threshold** **Description** SYN packet rate of per host **Type:** number **Range:** 1-2147483647 **static-tcp-pkt-rate-threshold** **Description** TCP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-udp-pkt-rate-threshold** **Description** UDP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-undiscovered-host-bit-rate-threshold** **Description** Bit rate of per undiscovered host **Type:** number **Range:** 800-34359738360 **static-undiscovered-host-pkt-rate-threshold** **Description** packet rate of per undiscovered host **Type:** number **Range:** 1-2147483647 **static-undiscovered-pkt-rate-threshold** **Description** Undiscovered packet rate of per host **Type:** number **Range:** 1-2147483647 .. _1143_sub-network-v6-list: sub-network-v6-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **host-anomaly-threshold** **Description:** host-anomaly-threshold is a **JSON Block**. Please see below for :ref:`1143_sub-network-v6-list_host-anomaly-threshold` **Type:** Object **sampling-enable** **Type:** List **sub-network-anomaly-threshold** **Description:** sub-network-anomaly-threshold is a **JSON Block**. Please see below for :ref:`1143_sub-network-v6-list_sub-network-anomaly-threshold` **Type:** Object **subnet-breakdown** **Description** additional layer of breakdown subnet **Type:** number **Range:** 57-63 **subnet-ipv6-addr** **Description** IPv6 Subnet/host, supported prefix range is from 56 to 64 **Type:** string **Format:** ipv6-address-plen **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1143_sub-network-v6-list_sub-network-anomaly-threshold: sub-network-v6-list_sub-network-anomaly-threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **static-sub-network-bit-rate** **Description** Bit rate of the sub-network **Type:** number **Range:** 800-34359738360 **static-sub-network-pkt-rate** **Description** Packet rate of the sub-network **Type:** number **Range:** 1-2147483647 .. _1143_sub-network-v6-list_sampling-enable: sub-network-v6-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'packet_rate': PPS; 'bit_rate': B(bits)PS; **Type:** string **Supported Values:** all, packet_rate, bit_rate .. _1143_sub-network-v6-list_host-anomaly-threshold: sub-network-v6-list_host-anomaly-threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **static-bit-rate-threshold** **Description** Bit rate of per host **Type:** number **Range:** 800-34359738360 **static-fin-rate-threshold** **Description** FIN packet rate of per host **Type:** number **Range:** 1-2147483647 **static-flow-count-threshold** **Description** Flow count of per host **Type:** number **Range:** 1-2147483647 **static-icmp-pkt-rate-threshold** **Description** ICMP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-pkt-rate-threshold** **Description** Packet rate of per host **Type:** number **Range:** 1-2147483647 **static-rev-bit-rate-threshold** **Description** Bit rate of per host **Type:** number **Range:** 800-34359738360 **static-rev-pkt-rate-threshold** **Description** Packet rate of per host **Type:** number **Range:** 1-2147483647 **static-rst-rate-threshold** **Description** RST packet rate of per host **Type:** number **Range:** 1-2147483647 **static-syn-rate-threshold** **Description** SYN packet rate of per host **Type:** number **Range:** 1-2147483647 **static-tcp-pkt-rate-threshold** **Description** TCP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-udp-pkt-rate-threshold** **Description** UDP packet rate of per host **Type:** number **Range:** 1-2147483647 **static-undiscovered-host-bit-rate-threshold** **Description** Bit rate of per undiscovered host **Type:** number **Range:** 800-34359738360 **static-undiscovered-host-pkt-rate-threshold** **Description** packet rate of per undiscovered host **Type:** number **Range:** 1-2147483647 **static-undiscovered-pkt-rate-threshold** **Description** Undiscovered packet rate of per host **Type:** number **Range:** 1-2147483647