ip nat pool

Configure pools of IP addresses for Network Address Translation.

pool Specification

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
Statistics Data URI /axapi/v3/ip/nat/pool/{pool-name}/stats
Schema pool schema

Operations Allowed:

Operation Method URI Payload

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

Get Stats

GET

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

stats data

pool-list

pool-list is JSON List of pool Attributes

pool-list : [

pool Attributes

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

Required: Yes

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-64

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

vrid

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

Type: number

Range: 1-31

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

stats data

Counter Size Description
Failed 8 Failed
Total-Used 8 Total-Used
Total-Freed 8 Total-Freed
Port-Usage 8 Port-Usage