template lid¶
Create an Lid
lid Specification¶
Parameter Value Type Collection Object Key(s) lid-number Collection Name lid-list Collection URI /axapi/v3/template/lid Element Name lid Element URI /axapi/v3/template/lid/{lid-number} Element Attributes lid_attributes Partition Visibility shared Schema lid schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/template/lid | ||
Create List | POST | /axapi/v3/template/lid | ||
Get Object | GET | /axapi/v3/template/lid/{lid-number} | ||
Get List | GET | /axapi/v3/template/lid | ||
Modify Object | POST | /axapi/v3/template/lid/{lid-number} | ||
Replace Object | PUT | /axapi/v3/template/lid/{lid-number} | ||
Replace List | PUT | /axapi/v3/template/lid | ||
Delete Object | DELETE | /axapi/v3/template/lid/{lid-number} | ||
lid-list¶
lid-list is JSON List of lid attributes
lid-list : [
]
lid attributes¶
ddos-protection-factor
Description Enable DDoS Protection (Multiplier of the downlink PPS)
Type: number
Range: 1-50
downlink-pps
Description Downlink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
downlink-throughput
Description Downlink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
lid-number
Description Lid Number
Type: number
Range: 1-1023
limit-cps
Description Enable Connections Per Second Rate Limit (Number of Connections per second)
Type: number
Range: 1-2147483647
limit-rate
Description ‘limit-pps’: Enable Packets Per Second Rate Limit; ‘limit-throughput’: Enable Throughput Rate Limit;
Type: string
Supported Values: limit-pps, limit-throughput
respond-to-user-mac
Description Use the user’s source MAC for the next hop rather than the routing table (default:off)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-ip
Description: src-ip is a JSON Block. Please see below for src-ip
Type: Object
total-pps
Description Total PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
total-throughput
Description Total Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
uplink-pps
Description Uplink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
uplink-throughput
Description Uplink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
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
src-ip¶
Specification Value Type object burstsize-cps
Description CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)
Type: number
Range: 1-2147483647
burstsize-downlink-pps
Description Downlink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
burstsize-downlink-throughput
Description Downlink Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
burstsize-total-pps
Description Total PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
burstsize-total-throughput
Description Total Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
burstsize-uplink-pps
Description Uplink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
burstsize-uplink-throughput
Description Uplink Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
concurrent-sessions
Description Concurrent Session Limit per Source IP Address (Number of Concurrent Sessions)
Type: number
Range: 1-2147483647
log
Description Log when Session Limit is exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
prefix-length
Description Source prefix length
Type: number
Range: 1-128