ip nat pool

Configure IP pool name

pool Specification

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

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/ip/nat/pool

pool attributes

Create List

POST

/axapi/v3/ip/nat/pool

pool attributes

Get Object

GET

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

pool attributes

Get List

GET

/axapi/v3/ip/nat/pool

pool-list

Modify Object

POST

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

pool attributes

Replace Object

PUT

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

pool attributes

Replace List

PUT

/axapi/v3/ip/nat/pool

pool-list

Delete Object

DELETE

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

pool attributes

pool-list

pool-list is JSON List of pool attributes

pool-list : [

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: ipv4-address

ethernet

Description Ethernet interface

Type: number

Format: interface

gateway

Description Configure gateway IP

Type: string

Format: ipv4-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: string

Format: ipv4-netmask-brief

pool-name

Description Specify pool name or pool group

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

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: ipv4-address

Mutual Exclusion: start-address and use-if-ip are mutually exclusive

use-if-ip

Description Use Interface IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: use-if-ip and start-address are mutually exclusive

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

Reference Object: /axapi/v3/vrrp-a/vrid