cgnv6 nat pool

Configure CGNv6 NAT pool

pool Specification

Parameter Value
Type Collection
Object Key(s) pool-name
Collection Name pool-list
Collection URI /axapi/v3/cgnv6/nat/pool
Element Name pool
Element URI /axapi/v3/cgnv6/nat/pool/{pool-name}
Element Attributes pool_attributes
Partition Visibility shared
Statistics Data URI /axapi/v3/cgnv6/nat/pool/{pool-name}/stats
Operational Data URI /axapi/v3/cgnv6/nat/pool/{pool-name}/oper
Schema pool schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/cgnv6/nat/pool

pool attributes

Create List

POST

/axapi/v3/cgnv6/nat/pool

pool attributes

Get Object

GET

/axapi/v3/cgnv6/nat/pool/{pool-name}

pool attributes

Get List

GET

/axapi/v3/cgnv6/nat/pool

pool-list

Modify Object

POST

/axapi/v3/cgnv6/nat/pool/{pool-name}

pool attributes

Replace Object

PUT

/axapi/v3/cgnv6/nat/pool/{pool-name}

pool attributes

Replace List

PUT

/axapi/v3/cgnv6/nat/pool

pool-list

Delete Object

DELETE

/axapi/v3/cgnv6/nat/pool/{pool-name}

pool attributes

pool-list

pool-list is JSON List of pool attributes

pool-list : [

pool attributes

all

Description Share with all partitions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

end-address

Description Configure end IP address of NAT pool

Type: string

Format: ipv4-address

exclude-ip

Type: List

group

Description Share with a partition group (Partition Group Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

max-users-per-ip

Description Number of users that can be assigned to a NAT IP

Type: number

Range: 1-64512

netmask

Description Configure mask for pool

Type: string

Format: ipv4-netmask-brief

partition

Description Share with a single partition (Partition Name)

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

per-batch-port-usage-warning-threshold

Description Configure warning log threshold for per batch port usage (default: disabled) (Number of ports)

Type: number

Range: 32-4096

pool-name

Description Specify pool name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

port-batch-v2-size

Description ‘64’: Allocate 64 ports at a time; ‘128’: Allocate 128 ports at a time; ‘256’: Allocate 256 ports at a time; ‘512’: Allocate 512 ports at a time; ‘1024’: Allocate 1024 ports at a time; ‘2048’: Allocate 2048 ports at a time; ‘4096’: Allocate 4096 ports at a time;

Type: string

Supported Values: 64, 128, 256, 512, 1024, 2048, 4096

shared

Description Share this pool with other partitions (default: not shared)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

simultaneous-batch-allocation

Description Allocate same TCP and UDP batches at once

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

start-address

Description Configure start IP address of NAT pool

Type: string

Format: ipv4-address

tcp-time-wait-interval

Description Minutes before TCP NAT ports can be reused

Type: number

Range: 0-10

usable-nat-ports

Description Configure usable NAT ports

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

usable-nat-ports-end

Description End Port of Usable NAT Ports

Type: number

Range: 1024-65535

usable-nat-ports-start

Description Start Port of Usable NAT Ports (needs to be even)

Type: number

Range: 1024-65535

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrid

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

Type: number

Range: 1-31

exclude-ip

Specification Value
Type list
Block object keys  

exclude-ip-end

Description Address range end

Type: string

Format: ipv4-address

exclude-ip-start

Description Single IP address or IP address range start

Type: string

Format: ipv4-address