cgnv6 nat

Configure CGNv6 NAT

nat Specification

   
Type Intermediate Resource
Element Name nat
Element URI /axapi/v3/cgnv6/nat
Element Attributes nat_attributes
Schema nat schema

Operations Allowed:

OperationMethodURIPayload

Get Object

GET

/axapi/v3/cgnv6/nat

nat_attributes

nat attributes

icmp

Description: icmp is a JSON Block. Please see below for icmp

Type: Object

Refernce Object: /axapi/v3/cgnv6/nat/icmp

icmpv6

Description: icmpv6 is a JSON Block. Please see below for icmpv6

Type: Object

Refernce Object: /axapi/v3/cgnv6/nat/icmpv6

inside

Description: inside is a JSON Block. Please see below for inside

Type: Object

Refernce Object: /axapi/v3/cgnv6/nat/inside

pool-group-list

pool-list

Type: List

Refernce Object: /axapi/v3/cgnv6/nat/pool/{pool-name}

range-list-list

range-list-list

Specification  
Type list
Block object keys  

global-netmaskv4

Description Mask for this Address range

Type: string

Format: ipv4-netmask

global-start-ipv4-addr

Description Global Start IPv4 Address of this list

Type: string

Format: ipv4-address

local-netmaskv4

Description Mask for this Address range

Type: string

Format: ipv4-netmask

local-start-ipv4-addr

Description Local Start IPv4 Address of this list

Type: string

Format: ipv4-address

name

Description Name for this Static List

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

partition

Description Inside User Partition (Partition Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

v4-count

Description Number of addresses to be translated in this range

Type: number

Range: 1-200000

v4-vrid

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

Type: number

Range: 1-31

pool-group-list

Specification  
Type list
Block object keys  

member-list

pool-group-name

Description Specify pool group name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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

vrid

Description Specify VRRP-A vrid

Type: number

Range: 1-31

pool-group-list_member-list

Specification  
Type list
Block object keys  

pool-name

Description Specify CGNv6 NAT pool name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

icmpv6

Specification  
Type object

respond-to-ping

Description Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

icmp

Specification  
Type object

always-source-nat-errors

Description Source NAT intermediate routers’ IPs for ICMP errors (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

respond-to-ping

Description Respond to ICMP echo requests to NAT pool IPs (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

inside

Specification  
Type object

source

Description: source is a JSON Block. Please see below for inside_source

Type: Object

Refernce Object: /axapi/v3/cgnv6/nat/inside/source

inside_source

Specification  
Type object

static-list

inside_source_static-list

Specification  
Type list
Block object keys  

nat-address

Description NAT Address

Type: string

Format: ipv4-address

partition

Description Inside User Partition (Partition Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

src-address

Description Original Source Address

Type: string

Format: ipv4-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrid

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

Type: number

Range: 1-31

pool-list

Specification  
Type list
Block object keys  

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

pool-name

Description Specify pool name or pool group

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

shared

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

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

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

pool-list_exclude-ip

Specification  
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