{
    "id":"/axapi/v3/template/limit-policy/{policy-number}",
    "type":"object",
    "node-type":"list",
    "title":"limit-policy",
    "partition-visibility":"shared",
    "description":"Create a Limit Policy",
    "properties":{
        "policy-number":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":1023,
            "partition-visibility":"shared",
            "description":"Limit Policy Number",
            "optional":false
        },
        "parent":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":1023,
            "partition-visibility":"shared",
            "description":"Specify the parent of limit-policy",
            "optional":true
        },
        "max-min-fair":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Enable max-min-fairness",
            "optional":true
        },
        "limit-concurrent-sessions":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":2147483647,
            "partition-visibility":"shared",
            "description":"Enable Concurrent Session Limit (Number of Concurrent Sessions)",
            "optional":true
        },
        "log":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Log when Session Limit is exceeded",
            "optional":true
        },
        "limit-scope":{
            "type":"string",
            "format":"enum",
            "default":"subscriber-ip",
            "partition-visibility":"shared",
            "description":"'aggregate': Rule Level; 'subscriber-ip': Subscriber IP Level; 'subscriber-prefix': Subscriber Prefix Level; ",
            "enum":[
                "aggregate",
                "subscriber-ip",
                "subscriber-prefix"
            ],
            "optional":true
        },
        "prefix-length":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":128,
            "partition-visibility":"shared",
            "description":"Prefix length",
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "user-tag":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":127,
            "partition-visibility":"shared",
            "description":"Customized tag",
            "optional":true
        },
        "limit-pps":{
            "type":"object",
            "$ref":"/axapi/v3/template/limit-policy/{policy-number}/limit-pps",
            "properties":{
                "uplink":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"Uplink PPS limit (Number of Packets per second)"
                },
                "uplink-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)"
                },
                "uplink-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "downlink":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"Downlink PPS limit (Number of Packets per second)"
                },
                "ddos-protection-factor":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":50,
                    "partition-visibility":"shared",
                    "description":"Enable DDoS Protection (Multiplier of the downlink PPS)"
                },
                "downlink-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)"
                },
                "downlink-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "total":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"Total PPS limit (Number of Packets per second)"
                },
                "total-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)"
                },
                "total-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "limit-throughput":{
            "type":"object",
            "$ref":"/axapi/v3/template/limit-policy/{policy-number}/limit-throughput",
            "properties":{
                "uplink":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Uplink Throughput limit (Mega Bits per second)"
                },
                "uplink-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)"
                },
                "uplink-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "downlink":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Downlink Throughput limit (Mega Bits per second)"
                },
                "downlink-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)"
                },
                "downlink-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "total":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Total Throughput limit (Mega Bits per second)"
                },
                "total-burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100000,
                    "partition-visibility":"shared",
                    "description":"Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)"
                },
                "total-relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "limit-cps":{
            "type":"object",
            "$ref":"/axapi/v3/template/limit-policy/{policy-number}/limit-cps",
            "properties":{
                "value":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"Connections Per Second Rate Limit (Number of Connections per second)"
                },
                "burstsize":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":2147483647,
                    "partition-visibility":"shared",
                    "description":"CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)"
                },
                "relaxed":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Relax the limitation when the policy has more tokens from the parent of policy"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        }
    },
    "object-keys":[
        "policy-number"
    ],
    "required":[
        "policy-number"
    ]
}