ipv6 nat pool¶

IPv6 pool name

pool Specification¶

Parameter Value

Type Collection

Object Key(s) pool-name

Collection Name pool-list

Collection URI /axapi/v3/ipv6/nat/pool

Element Name pool

Element URI /axapi/v3/ipv6/nat/pool/{pool-name}

Element Attributes pool_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/ipv6/nat/pool/{pool-name}/stats

Operational Data URI /axapi/v3/ipv6/nat/pool/{pool-name}/oper

Schema pool schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ipv6/nat/pool	pool attributes
POST /axapi/v3/ipv6/nat/pool/ Payload: { "pool": { "netmask": 64, "end-address": "2003::1", "start-address": "2003::1", "pool-name": "a", "gateway": "2003::2" } }
Create List	POST	/axapi/v3/ipv6/nat/pool	pool attributes
Get Object	GET	/axapi/v3/ipv6/nat/pool/{pool-name}	pool attributes
GET /axapi/v3/ipv6/nat/pool/a Reponse: { "pool": { "pool-name": "a", "start-address": "2003::1", "end-address": "2003::1", "netmask": 64, "gateway": "2003::2", "ip-rr": 0, "port-overload": 0, "chunk-sharing": 0, "uuid": "a0561a5e-5028-11ee-8669-0fa4a4d41b74", "a10-url": "/axapi/v3/ipv6/nat/pool/a" } }
Get List	GET	/axapi/v3/ipv6/nat/pool	pool-list
Modify Object	POST	/axapi/v3/ipv6/nat/pool/{pool-name}	pool attributes
Replace Object	PUT	/axapi/v3/ipv6/nat/pool/{pool-name}	pool attributes
PUT /axapi/v3/ipv6/nat/pool/a Payload: { "pool": { "netmask": 64, "end-address": "2003::1", "start-address": "2003::1", "pool-name": "a", "vrid": 1 } }
Replace List	PUT	/axapi/v3/ipv6/nat/pool	pool-list
Delete Object	DELETE	/axapi/v3/ipv6/nat/pool/{pool-name}	pool attributes
DELETE /axapi/v3/ipv6/nat/pool/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

pool-list¶

pool-list is JSON List of pool attributes

pool-list : [

{ pool attributes },

{ pool attributes },

…

]

pool attributes¶

chunk-sharing

Description Share NAT pool chunk across CPUs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

end-address

Description Configure end IP address of NAT pool

Type: string

Format: ipv6-address

gateway

Description Configure gateway IP

Type: string

Format: ipv6-address

ip-rr

Description Use IP address round-robin behavior

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

netmask

Description Configure mask for pool

Type: number

Range: 64-128

pool-name

Description Specify pool name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

port-overload

Description Nat Pool Port overload

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Type: List

scaleout-device-id

Description Configure Scaleout device id to which this NAT pool is to be bound (Specify Scaleout device id)

Type: number

Range: 1-16

start-address

Description Configure start IP address of NAT pool

Type: string

Format: ipv6-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrid

Description Specify VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘Port-Usage’: some help string; ‘Total-Used’: some help string; ‘Total-Freed’: some help string; ‘Failed’: some help string;

Type: string

Supported Values: all, Port-Usage, Total-Used, Total-Freed, Failed