cgnv6 lsn-lid¶

Create an LSN Lid

lsn-lid Specification¶

Parameter Value

Type Collection

Object Key(s) lid-number

Collection Name lsn-lid-list

Collection URI /axapi/v3/cgnv6/lsn-lid

Element Name lsn-lid

Element URI /axapi/v3/cgnv6/lsn-lid/{lid-number}

Element Attributes lsn-lid_attributes

Partition Visibility shared

Schema lsn-lid schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cgnv6/lsn-lid	lsn-lid attributes
POST /axapi/v3/cgnv6/lsn-lid/ Payload: { "lsn-lid": { "lid-number": 1, "user-tag": "a" } }
Create List	POST	/axapi/v3/cgnv6/lsn-lid	lsn-lid attributes
Get Object	GET	/axapi/v3/cgnv6/lsn-lid/{lid-number}	lsn-lid attributes
GET /axapi/v3/cgnv6/lsn-lid/1 Reponse: { "lsn-lid": { "lid-number": 1, "respond-to-user-mac": 0, "override": "none", "uuid": "f96923cc-4f72-11ee-9e04-5d5bbc5e5064", "user-tag": "a", "a10-url": "/axapi/v3/cgnv6/lsn-lid/1" } }
Get List	GET	/axapi/v3/cgnv6/lsn-lid	lsn-lid-list
Modify Object	POST	/axapi/v3/cgnv6/lsn-lid/{lid-number}	lsn-lid attributes
Replace Object	PUT	/axapi/v3/cgnv6/lsn-lid/{lid-number}	lsn-lid attributes
PUT /axapi/v3/cgnv6/lsn-lid/1 Payload: { "lsn-lid": { "lid-number": 1, "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/cgnv6/lsn-lid	lsn-lid-list
Delete Object	DELETE	/axapi/v3/cgnv6/lsn-lid/{lid-number}	lsn-lid attributes
DELETE /axapi/v3/cgnv6/lsn-lid/1 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

lsn-lid-list¶

lsn-lid-list is JSON List of lsn-lid attributes

lsn-lid-list : [

{ lsn-lid attributes },

{ lsn-lid attributes },

…

]

lsn-lid attributes¶

conn-rate-limit

Description: conn-rate-limit is a JSON Block. Please see below for conn-rate-limit

Type: Object

ds-lite

Description: ds-lite is a JSON Block. Please see below for ds-lite

Type: Object

extended-user-quota

Description: extended-user-quota is a JSON Block. Please see below for extended-user-quota

Type: Object

lid-number

Description LSN Lid

Type: number

Range: 1-1023

lsn-rule-list

Description: lsn-rule-list is a JSON Block. Please see below for lsn-rule-list

Type: Object

name

Description LSN Lid Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

override

Description ‘none’: Apply source NAT if configured (default); ‘drop’: Drop packets that match this LSN lid; ‘pass-through’: Layer-3 route packets that match this LSN lid and do not apply source NAT;

Type: string

Supported Values: none, drop, pass-through

Default: none

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

source-nat-pool

Description: source-nat-pool is a JSON Block. Please see below for source-nat-pool

Type: Object

user-quota

Description: user-quota is a JSON Block. Please see below for user-quota

Type: Object

user-quota-prefix-length

Description NAT64/DS-Lite user quota prefix length (Prefix Length (Default: Uses the global NAT64/DS-Lite configured value))

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

extended-user-quota¶

Specification Value

Type object

tcp

Type: List

udp

Type: List

extended-user-quota_udp¶

Specification Value

Type list

Block object keys

udp-service-port

Description Port (Port Value)

Type: number

Range: 1-65535

udp-sessions

Description Number of Extended Quota sessions allowed for this service

Type: number

Range: 1-255

extended-user-quota_tcp¶

Specification Value

Type list

Block object keys

tcp-service-port

Description Port (Port Value)

Type: number

Range: 1-65535

tcp-sessions

Description Number of Extended Quota sessions allowed for this service

Type: number

Range: 1-255

ds-lite¶

Specification Value

Type object

inside-src-permit-list

Description Class-List of IPv4 addresses permitted (Class-list to match for DS-Lite)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

user-quota¶

Specification Value

Type object

icmp

Description User Quota for ICMP identifiers (NAT port quota per user (default: not configured))

Type: number

Range: 1-64000

quota-tcp

Description: quota-tcp is a JSON Block. Please see below for user-quota_quota-tcp

Type: Object

quota-udp

Description: quota-udp is a JSON Block. Please see below for user-quota_quota-udp

Type: Object

session

Description User Quota for number of data sessions

Type: number

Range: 1-2147483647

user-quota_quota-tcp¶

Specification Value

Type object

tcp-quota

Description NAT port quota per user (default: not configured)

Type: number

Range: 1-64000

tcp-reserve

Description Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))

Type: number

Range: 0-64000

user-quota_quota-udp¶

Specification Value

Type object

udp-quota

Description NAT port quota per user (default: not configured)

Type: number

Range: 1-64000

udp-reserve

Description Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))

Type: number

Range: 0-64000

source-nat-pool¶

Specification Value

Type object

pool-name

Description Source NAT Pool or Pool-Group

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

shared

Description Use a shared source NAT pool or pool-group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-rate-limit¶

Specification Value

Type object

conn-rate-limit-val

Description Maximum connections per second (Default: No limit)

Type: number

Range: 1-65535

lsn-rule-list¶

Specification Value

Type object

destination

Description Apply LSN Rule-List on Destination (LSN Rule-List Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/cgnv6/lsn-rule-list