cgnv6 fixed-nat¶
Configure Fixed NAT
fixed-nat Specification¶
Type
Intermediate Resource
Element Name
fixed-nat
Element URI
/axapi/v3/cgnv6/fixed-nat
Element Attributes
fixed-nat_attributes
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/cgnv6/fixed-nat | fixed-nat_attributes |
fixed-nat attributes¶
alg
Description: alg is a JSON Block. Please see below for alg
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg
disable
Description: disable is a JSON Block. Please see below for disable
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/disable
disabled-config
Description: disabled-config is a JSON Block. Please see below for disabled-config
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/disabled-config
full-cone-session
Description: full-cone-session is a JSON Block. Please see below for full-cone-session
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/full-cone-session
global
Description: global is a JSON Block. Please see below for global
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/global
histogram
Description: histogram is a JSON Block. Please see below for histogram
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/histogram
inside
Description: inside is a JSON Block. Please see below for inside
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/inside
per-instance
Description: per-instance is a JSON Block. Please see below for per-instance
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/per-instance
port-mapping
Description: port-mapping is a JSON Block. Please see below for port-mapping
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/port-mapping
port-mapping-files
Description: port-mapping-files is a JSON Block. Please see below for port-mapping-files
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/port-mapping-files
user-quota
Description: user-quota is a JSON Block. Please see below for user-quota
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/user-quota
port-mapping¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
full-cone-session¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg¶
Specification
Type
object
esp
Description: esp is a JSON Block. Please see below for alg_esp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/esp
ftp
Description: ftp is a JSON Block. Please see below for alg_ftp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/ftp
h323
Description: h323 is a JSON Block. Please see below for alg_h323
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/h323
mgcp
Description: mgcp is a JSON Block. Please see below for alg_mgcp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/mgcp
pptp
Description: pptp is a JSON Block. Please see below for alg_pptp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/pptp
rtsp
Description: rtsp is a JSON Block. Please see below for alg_rtsp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for alg_sip
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for alg_tftp
Type: Object
Refernce Object: /axapi/v3/cgnv6/fixed-nat/alg/tftp
alg_ftp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_sip¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_esp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_pptp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_rtsp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_h323¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_tftp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
alg_mgcp¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
inside¶
Specification
Type
object
iplist-list
Type: List
Refernce Object: /axapi/v3/cgnv6/fixed-nat/inside/iplist/{inside-ip-list}+{partition}
ipv4address-list
ipv6address-list
inside_iplist-list¶
Specification
Type
list
Block object keys
dest-rule-list
Description Bind destination based Rule-List (Fixed NAT Rule-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
dynamic-pool-size
Description Configure size of Dynamic pool (Default: 0)
Type: number
Range: 0-64511
Default: 0
inside-ip-list
Description Name of IP List used to specify Inside Users
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
method
Description ‘use-all-nat-ips’: Use all the NAT IP addresses configured; ‘use-least-nat-ips’: Use the least number of NAT IP addresses required (default);
Type: string
Supported Values: use-all-nat-ips, use-least-nat-ips
Default: use-least-nat-ips
nat-end-address
Description IPv4 End NAT Address
Type: string
Format: ipv4-address
nat-ip-list
Description Name of IP List used to specify NAT addresses
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
nat-netmask
Description NAT Addresses IP Netmask
Type: string
Format: ipv4-netmask-brief
nat-start-address
Description Start NAT Address
Type: string
Format: ipv4-address
offset
Description: offset is a JSON Block. Please see below for inside_iplist-list_offset
Type: Object
partition
Description Inside User Partition (Partition Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
ports-per-user
Description Configure Ports per Inside User (ports-per-user)
Type: number
Range: 1-64512
respond-to-user-mac
Description Use the user’s source MAC for the next hop rather than the routing table (Default: off)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
session-quota
Description Configure per user quota on sessions
Type: number
Range: 1-2147483647
skip-ports-on-rollover
Description Not using the first block of ports for NAT IPs smaller than the configured offset
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
usable-nat-ports
Description: usable-nat-ports is a JSON Block. Please see below for inside_iplist-list_usable-nat-ports
Type: Object
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
inside_iplist-list_usable-nat-ports¶
Specification
Type
object
usable-end-port
Description End Port of Usable NAT Ports
Type: number
Range: 1024-65535
usable-start-port
Description Start Port of Usable NAT Ports
Type: number
Range: 1024-65535
inside_iplist-list_offset¶
Specification
Type
object
numeric-offset
Description Configure a numeric offset to the first NAT IP address
Type: number
Range: 0-1024000
Default: 0
Mutual Exclusion: numeric-offset and random are mutually exclusive
random
Description Randomly choose the first NAT IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: random and numeric-offset are mutually exclusive
inside_ipv4address-list¶
Specification
Type
list
Block object keys
dest-rule-list
Description Bind destination based Rule-List (Fixed NAT Rule-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
dynamic-pool-size
Description Configure size of Dynamic pool (Default: 0)
Type: number
Range: 0-64511
Default: 0
inside-end-address
Description IPv4 Inside User End Address
Type: string
Format: ipv4-address
inside-netmask
Description IPv4 Netmask
Type: string
Format: ipv4-netmask-brief
inside-start-address
Description IPv4 Inside User Start Address
Type: string
Format: ipv4-address
method
Description ‘use-all-nat-ips’: Use all the NAT IP addresses configured; ‘use-least-nat-ips’: Use the least number of NAT IP addresses required (default);
Type: string
Supported Values: use-all-nat-ips, use-least-nat-ips
Default: use-least-nat-ips
nat-end-address
Description IPv4 End NAT Address
Type: string
Format: ipv4-address
nat-ip-list
Description Name of IP List used to specify NAT addresses
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
nat-netmask
Description NAT Addresses IP Netmask
Type: string
Format: ipv4-netmask-brief
nat-start-address
Description Start NAT Address
Type: string
Format: ipv4-address
offset
Description: offset is a JSON Block. Please see below for inside_ipv4address-list_offset
Type: Object
partition
Description Inside User Partition (Partition Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
ports-per-user
Description Configure Ports per Inside User (ports-per-user)
Type: number
Range: 1-64512
respond-to-user-mac
Description Use the user’s source MAC for the next hop rather than the routing table (Default: off)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
session-quota
Description Configure per user quota on sessions
Type: number
Range: 1-2147483647
skip-ports-on-rollover
Description Not using the first block of ports for NAT IPs smaller than the configured offset
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
usable-nat-ports
Description: usable-nat-ports is a JSON Block. Please see below for inside_ipv4address-list_usable-nat-ports
Type: Object
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
inside_ipv4address-list_usable-nat-ports¶
Specification
Type
object
usable-end-port
Description End Port of Usable NAT Ports
Type: number
Range: 1024-65535
usable-start-port
Description Start Port of Usable NAT Ports
Type: number
Range: 1024-65535
inside_ipv4address-list_offset¶
Specification
Type
object
numeric-offset
Description Configure a numeric offset to the first NAT IP address
Type: number
Range: 0-1024000
Default: 0
Mutual Exclusion: numeric-offset and random are mutually exclusive
random
Description Randomly choose the first NAT IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: random and numeric-offset are mutually exclusive
inside_ipv6address-list¶
Specification
Type
list
Block object keys
dest-rule-list
Description Bind destination based Rule-List (Fixed NAT Rule-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
dynamic-pool-size
Description Configure size of Dynamic pool (Default: 0)
Type: number
Range: 0-64511
Default: 0
inside-end-address
Description IPv6 Inside User End Address
Type: string
Format: ipv6-address
inside-netmask
Description Inside User IPv6 Netmask
Type: number
Range: 64-128
inside-start-address
Description IPv6 Inside User Start Address
Type: string
Format: ipv6-address
method
Description ‘use-all-nat-ips’: Use all the NAT IP addresses configured; ‘use-least-nat-ips’: Use the least number of NAT IP addresses required (default);
Type: string
Supported Values: use-all-nat-ips, use-least-nat-ips
Default: use-least-nat-ips
nat-end-address
Description IPv4 End NAT Address
Type: string
Format: ipv4-address
nat-ip-list
Description Name of IP List used to specify NAT addresses
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
nat-netmask
Description NAT Addresses IP Netmask
Type: string
Format: ipv4-netmask-brief
nat-start-address
Description Start NAT Address
Type: string
Format: ipv4-address
offset
Description: offset is a JSON Block. Please see below for inside_ipv6address-list_offset
Type: Object
partition
Description Inside User Partition (Partition Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
ports-per-user
Description Configure Ports per Inside User (ports-per-user)
Type: number
Range: 1-64512
respond-to-user-mac
Description Use the user’s source MAC for the next hop rather than the routing table (Default: off)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
session-quota
Description Configure per user quota on sessions
Type: number
Range: 1-2147483647
skip-ports-on-rollover
Description Not using the first block of ports for NAT IPs smaller than the configured offset
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
usable-nat-ports
Description: usable-nat-ports is a JSON Block. Please see below for inside_ipv6address-list_usable-nat-ports
Type: Object
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
inside_ipv6address-list_usable-nat-ports¶
Specification
Type
object
usable-end-port
Description End Port of Usable NAT Ports
Type: number
Range: 1024-65535
usable-start-port
Description Start Port of Usable NAT Ports
Type: number
Range: 1024-65535
inside_ipv6address-list_offset¶
Specification
Type
object
numeric-offset
Description Configure a numeric offset to the first NAT IP address
Type: number
Range: 0-1024000
Default: 0
Mutual Exclusion: numeric-offset and random are mutually exclusive
random
Description Randomly choose the first NAT IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: random and numeric-offset are mutually exclusive
global¶
Specification
Type
object
create-port-mapping-file
Description Create Port Mapping File
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-mapping-files-count
Description Number of old fixed_nat files to store
Type: number
Range: 1-10
Default: 5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
user-quota¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
histogram¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disabled-config¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable¶
Specification
Type
object
clear-session
Description Clear all sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
inside-end-v4address
Description IPv4 Inside User End Address
Type: string
Format: ipv4-address
inside-end-v6address
Description IPv6 Inside User End Address
Type: string
Format: ipv6-address
inside-start-v4address
Description IPv4 Inside User Start Address
Type: string
Format: ipv4-address
inside-start-v6address
Description IPv6 Inside User Start Address
Type: string
Format: ipv6-address
ip-list
Description Name of IP List used to specify Inside Users
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
v4-netmask
Description IPv4 Netmask
Type: string
Format: ipv4-netmask-brief
v6-netmask
Description Inside User IPv6 Netmask
Type: number
Range: 64-128
port-mapping-files¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
per-instance¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters