.. _template_limit_policy: template limit-policy ===================== Create a Limit Policy limit-policy Specification -------------------------- ===================================== ============================================================================== **Parameter** **Value** ===================================== ============================================================================== **Type** *Collection* **Object Key(s)** *policy-number* **Collection Name** :ref:`2643_limit-policy_list` **Collection URI** /axapi/v3/template/limit-policy **Element Name** limit-policy **Element URI** /axapi/v3/template/limit-policy/{policy-number} **Element Attributes** limit-policy_attributes **Partition Visibility** shared **Schema** :download:`limit-policy schema ` ===================================== ============================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/template/limit-policy .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/template/limit-policy .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/template/limit-policy/{policy-number} .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/template/limit-policy .. raw:: html :ref:`2643_limit-policy_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/template/limit-policy/{policy-number} .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/template/limit-policy/{policy-number} .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/template/limit-policy .. raw:: html :ref:`2643_limit-policy_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/template/limit-policy/{policy-number} .. raw:: html :ref:`2643_limit-policy_attributes` .. raw:: html
.. _2643_limit-policy_list: limit-policy-list ----------------- limit-policy-list is **JSON List** of :ref:`2643_limit-policy_attributes` limit-policy-list : [ { :ref:`2643_limit-policy_attributes` }, { :ref:`2643_limit-policy_attributes` }, ... ] .. _2643_limit-policy_attributes: limit-policy attributes ----------------------- **limit-concurrent-sessions** **Description** Enable Concurrent Session Limit (Number of Concurrent Sessions) **Type:** number **Range:** 1-2147483647 **limit-cps** **Description:** limit-cps is a **JSON Block**. Please see below for :ref:`2643_limit-cps` **Type:** Object **Reference Object:** :doc:`/axapi/v3/template/limit-policy/{policy-number}/limit-cps ` **limit-pps** **Description:** limit-pps is a **JSON Block**. Please see below for :ref:`2643_limit-pps` **Type:** Object **Reference Object:** :doc:`/axapi/v3/template/limit-policy/{policy-number}/limit-pps ` **limit-scope** **Description** 'aggregate': Rule Level; 'subscriber-ip': Subscriber IP Level; 'subscriber-prefix': Subscriber Prefix Level; **Type:** string **Supported Values:** aggregate, subscriber-ip, subscriber-prefix **Default:** subscriber-ip **limit-throughput** **Description:** limit-throughput is a **JSON Block**. Please see below for :ref:`2643_limit-throughput` **Type:** Object **Reference Object:** :doc:`/axapi/v3/template/limit-policy/{policy-number}/limit-throughput ` **log** **Description** Log when Session Limit is exceeded **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-min-fair** **Description** Enable max-min-fairness **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **parent** **Description** Specify the parent of limit-policy **Type:** number **Range:** 1-1023 **policy-number** **Description** Limit Policy Number **Type:** number **Range:** 1-1023 **prefix-length** **Description** Prefix length **Type:** number **Range:** 1-128 **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 .. _2643_limit-throughput: limit-throughput ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **downlink** **Description** Downlink Throughput limit (Mega Bits per second) **Type:** number **Range:** 1-100000 **downlink-burstsize** **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) **Type:** number **Range:** 1-100000 **downlink-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **total** **Description** Total Throughput limit (Mega Bits per second) **Type:** number **Range:** 1-100000 **total-burstsize** **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) **Type:** number **Range:** 1-100000 **total-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unit** **Description** 'Mbps': default; 'Kbps': minimum configurable limit is 100 Kbps; **Type:** string **Supported Values:** Mbps, Kbps **Default:** Mbps **uplink** **Description** Uplink Throughput limit (Mega Bits per second) **Type:** number **Range:** 1-100000 **uplink-burstsize** **Description** Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) **Type:** number **Range:** 1-100000 **uplink-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2643_limit-cps: limit-cps ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **burstsize** **Description** CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second) **Type:** number **Range:** 1-2147483647 **relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **value** **Description** Connections Per Second Rate Limit (Number of Connections per second) **Type:** number **Range:** 1-2147483647 .. _2643_limit-pps: limit-pps ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ddos-protection-factor** **Description** Enable DDoS Protection (Multiplier of the downlink PPS) **Type:** number **Range:** 1-50 **downlink** **Description** Downlink PPS limit (Number of Packets per second) **Type:** number **Range:** 1-2147483647 **downlink-burstsize** **Description** PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) **Type:** number **Range:** 1-2147483647 **downlink-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **total** **Description** Total PPS limit (Number of Packets per second) **Type:** number **Range:** 1-2147483647 **total-burstsize** **Description** PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) **Type:** number **Range:** 1-2147483647 **total-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uplink** **Description** Uplink PPS limit (Number of Packets per second) **Type:** number **Range:** 1-2147483647 **uplink-burstsize** **Description** PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) **Type:** number **Range:** 1-2147483647 **uplink-relaxed** **Description** Relax the limitation when the policy has more tokens from the parent of policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters