cgnv6 lsn global¶
Set Large-Scale NAT config parameters
global Specification¶
Type
Configuration Resource
Element Name
global
Element URI
/axapi/v3/cgnv6/lsn/global
Element Attributes
global_attributes
Statistics Data URI
/axapi/v3/cgnv6/lsn/global/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/lsn/global | ||
Get Object | GET | /axapi/v3/cgnv6/lsn/global | ||
Modify Object | POST | /axapi/v3/cgnv6/lsn/global | ||
Replace Object | PUT | /axapi/v3/cgnv6/lsn/global | ||
Delete Object | DELETE | /axapi/v3/cgnv6/lsn/global |
global attributes¶
attempt-port-preservation
Description ‘disable’: Don’t attempt port preservation for NAT allocation;
Type: string
Supported Values: disable
enhanced-user-tracking
Description Enable enhanced user tracking and visibility (default: disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hairpinning
Description ‘filter-none’: Allow self-hairpinning (default). Warning: Only applies to UDP. TCP will use filter-self-ip-port; ‘filter-self-ip’: Block hairpinning to the user’s own IP; ‘filter-self-ip-port’: Block hairpinning to the user’s same IP and port combination;
Type: string
Supported Values: filter-none, filter-self-ip, filter-self-ip-port
Default: filter-none
half-close-timeout
Description Set LSN Half close timeout (Half close timeout in seconds (default not set))
Type: number
Range: 2-3000
icmp
Description: icmp is a JSON Block. Please see below for icmp
Type: Object
inbound-refresh
Description ‘disable’: Disable NAT Inbound Refresh Behavior;
Type: string
Supported Values: disable
ip-selection
Description ‘random’: Random (long-run uniformly distributed) NAT IP selection (default); ‘round-robin’: Round-robin; ‘least-used-strict’: Fewest NAT ports used; ‘least-udp-used-strict’: Fewest UDP NAT ports used; ‘least-tcp-used-strict’: Fewest TCP NAT ports used; ‘least-reserved-strict’: Fewest NAT ports reserved; ‘least-udp-reserved-strict’: Fewest UDP NAT ports reserved; ‘least-tcp-reserved-strict’: Fewest TCP NAT ports reserved; ‘least-users-strict’: Fewest number of users;
Type: string
Supported Values: random, round-robin, least-used-strict, least-udp-used-strict, least-tcp-used-strict, least-reserved-strict, least-udp-reserved-strict, least-tcp-reserved-strict, least-users-strict
Default: random
logging
Description: logging is a JSON Block. Please see below for logging
Type: Object
port-batching
Description: port-batching is a JSON Block. Please see below for port-batching
Type: Object
strictly-sticky-nat
Description Strictly adheres to sticky-nat (default: disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
syn-timeout
Description Set LSN SYN timeout (SYN idle-timeout in seconds (default: 4 seconds))
Type: number
Range: 2-30
Default: 4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp¶
Specification
Type
object
send-on-port-unavailable
Description ‘host-unreachable’: Send ICMP destination host unreachable; ‘admin-filtered’: Send ICMP admin filtered; ‘disable’: Disable ICMP port unavailable message (default);
Type: string
Supported Values: host-unreachable, admin-filtered, disable
Default: disable
send-on-user-quota-exceeded
Description ‘host-unreachable’: Send ICMP destination host unreachable; ‘admin-filtered’: Send ICMP admin filtered (default); ‘disable’: Disable ICMP quota exceeded message;
Type: string
Supported Values: host-unreachable, admin-filtered, disable
Default: admin-filtered
logging¶
Specification
Type
object
default-template
Description Bind the default NAT logging template for LSN (Bind a NAT logging template)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/cgnv6/template/logging
partition-name
Description Select partition name for logging
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Mutual Exclusion: partition-name and shared are mutually exclusive
Refernce Object: /axapi/v3/partition
pool
Type: List
shared
Description Select shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared and partition-name are mutually exclusive
logging_pool¶
Specification
Type
list
Block object keys
pool-name
Description NAT pool
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/cgnv6/nat/pool
template
Description Bind a NAT logging template
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/cgnv6/template/logging
port-batching¶
Specification
Type
object
size
Description ‘1’: Allocate 1 port at a time (default); ‘8’: Allocate 8 ports at a time; ‘16’: Allocate 16 ports at a time; ‘32’: Allocate 32 ports at a time; ‘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;
Type: string
Supported Values: 1, 8, 16, 32, 64, 128, 256, 512
Default: 1
tcp-time-wait-interval
Description Minutes before TCP NAT ports can be reused (default: 2)
Type: number
Range: 0-10
Default: 2
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
rev_egress_pkt_size_range1 |
8 |
Reverse Egress Packet size between 0 and 200 |
|
endpoint_indep_filter_match |
8 |
Endpoint-Independent Filtering Matched |
|
hairpin |
8 |
Hairpin Session Created |
|
fwd_ingress_packets_udp |
8 |
Forward Ingress Packets UDP |
|
lid_pass_through |
8 |
LSN LID Pass-through |
|
rev_egress_bytes_tcp |
8 |
Reverse Egress Bytes TCP |
|
fwd_egress_bytes_others |
8 |
Forward Egress Bytes OTHERS |
|
fwd_egress_bytes_udp |
8 |
Forward Egress Bytes UDP |
|
ha_nat_pool_unusable |
8 |
HA NAT Pool Unusable |
|
tcp_user_quota_exceeded |
8 |
TCP User-Quota Exceeded |
|
rev_ingress_packets_udp |
8 |
Reverse Ingress Packets UDP |
|
rev_egress_bytes_icmp |
8 |
Reverse Egress Bytes ICMP |
|
rev_egress_bytes_udp |
8 |
Reverse Egress Bytes UDP |
|
ha_nat_pool_batch_type_mismatch |
8 |
HA NAT Pool Batch Type Mismatch |
|
h323_alg_alloc_single_port_failure |
8 |
H323 ALG Alloc Single RTP or RTCP NAT Port Failure |
|
rev_ingress_packets_others |
8 |
Reverse Ingress Packets OTHERS |
|
user_quota_unusable_drop |
8 |
User-Quota Unusable Drop |
|
fwd_egress_packets_icmp |
8 |
Forward Egress Packets ICMP |
|
fullcone_failure |
8 |
Full-cone Session Creation Failed |
|
fwd_ingress_pkt_size_range2 |
8 |
Forward Ingress Packet size between 201 and 800 |
|
fwd_ingress_pkt_size_range3 |
8 |
Forward Ingress Packet size between 801 and 1550 |
|
fwd_ingress_pkt_size_range1 |
8 |
Forward Ingress Packet size between 0 and 200 |
|
data_sesn_user_quota_exceeded |
8 |
Data Session User-Quota Exceeded |
|
lid_drop |
8 |
LSN LID Drop |
|
fwd_ingress_pkt_size_range4 |
8 |
Forward Ingress Packet size between 1551 and 9000 |
|
sip_alg_create_rtcp_fullcone_failure |
8 |
SIP ALG Create RTCP Full-cone Session Failure |
|
fwd_egress_bytes_tcp |
8 |
Forward Egress Bytes TCP |
|
port_overloading_smp_free_tcp |
8 |
TCP Port Overloading Session Freed |
|
rev_ingress_packets_tcp |
8 |
Reverse Ingress Packets TCP |
|
rev_egress_packets_tcp |
8 |
Reverse Egress Packets TCP |
|
h323_alg_create_rtp_fullcone_failure |
8 |
H323 ALG Create RTP Full-cone Session Failure |
|
standby_class_list_drop |
8 |
HA Standby Class-List drop |
|
total_tcp_freed |
8 |
Total TCP Ports Freed |
|
fwd_egress_packets_tcp |
8 |
Forward Egress Packets TCP |
|
total_icmp_freed |
8 |
Total ICMP Ports Freed |
|
tcp_fullcone_created |
8 |
TCP Full-cone Session Created |
|
fwd_egress_packets_others |
8 |
Forward Egress Packets OTHERS |
|
udp_fullcone_created |
8 |
UDP Full-cone Session Created |
|
mgcp_alg_create_rtp_fullcone_failure |
8 |
MGCP ALG Create RTP Full-cone Session Failure |
|
icmp_user_quota_exceeded |
8 |
ICMP User-Quota Exceeded |
|
total_tcp_allocated |
8 |
Total TCP Ports Allocated |
|
sip_alg_alloc_single_port_failure |
8 |
SIP ALG Alloc Single RTP or RTCP NAT Port Failure |
|
extended_quota_matched |
8 |
Extended User-Quota Matched |
|
fwd_egress_pkt_size_range4 |
8 |
Forward Egress Packet size between 1551 and 9000 |
|
tcp_fullcone_freed |
8 |
TCP Full-cone Session Freed |
|
sip_alg_quota_inc_failure |
8 |
SIP ALG User-Quota Exceeded |
|
user_quota_failure |
8 |
User-Quota Creation Failed |
|
user_quota_created |
8 |
User-Quota Created |
|
rev_egress_packets_icmp |
8 |
Reverse Egress Packets ICMP |
|
data_sesn_rate_user_quota_exceeded |
8 |
Conn Rate User-Quota Exceeded |
|
fullcone_self_hairpinning_drop |
8 |
Self-Hairpinning Drop |
|
mgcp_alg_create_rtcp_fullcone_failure |
8 |
MGCP ALG Create RTCP Full-cone Session Failure |
|
new_user_resource_unavailable |
8 |
New User NAT Resource Unavailable |
|
total_udp_allocated |
8 |
Total UDP Ports Allocated |
|
data_session_created |
8 |
Data Session Created |
|
rev_ingress_bytes_tcp |
8 |
Reverse Ingress Bytes TCP |
|
fwd_ingress_bytes_others |
8 |
Forward Ingress Bytes OTHERS |
|
rev_ingress_bytes_others |
8 |
Reverse Ingress Bytes OTHERS |
|
port_overloading_out_of_memory |
8 |
Port Overloading Out of Memory |
|
fwd_ingress_bytes_tcp |
8 |
Forward Ingress Bytes TCP |
|
nat_port_unavailable_icmp |
8 |
ICMP NAT Port Unavailable |
|
adc_port_allocation_failed |
8 |
ADC Port Allocation Failed |
|
fullcone_ext_mem_alloc_init_faulure |
8 |
LSN Fullcone Extension Initialization Failure |
|
port_overloading_smp_inserted_tcp |
8 |
TCP Port Overloading Session Created |
|
fwd_egress_bytes_icmp |
8 |
Forward Egress Bytes ICMP |
|
eif_limit_exceeded |
8 |
Endpoint-Independent Filtering Inbound Limit Exceeded |
|
port_overloading_smp_inserted_udp |
8 |
UDP Port Overloading Session Created |
|
port_overloading_inc_overflow |
8 |
Port Overloading Inc Overflow |
|
user_quota_put_in_del_q |
8 |
User-Quota Freed |
|
mgcp_alg_port_pair_alloc_from_quota_partition_error |
8 |
MGCP ALG Port Pair Allocated From Quota Partition Error |
|
total_udp_freed |
8 |
Total UDP Ports Freed |
|
fwd_egress_pkt_size_range3 |
8 |
Forward Egress Packet size between 801 and 1550 |
|
fwd_egress_pkt_size_range2 |
8 |
Forward Egress Packet size between 201 and 800 |
|
nat_port_unavailable_tcp |
8 |
TCP NAT Port Unavailable |
|
total_tcp_overloaded |
8 |
TCP Port Overloaded |
|
fwd_ingress_packets_tcp |
8 |
Forward Ingress Packets TCP |
|
user_quota_unusable |
8 |
User-Quota Marked Unusable |
|
nat_ip_max_udp_ports_allocated |
8 |
NAT IP UDP Max Ports Allocated |
|
sip_alg_alloc_rtp_rtcp_port_failure |
8 |
SIP ALG Alloc RTP/RTCP NAT Ports Failure |
|
sip_alg_create_rtp_fullcone_failure |
8 |
SIP ALG Create RTP Full-cone Session Failure |
|
sip_alg_create_single_fullcone_failure |
8 |
SIP ALG Create Single RTP or RTCP Full-cone Session Failure |
|
rev_egress_packets_others |
8 |
Reverse Egress Packets OTHERS |
|
h323_alg_create_rtcp_fullcone_failure |
8 |
H323 ALG Create RTCP Full-cone Session Failure |
|
no_radius_profile_match |
8 |
No RADIUS Profile Match |
|
endpoint_indep_map_match |
8 |
Endpoint-Independent Mapping Matched |
|
rev_ingress_pkt_size_range4 |
8 |
Reverse Ingress Packet size between 1551 and 9000 |
|
rev_ingress_pkt_size_range2 |
8 |
Reverse Ingress Packet size between 201 and 800 |
|
rev_ingress_pkt_size_range3 |
8 |
Reverse Ingress Packet size between 801 and 1550 |
|
rev_ingress_pkt_size_range1 |
8 |
Reverse Ingress Packet size between 0 and 200 |
|
total_icmp_allocated |
8 |
Total ICMP Ports Allocated |
|
no_class_list_match |
8 |
No Class-List Match |
|
inbound_filtered |
8 |
Endpoint-Dependent Filtering Drop |
|
data_session_freed |
8 |
Data Session Freed |
|
total_udp_overloaded |
8 |
UDP Port Overloaded |
|
udp_fullcone_freed |
8 |
UDP Full-cone Session Freed |
|
nat_pool_unusable |
8 |
NAT Pool Unusable |
|
nat_port_unavailable_udp |
8 |
UDP NAT Port Unavailable |
|
fwd_ingress_packets_others |
8 |
Forward Ingress Packets OTHERS |
|
rev_ingress_bytes_udp |
8 |
Reverse Ingress Bytes UDP |
|
rev_ingress_bytes_icmp |
8 |
Reverse Ingress Bytes ICMP |
|
rev_egress_bytes_others |
8 |
Reverse Egress Bytes OTHERS |
|
port_overloading_smp_free_udp |
8 |
UDP Port Overloading Session Freed |
|
udp_user_quota_exceeded |
8 |
UDP User-Quota Exceeded |
|
h323_alg_create_single_fullcone_failure |
8 |
H323 ALG Create Single RTP or RTCP Full-cone Session Failure |
|
fullcone_ext_mem_alloc_failure |
8 |
LSN Fullcone Extension Memory Allocate Failure |
|
fwd_ingress_bytes_icmp |
8 |
Forward Ingress Bytes ICMP |
|
fwd_egress_pkt_size_range1 |
8 |
Forward Egress Packet size between 0 and 200 |
|
rev_ingress_packets_icmp |
8 |
Reverse Ingress Packets ICMP |
|
rev_egress_packets_udp |
8 |
Reverse Egress Packets UDP |
|
fwd_ingress_bytes_udp |
8 |
Forward Ingress Bytes UDP |
|
nat_ip_max_tcp_ports_allocated |
8 |
NAT IP TCP Max Ports Allocated |
|
fwd_egress_packets_udp |
8 |
Forward Egress Packets UDP |
|
extended_quota_exceeded |
8 |
Extended User-Quota Exceeded |
|
rev_egress_pkt_size_range4 |
8 |
Reverse Egress Packet size between 1551 and 9000 |
|
rev_egress_pkt_size_range3 |
8 |
Reverse Egress Packet size between 801 and 1550 |
|
fwd_ingress_packets_icmp |
8 |
Forward Ingress Packets ICMP |
|
rev_egress_pkt_size_range2 |
8 |
Reverse Egress Packet size between 201 and 800 |