cgnv6¶
CGN and IPv6 Migration commands
cgnv6 Specification¶
Parameter
Value
Type
Intermediate Resource
Element Name
cgnv6
Element URI
/axapi/v3/cgnv6
Element Attributes
cgnv6_attributes
Partition Visibility
shared
Schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Get Object | GET | /axapi/v3/cgnv6 | cgnv6_attributes |
cgnv6 attributes¶
ddos-protection
Description: ddos-protection is a JSON Block. Please see below for ddos-protection
Type: Object
Reference Object: /axapi/v3/cgnv6/ddos-protection
dns64
Description: dns64 is a JSON Block. Please see below for dns64
Type: Object
Reference Object: /axapi/v3/cgnv6/dns64
dns64-virtualserver-list
Type: List
Reference Object: /axapi/v3/cgnv6/dns64-virtualserver/{name}
ds-lite
Description: ds-lite is a JSON Block. Please see below for ds-lite
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite
ecmp
Description: ecmp is a JSON Block. Please see below for ecmp
Type: Object
Reference Object: /axapi/v3/cgnv6/ecmp
fixed-nat
Description: fixed-nat is a JSON Block. Please see below for fixed-nat
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat
global
Description: global is a JSON Block. Please see below for global
Type: Object
Reference Object: /axapi/v3/cgnv6/global
http-alg
Description: http-alg is a JSON Block. Please see below for http-alg
Type: Object
Reference Object: /axapi/v3/cgnv6/http-alg
icmp
Description: icmp is a JSON Block. Please see below for icmp
Type: Object
Reference Object: /axapi/v3/cgnv6/icmp
l4
Description: l4 is a JSON Block. Please see below for l4
Type: Object
Reference Object: /axapi/v3/cgnv6/l4
logging
Description: logging is a JSON Block. Please see below for logging
Type: Object
Reference Object: /axapi/v3/cgnv6/logging
lsn
Description: lsn is a JSON Block. Please see below for lsn
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn
lsn-lid-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-lid/{lid-number}
lsn-radius-profile-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-radius-profile/{lid-profile-index}
lsn-rule-list-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}
lw-4o6
Description: lw-4o6 is a JSON Block. Please see below for lw-4o6
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6
map
Description: map is a JSON Block. Please see below for map
Type: Object
Reference Object: /axapi/v3/cgnv6/map
nat
Description: nat is a JSON Block. Please see below for nat
Type: Object
Reference Object: /axapi/v3/cgnv6/nat
nat46-stateless
Description: nat46-stateless is a JSON Block. Please see below for nat46-stateless
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless
nat64
Description: nat64 is a JSON Block. Please see below for nat64
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64
nptv6
Description: nptv6 is a JSON Block. Please see below for nptv6
Type: Object
Reference Object: /axapi/v3/cgnv6/nptv6
one-to-one
Description: one-to-one is a JSON Block. Please see below for one-to-one
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one
pcp
Description: pcp is a JSON Block. Please see below for pcp
Type: Object
Reference Object: /axapi/v3/cgnv6/pcp
port-batch-v1
Description: port-batch-v1 is a JSON Block. Please see below for port-batch-v1
Type: Object
Reference Object: /axapi/v3/cgnv6/port-batch-v1
port-list-list
Type: List
Reference Object: /axapi/v3/cgnv6/port-list/{name}
resource-usage
Description: resource-usage is a JSON Block. Please see below for resource-usage
Type: Object
Reference Object: /axapi/v3/cgnv6/resource-usage
scaleout
Description: scaleout is a JSON Block. Please see below for scaleout
Type: Object
Reference Object: /axapi/v3/cgnv6/scaleout
sctp
Description: sctp is a JSON Block. Please see below for sctp
Type: Object
Reference Object: /axapi/v3/cgnv6/sctp
server-list
Type: List
Reference Object: /axapi/v3/cgnv6/server/{name}
service-group-list
Type: List
Reference Object: /axapi/v3/cgnv6/service-group/{name}
shared-service-group
Description: shared-service-group is a JSON Block. Please see below for shared-service-group
Type: Object
Reference Object: /axapi/v3/cgnv6/shared-service-group
sixrd
Description: sixrd is a JSON Block. Please see below for sixrd
Type: Object
Reference Object: /axapi/v3/cgnv6/sixrd
stateful-firewall
Description: stateful-firewall is a JSON Block. Please see below for stateful-firewall
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall
template
Description: template is a JSON Block. Please see below for template
Type: Object
Reference Object: /axapi/v3/cgnv6/template
translation
Description: translation is a JSON Block. Please see below for translation
Type: Object
Reference Object: /axapi/v3/cgnv6/translation
scaleout¶
Specification
Value
Type
object
address-mapping
Description: address-mapping is a JSON Block. Please see below for scaleout_address-mapping
Type: Object
Reference Object: /axapi/v3/cgnv6/scaleout/address-mapping
nat-ip-hashing-scheme
Description: nat-ip-hashing-scheme is a JSON Block. Please see below for scaleout_nat-ip-hashing-scheme
Type: Object
Reference Object: /axapi/v3/cgnv6/scaleout/nat-ip-hashing-scheme
scaleout_nat-ip-hashing-scheme¶
Specification
Value
Type
object
hashing-type
Description ‘route-aggregation’: Chunk contiguous NAT IPs for route aggregation(default); ‘mod-user-groups’: Hash NAT IPs by taking mod of user-groups;
Type: string
Supported Values: route-aggregation, mod-user-groups
Default: route-aggregation
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
scaleout_address-mapping¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port-batch-v1¶
Specification
Value
Type
object
enable-port-batch-v1
Description Enable lsn port-batching v1 (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
global¶
Specification
Value
Type
object
ping-sweep-detection
Description ‘enable’: Enable ping sweep detection; ‘disable’: Disable ping sweep detection(default);
Type: string
Supported Values: enable, disable
Default: disable
port-scan-detection
Description ‘enable’: Enable port scan detection; ‘disable’: Disable port scan detection(default);
Type: string
Supported Values: enable, disable
Default: disable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘tcp-total-ports-allocated’: Total TCP ports allocated; ‘udp-total-ports-allocated’: Total UDP ports allocated; ‘icmp-total-ports-allocated’: Total ICMP ports allocated;
Type: string
Supported Values: all, tcp-total-ports-allocated, udp-total-ports-allocated, icmp-total-ports-allocated
server-list¶
Specification
Value
Type
list
Block object keys
action
Description ‘enable’: Enable this Real Server; ‘disable’: Disable this Real Server;
Type: string
Supported Values: enable, disable
Default: enable
fqdn-name
Description Server hostname
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
health-check
Description Health Check Monitor (Health monitor name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
host
Description IP Address
Type: string
Format: ipv4-address
name
Description Server Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
port-list
Type: List
Reference Object: /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol}
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN; ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
sampling-enable
Type: List
server-ipv6-addr
Description IPV6 address
Type: string
Format: ipv6-address
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
server-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘curr-conn’: Current connections; ‘total-conn’: Total connections; ‘fwd-pkt’: Forward packets; ‘rev-pkt’: Reverse Packets; ‘peak-conn’: Peak connections;
Type: string
Supported Values: all, curr-conn, total-conn, fwd-pkt, rev-pkt, peak-conn
server-list_port-list¶
Specification
Value
Type
list
Block object keys
action
Description ‘enable’: enable; ‘disable’: disable;
Type: string
Supported Values: enable, disable
Default: enable
follow-port-protocol
Description ‘tcp’: TCP Port; ‘udp’: UDP Port;
Type: string
Supported Values: tcp, udp
health-check
Description Health Check (Monitor Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check, health-check-follow-port, and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
health-check-disable
Description Disable health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
health-check-follow-port
Description Specify which port to follow for health status (Port Number)
Type: number
Range: 1-65534
Mutual Exclusion: health-check-follow-port and health-check are mutually exclusive
port-number
Description Port Number
Type: number
Range: 0-65534
protocol
Description ‘tcp’: TCP Port; ‘udp’: UDP Port;
Type: string
Supported Values: tcp, udp
sampling-enable
Type: List
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
server-list_port-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘curr_conn’: Current connections; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total request success; ‘total_fwd_bytes’: Forward bytes; ‘total_fwd_pkts’: Forward packets; ‘total_rev_bytes’: Reverse bytes; ‘total_rev_pkts’: Reverse packets; ‘total_conn’: Total connections; ‘last_total_conn’: Last total connections; ‘peak_conn’: Peak connections; ‘es_resp_200’: Response status 200; ‘es_resp_300’: Response status 300; ‘es_resp_400’: Response status 400; ‘es_resp_500’: Response status 500; ‘es_resp_other’: Response status other; ‘es_req_count’: Total proxy request; ‘es_resp_count’: Total proxy Response; ‘es_resp_invalid_http’: Total non-http response; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_good_status_code’: Total reverse packets with good status code inspected; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time;
Type: string
Supported Values: all, curr_conn, curr_req, total_req, total_req_succ, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, last_total_conn, peak_conn, es_resp_200, es_resp_300, es_resp_400, es_resp_500, es_resp_other, es_req_count, es_resp_count, es_resp_invalid_http, total_rev_pkts_inspected, total_rev_pkts_inspected_good_status_code, response_time, fastest_rsp_time, slowest_rsp_time
service-group-list¶
Specification
Value
Type
list
Block object keys
health-check
Description Health Check (Monitor Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/health/monitor
member-list
Type: List
Reference Object: /axapi/v3/cgnv6/service-group/{name}/member/{name}+{port}
name
Description CGNV6 Service Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/cgnv6-serv-group-tmpl
protocol
Description ‘tcp’: TCP LB service; ‘udp’: UDP LB service;
Type: string
Supported Values: tcp, udp
sampling-enable
Type: List
shared
Description Share with partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
shared-group
Description Share with a partition group (Partition Group Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: shared-group and shared-partition are mutually exclusive
shared-partition
Description Share with a single partition (Partition Name)
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Mutual Exclusion: shared-partition and shared-group are mutually exclusive
traffic-replication-mirror-ip-repl
Description Replaces IP with server-IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
service-group-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘server_selection_fail_drop’: Service selection fail drop; ‘server_selection_fail_reset’: Service selection fail reset; ‘service_peak_conn’: Service peak connection;
Type: string
Supported Values: all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn
service-group-list_member-list¶
Specification
Value
Type
list
Block object keys
name
Description Member name
Type: string
Format: comp-string
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/server
port
Description Port number
Type: number
Range: 0-65534
Default: 65534
sampling-enable
Type: List
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
service-group-list_member-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘curr_conn’: Current connections; ‘total_fwd_bytes’: Total forward bytes; ‘total_fwd_pkts’: Total forward packets; ‘total_rev_bytes’: Total reverse bytes; ‘total_rev_pkts’: Total reverse packets; ‘total_conn’: Total connections; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_status_code_2xx’: Total reverse packets inspected status code 2xx; ‘total_rev_pkts_inspected_status_code_non_5xx’: Total reverse packets inspected status code non 5xx; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total requests success; ‘peak_conn’: Peak connections; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections; ‘curr_conn_overflow’: Current connection counter overflow count; ‘state_flaps’: State flaps count;
Type: string
Supported Values: all, curr_conn, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow, state_flaps
template¶
Specification
Value
Type
object
dns-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/dns/{name}
http-alg-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/http-alg/{name}
logging-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/logging/{name}
pcp-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/pcp/{name}
policy-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/policy/{name}
template_dns-list¶
Specification
Value
Type
list
Block object keys
class-list
Description: class-list is a JSON Block. Please see below for template_dns-list_class-list
Type: Object
Reference Object: /axapi/v3/cgnv6/template/dns/{name}/class-list
default-policy
Description ‘nocache’: Cache disable; ‘cache’: Cache enable;
Type: string
Supported Values: nocache, cache
Default: nocache
disable-dns-template
Description Disable DNS template
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns64
Description: dns64 is a JSON Block. Please see below for template_dns-list_dns64
Type: Object
Reference Object: /axapi/v3/cgnv6/template/dns/{name}/dns64
drop
Description Drop the malformed query
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: drop and forward are mutually exclusive
forward
Description Forward to service group (Service group name)
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: forward and drop are mutually exclusive
max-cache-size
Description Define maximum cache size (Maximum cache entry per VIP)
Type: number
name
Description DNS Template Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
period
Description Period in minutes
Type: number
Range: 1-10000
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
template_dns-list_class-list¶
Specification
Value
Type
object
lid-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/dns/{name}/class-list/lid/{lidnum}
name
Description Specify a class list 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
template_dns-list_class-list_lid-list¶
Specification
Value
Type
list
Block object keys
action-value
Description ‘dns-cache-disable’: Disable DNS cache when it exceeds limit; ‘dns-cache-enable’: Enable DNS cache when it exceeds limit; ‘forward’: Forward the traffic even it exceeds limit;
Type: string
Supported Values: dns-cache-disable, dns-cache-enable, forward
conn-rate-limit
Description Connection rate limit
Type: number
Range: 1-2147483647
dns
Description: dns is a JSON Block. Please see below for template_dns-list_class-list_lid-list_dns
Type: Object
lidnum
Description Specify a limit ID
Type: number
Range: 1-31
lockout
Description Don’t accept any new connection for certain time (Lockout duration in minutes)
Type: number
Range: 1-1023
log
Description Log a message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log-interval
Description Log interval (minute, by default system will log every over limit instance)
Type: number
Range: 1-255
over-limit-action
Description Action when exceeds limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
per
Description Per (Number of 100ms)
Type: number
Range: 1-65535
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
template_dns-list_class-list_lid-list_dns¶
Specification
Value
Type
object
cache-action
Description ‘cache-disable’: Disable dns cache; ‘cache-enable’: Enable dns cache;
Type: string
Supported Values: cache-disable, cache-enable
Default: cache-disable
ttl
Description TTL for cache entry (TTL in seconds)
Type: number
Range: 1-65535
weight
Description Weight for cache entry
Type: number
Range: 1-7
template_dns-list_dns64¶
Specification
Value
Type
object
answer-only-disable
Description Disable Only translate the Answer Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auth-data
Description Set AA flag in DNS Response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cache
Description Use a cached A-query response to provide AAAA query responses for the same hostname
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
change-query
Description Always change incoming AAAA DNS Query to A
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
compress-disable
Description Disable Always try DNS Compression
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
deep-check-qr
Description Check DNS Question Record
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
deep-check-rr-disable
Description Disable Check DNS Response Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-cname-disable
Description Disable Drop DNS CNAME Response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
edns-append
Description Append EDNS Record when send A Query to server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable DNS64 (Need to config this option before config any other dns64 options)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fast-append
Description Append translated Records when original Response only has Answer Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ignore-rcode3-disable
Description Disable Ignore DNS error Response with rcode 3
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-qr-length
Description Max Question Record Length, default is 128
Type: number
Range: 1-1023
Default: 128
parallel-query
Description Forward AAAA Query & generate A Query in parallel
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
passive-query-disable
Description Disable Generate A query upon empty or error Response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
retry
Description Retry count, default is 3 (Retry Number)
Type: number
Range: 0-15
Default: 3
single-response-disable
Description Disable Single Response which is used to avoid ambiguity
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timeout
Description Timeout to send additional Queries, unit: second, default is 1
Type: number
Range: 0-15
Default: 1
trans-ptr
Description Translate DNS PTR Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trans-ptr-query
Description Translate DNS PTR Query
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ttl
Description Specify Max TTL in DNS Response, unit: second
Type: number
Range: 1-1000000000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template_policy-list¶
Specification
Value
Type
list
Block object keys
class-list
Description: class-list is a JSON Block. Please see below for template_policy-list_class-list
Type: Object
Reference Object: /axapi/v3/cgnv6/template/policy/{name}/class-list
name
Description Policy template 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
template_policy-list_class-list¶
Specification
Value
Type
object
client-ip-l3-dest
Description Use destination IP as client IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: client-ip-l3-dest and client-ip-l7-header are mutually exclusive
client-ip-l7-header
Description Use extract client IP address from L7 header
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: client-ip-l7-header and client-ip-l3-dest are mutually exclusive
header-name
Description Specify L7 header name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
lid-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/policy/{name}/class-list/lid/{lidnum}
name
Description Class list 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
template_policy-list_class-list_lid-list¶
Specification
Value
Type
list
Block object keys
action-value
Description ‘forward’: Forward the traffic even it exceeds limit; ‘reset’: Reset the connection when it exceeds limit;
Type: string
Supported Values: forward, reset
conn-limit
Description Connection limit
Type: number
Range: 0-1048575
conn-per
Description Per (Specify interval in number of 100ms)
Type: number
Range: 1-65535
conn-rate-limit
Description Specify connection rate limit
Type: number
Range: 1-2147483647
dns64
Description: dns64 is a JSON Block. Please see below for template_policy-list_class-list_lid-list_dns64
Type: Object
interval
Description Specify log interval in minutes, by default system will log every over limit instance
Type: number
Range: 1-255
lidnum
Description Specify a limit ID
Type: number
Range: 1-31
lockout
Description Don’t accept any new connection for certain time (Lockout duration in minutes)
Type: number
Range: 1-1023
log
Description Log a message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
over-limit-action
Description Set action when exceeds limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
request-limit
Description Request limit (Specify request limit)
Type: number
Range: 0-1048575
request-per
Description Per (Specify interval in number of 100ms)
Type: number
Range: 1-65535
request-rate-limit
Description Request rate limit (Specify request rate limit)
Type: number
Range: 1-4294967295
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
template_policy-list_class-list_lid-list_dns64¶
Specification
Value
Type
object
disable
Description Disable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
exclusive-answer
Description Exclusive Answer in DNS Response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
prefix
Description IPv6 prefix
Type: string
Format: ipv6-address-plen
template_logging-list¶
Specification
Value
Type
list
Block object keys
batched-logging-disable
Description Disable multiple logs per packet
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom
Description: custom is a JSON Block. Please see below for template_logging-list_custom
Type: Object
disable-log-by-destination
Description: disable-log-by-destination is a JSON Block. Please see below for template_logging-list_disable-log-by-destination
Type: Object
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination
facility
Description ‘kernel’: 0: Kernel; ‘user’: 1: User-level; ‘mail’: 2: Mail; ‘daemon’: 3: System daemons; ‘security-authorization’: 4: Security/authorization; ‘syslog’: 5: Syslog internal; ‘line-printer’: 6: Line printer; ‘news’: 7: Network news; ‘uucp’: 8: UUCP subsystem; ‘cron’: 9: Time-related; ‘security-authorization-private’: 10: Private security/authorization; ‘ftp’: 11: FTP; ‘ntp’: 12: NTP; ‘audit’: 13: Audit; ‘alert’: 14: Alert; ‘clock’: 15: Clock-related; ‘local0’: 16: Local use 0; ‘local1’: 17: Local use 1; ‘local2’: 18: Local use 2; ‘local3’: 19: Local use 3; ‘local4’: 20: Local use 4; ‘local5’: 21: Local use 5; ‘local6’: 22: Local use 6; ‘local7’: 23: Local use 7;
Type: string
Supported Values: kernel, user, mail, daemon, security-authorization, syslog, line-printer, news, uucp, cron, security-authorization-private, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7
Default: local0
format
Description ‘binary’: Binary logging format; ‘compact’: Compact ASCII logging format (Hex format with compact representation); ‘custom’: Arbitrary custom logging format; ‘default’: Default A10 logging format (ASCII); ‘rfc5424’: RFC5424 compliant logging format; ‘cef’: Common Event Format for logging;
Type: string
Supported Values: binary, compact, custom, default, rfc5424, cef
Default: default
include-destination
Description Include the destination IP and port in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-http
Description: include-http is a JSON Block. Please see below for template_logging-list_include-http
Type: Object
include-inside-user-mac
Description Include the inside user MAC address in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-partition-name
Description Include partition name in logging events
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-port-block-account
Description include bytes accounting information in port-batch-v2 port-mapping and fixed-nat user-ports messages
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-radius-attribute
Description: include-radius-attribute is a JSON Block. Please see below for template_logging-list_include-radius-attribute
Type: Object
include-session-byte-count
Description include byte count in session deletion logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-year
Description including the 4-digit year in CEF, compact and default logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log
Description: log is a JSON Block. Please see below for template_logging-list_log
Type: Object
log-receiver
Description: log-receiver is a JSON Block. Please see below for template_logging-list_log-receiver
Type: Object
name
Description Logging template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
resolution
Description ‘seconds’: Logging timestamp resolution in seconds (default); ‘10-milliseconds’: Logging timestamp resolution in 10s of milli-seconds;
Type: string
Supported Values: seconds, 10-milliseconds
Default: seconds
rfc-custom
Description: rfc-custom is a JSON Block. Please see below for template_logging-list_rfc-custom
Type: Object
rule
Description: rule is a JSON Block. Please see below for template_logging-list_rule
Type: Object
service-group
Description Set NAT logging service-group
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
severity
Description: severity is a JSON Block. Please see below for template_logging-list_severity
Type: Object
shared
Description Service group is in shared patition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
source-address
Description: source-address is a JSON Block. Please see below for template_logging-list_source-address
Type: Object
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/source-address
source-port
Description: source-port is a JSON Block. Please see below for template_logging-list_source-port
Type: Object
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
template_logging-list_log¶
Specification
Value
Type
object
fixed-nat
Description: fixed-nat is a JSON Block. Please see below for template_logging-list_log_fixed-nat
Type: Object
http-requests
Description ‘host’: Log the HTTP Host Header; ‘url’: Log the HTTP Request URL;
Type: string
Supported Values: host, url
map-dhcpv6
Description: map-dhcpv6 is a JSON Block. Please see below for template_logging-list_log_map-dhcpv6
Type: Object
merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
one-to-one-nat
Description: one-to-one-nat is a JSON Block. Please see below for template_logging-list_log_one-to-one-nat
Type: Object
port-mappings
Description ‘creation’: Log only creation of NAT mappings; ‘disable’: Disable Log creation and deletion of NAT mappings; ‘both’: Log creation and deletion of NAT mappings;
Type: string
Supported Values: creation, disable, both
Default: both
port-overloading
Description Force logging of all port-overloading sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sessions
Description Log all data sessions created using NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-data
Description Log LSN Subscriber Information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_log_fixed-nat¶
Specification
Value
Type
object
fixed-nat-http-requests
Description ‘host’: Log the HTTP Host Header; ‘url’: Log the HTTP Request URL;
Type: string
Supported Values: host, url
fixed-nat-merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fixed-nat-port-mappings
Description ‘both’: Log creation and deletion of NAT mappings; ‘creation’: Log creation of NAT mappings;
Type: string
Supported Values: both, creation
fixed-nat-sessions
Description Log all Fixed NAT sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-ports
Description: user-ports is a JSON Block. Please see below for template_logging-list_log_fixed-nat_user-ports
Type: Object
template_logging-list_log_fixed-nat_user-ports¶
Specification
Value
Type
object
days
Description Specify period in days
Type: number
Range: 1-30
start-time
Description Time when periodic logging starts (Specify start time(hh:mm))
Type: string
Format: time-hhmm
user-ports
Description Log Fixed NAT User Ports Configured
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_log_one-to-one-nat¶
Specification
Value
Type
object
one-to-one-merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
one-to-one-nat-sessions
Description Log all One-to-One NAT sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_log_map-dhcpv6¶
Specification
Value
Type
object
map-dhcpv6-msg-type
Type: List
map-dhcpv6-prefix-all
Description Log MAP DHCPv6 prefix assignment/renewal/release
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: map-dhcpv6-prefix-all and map-dhcpv6-msg-type are mutually exclusive
template_logging-list_log_map-dhcpv6_map-dhcpv6-msg-type¶
Specification
Value
Type
list
Block object keys
map-dhcpv6-msg-type
Description ‘prefix-assignment’: Log MAP DHCPv6 prefix assignment; ‘prefix-renewal’: Log MAP DHCPv6 prefix renewal; ‘prefix-release’: Log MAP DHCPv6 prefix release;
Type: string
Supported Values: prefix-assignment, prefix-renewal, prefix-release
Mutual Exclusion: map-dhcpv6-msg-type and map-dhcpv6-prefix-all are mutually exclusive
template_logging-list_include-radius-attribute¶
Specification
Value
Type
object
attr-cfg
Type: List
framed-ipv6-prefix
Description Include radius attributes for the prefix
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
insert-if-not-existing
Description Configure what string is to be inserted for custom RADIUS attributes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
no-quote
Description No quotation marks for RADIUS attributes in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
prefix-length
Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;
Type: string
Supported Values: 32, 48, 64, 80, 96, 112
zero-in-custom-attr
Description Insert 0000 for standard and custom attributes in log string
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_include-radius-attribute_attr-cfg¶
Specification
Value
Type
list
Block object keys
attr
Description ‘imei’: Include IMEI; ‘imsi’: Include IMSI; ‘msisdn’: Include MSISDN; ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3; ‘custom4’: Customized attribute 4; ‘custom5’: Customized attribute 5; ‘custom6’: Customized attribute 6;
Type: string
Supported Values: imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6
attr-event
Description ‘http-requests’: Include in HTTP request logs; ‘port-mappings’: Include in port-mapping logs; ‘sessions’: Include in session logs; ‘user-data’: Include in user-data logs;
Type: string
Supported Values: http-requests, port-mappings, sessions, user-data
template_logging-list_include-http¶
Specification
Value
Type
object
file-extension
Description HTTP file extension
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
header-cfg
Type: List
l4-session-info
Description Log the L4 session information of the HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
method
Description Log the HTTP Request Method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
request-number
Description HTTP Request Number
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_include-http_header-cfg¶
Specification
Value
Type
list
Block object keys
custom-header-name
Description Header name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
custom-max-length
Description Max length for a HTTP request log (Max header length (Default: 100 char))
Type: number
Range: 100-1000
Default: 100
http-header
Description ‘cookie’: Log HTTP Cookie Header; ‘referer’: Log HTTP Referer Header; ‘user-agent’: Log HTTP User-Agent Header; ‘header1’: Log HTTP Header 1; ‘header2’: Log HTTP Header 2; ‘header3’: Log HTTP Header 3;
Type: string
Supported Values: cookie, referer, user-agent, header1, header2, header3
max-length
Description Max length for a HTTP request log (Max header length (Default: 100 char))
Type: number
Range: 100-1000
Default: 100
template_logging-list_rule¶
Specification
Value
Type
object
interim-update-interval
Description Log interim update of NAT mappings (Interim update interval in minutes(Interval is floored to a multiple of 5))
Type: number
Range: 15-120
rule-http-requests
Description: rule-http-requests is a JSON Block. Please see below for template_logging-list_rule_rule-http-requests
Type: Object
template_logging-list_rule_rule-http-requests¶
Specification
Value
Type
object
dest-port
Type: List
disable-sequence-check
Description Disable http packet sequence check and don’t drop out of order packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-all-headers
Description Include all configured headers despite of absence in HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log-every-http-request
Description Log every HTTP request in an HTTP 1.1 session (Default: Log the first HTTP request in a session)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-url-len
Description Max length of URL log (Max URL length (Default: 128 char))
Type: number
Range: 100-1000
Default: 128
template_logging-list_rule_rule-http-requests_dest-port¶
Specification
Value
Type
list
Block object keys
dest-port-number
Description
Type: number
Range: 1-65535
include-byte-count
Description Include the byte count of HTTP Request/Response in CGN session deletion logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_severity¶
Specification
Value
Type
object
severity-string
Description ‘emergency’: 0: Emergency; ‘alert’: 1: Alert; ‘critical’: 2: Critical; ‘error’: 3: Error; ‘warning’: 4: Warning; ‘notice’: 5: Notice; ‘informational’: 6: Informational; ‘debug’: 7: Debug;
Type: string
Supported Values: emergency, alert, critical, error, warning, notice, informational, debug
Default: debug
Mutual Exclusion: severity-string and severity-val are mutually exclusive
severity-val
Description Logging severity level
Type: number
Range: 0-7
Default: 7
Mutual Exclusion: severity-val and severity-string are mutually exclusive
template_logging-list_log-receiver¶
Specification
Value
Type
object
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
radius
Description Use RADIUS server for NAT logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-string
Description The RADIUS server’s secret
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
template_logging-list_source-port¶
Specification
Value
Type
object
any
Description Use any source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: any and source-port-num are mutually exclusive
source-port-num
Description Set source port for sending NAT syslogs (default: 514)
Type: number
Range: 1-65535
Default: 514
Mutual Exclusion: source-port-num and any are mutually exclusive
template_logging-list_rfc-custom¶
Specification
Value
Type
object
header
Description: header is a JSON Block. Please see below for template_logging-list_rfc-custom_header
Type: Object
message
Description: message is a JSON Block. Please see below for template_logging-list_rfc-custom_message
Type: Object
template_logging-list_rfc-custom_header¶
Specification
Value
Type
object
use-alternate-timestamp
Description Use alternate non-RFC5424 compliant timestamp. Ex: 1990 Jan 15 12:30:30
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template_logging-list_rfc-custom_message¶
Specification
Value
Type
object
dhcpv6-map-prefix-assigned
Description MAP DHCPv6 prefix assigned
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
dhcpv6-map-prefix-released
Description MAP DHCPv6 prefix released
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
dhcpv6-map-prefix-renewed
Description MAP DHCPv6 prefix renewed
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
http-request-got
Description HTTP request got (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
ipv6-tech
Type: List
session-created
Description Session created (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
session-deleted
Description Session deleted (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
template_logging-list_rfc-custom_message_ipv6-tech¶
Specification
Value
Type
list
Block object keys
fixed-nat-allocated
Description Fixed-NAT allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
fixed-nat-freed
Description Fixed-NAT freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-allocated
Description Port allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-allocated
Description Port Batch allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-freed
Description Port Batch freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-v2-allocated
Description Port Batch v2 allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-v2-freed
Description Port Batch v2 freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-freed
Description Port freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
tech-type
Description ‘lsn’: LSN; ‘nat64’: NAT64; ‘ds-lite’: DS-Lite; ‘sixrd-nat64’: 6rd-NAT64;
Type: string
Supported Values: lsn, nat64, ds-lite, sixrd-nat64
template_logging-list_custom¶
Specification
Value
Type
object
custom-header
Description ‘use-syslog-header’: Use syslog header as custom log header;
Type: string
Supported Values: use-syslog-header
custom-message
Description: custom-message is a JSON Block. Please see below for template_logging-list_custom_custom-message
Type: Object
custom-time-stamp-format
Description Customize the time stamp format (Customize the time-stamp format. Default:%Y%m%d%H%M%S)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
template_logging-list_custom_custom-message¶
Specification
Value
Type
object
custom-dhcpv6-map-prefix-assigned
Description MAP DHCPv6 prefix assigned
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-dhcpv6-map-prefix-released
Description MAP DHCPv6 prefix released
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-dhcpv6-map-prefix-renewed
Description MAP DHCPv6 prefix renewed
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-allocated
Description Fixed-NAT allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-freed
Description Fixed-NAT freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-interim-update
Description Fixed-NAT interim update (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-http-request-got
Description HTTP request got (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-allocated
Description Port allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-allocated
Description Port Batch allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-freed
Description Port Batch freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-allocated
Description Port Batch v2 allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-freed
Description Port Batch v2 freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-interim-update
Description Port Batch v2 interim update (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-freed
Description Port freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-session-created
Description Session created (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-session-deleted
Description Session deleted (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
template_logging-list_source-address¶
Specification
Value
Type
object
ip
Description Specify source IP address
Type: string
Format: ipv4-address
ipv6
Description Specify source IPv6 address
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template_logging-list_disable-log-by-destination¶
Specification
Value
Type
object
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip/{ipv4-addr}
ip6-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip6/{ipv6-addr}
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template_logging-list_disable-log-by-destination_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_logging-list_disable-log-by-destination_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_logging-list_disable-log-by-destination_ip-list¶
Specification
Value
Type
list
Block object keys
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv4-addr
Description Configure an IP subnet
Type: string
Format: ipv4-cidr
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
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
template_logging-list_disable-log-by-destination_ip-list_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_logging-list_disable-log-by-destination_ip-list_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_logging-list_disable-log-by-destination_ip6-list¶
Specification
Value
Type
list
Block object keys
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-addr
Description Configure an IPv6 subnet
Type: string
Format: ipv6-address-plen
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
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
template_logging-list_disable-log-by-destination_ip6-list_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_logging-list_disable-log-by-destination_ip6-list_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
template_pcp-list¶
Specification
Value
Type
list
Block object keys
allow-third-party-from-lan
Description Allow third party request coming from LAN (default is disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
allow-third-party-from-wan
Description Allow third party request coming from WAN (default is disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
announce
Description PCP ANNOUNCE Opcode (default is enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
check-client-nonce
Description To validate NONCE value in PCP request (default: disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-map-filter
Description To disable processing of FILTER options in MAP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
map
Description PCP MAP Opcode (default is enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
maximum
Description To set maximum lifetime of PCP mappings (default 1440 minutes)
Type: number
Range: 2-1440
Default: 1440
minimum
Description To set minimum lifetime of PCP mappings (default 2 minutes)
Type: number
Range: 2-1440
Default: 2
name
Description PCP Template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
pcp-server-port
Description PCP server listening port (default 5351) (PCP UDP destination port)
Type: number
Range: 1024-65535
Default: 5351
peer
Description PCP PEER Opcode (default is enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
source-ip
Description Specify source IP address for IPv4 ANNOUNCE message
Type: string
Format: ipv4-address
source-ipv6
Description Specify source IPv6 address for IPv6 ANNOUNCE message
Type: string
Format: ipv6-address
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
template_http-alg-list¶
Specification
Value
Type
list
Block object keys
header-name-client-ip
Description Header name (default: X-Forwarded-For)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Default: X-Forwarded-For
header-name-msisdn
Description Header name (default: X-MSISDN)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Default: X-MSISDN
include-tunnel-ip
Description Include the tunnel IP (applies to DS-Lite and 6RD-NAT64 sessions)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
method
Description ‘append’: Append if there is already a header (default); ‘replace’: Replace if there is already a header;
Type: string
Supported Values: append, replace
Default: append
name
Description HTTP-ALG template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
request-insert-client-ip
Description Insert Client IP into HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
request-insert-msisdn
Description Insert MSISDN into HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
ddos-protection¶
Specification
Value
Type
object
disable-nat-ip-by-bgp
Description: disable-nat-ip-by-bgp is a JSON Block. Please see below for ddos-protection_disable-nat-ip-by-bgp
Type: Object
Reference Object: /axapi/v3/cgnv6/ddos-protection/disable-nat-ip-by-bgp
enable-action
Description ‘local’: Enable local logs only; ‘remote’: Enable logging to remote server & IPFIX; ‘both’: Enable both local & remote logs;
Type: string
Supported Values: local, remote, both
Default: local
ip-entries
Description: ip-entries is a JSON Block. Please see below for ddos-protection_ip-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/ddos-protection/ip-entries
l4-entries
Description: l4-entries is a JSON Block. Please see below for ddos-protection_l4-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/ddos-protection/l4-entries
logging-action
Description ‘enable’: enable CGN DDoS protection logging; ‘disable’: Disable both local & remote CGN DDoS protection logging;
Type: string
Supported Values: enable, disable
Default: enable
max-hw-entries
Description Configure maximum HW entries
Type: number
Range: 0-262144
Default: 262144
packets-per-second
Description: packets-per-second is a JSON Block. Please see below for ddos-protection_packets-per-second
Type: Object
sampling-enable
Type: List
syn-cookie
Description: syn-cookie is a JSON Block. Please see below for ddos-protection_syn-cookie
Type: Object
toggle
Description ‘enable’: Enable CGNV6 NAT pool DDoS protection (default); ‘disable’: Disable CGNV6 NAT pool DDoS protection;
Type: string
Supported Values: enable, disable
Default: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zone
Description Disable NAT IP based on DDoS zone name set in BGP
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ddos-protection_packets-per-second¶
Specification
Value
Type
object
action
Description: action is a JSON Block. Please see below for ddos-protection_packets-per-second_action
Type: Object
include-existing-session
Description Count traffic associated with existing session into the packets-per-second (Default: Disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip
Description Configure packets-per-second threshold per IP(default 3000000)
Type: number
Range: 0-30000000
Default: 3000000
other
Description Configure packets-per-second threshold for other L4 protocols(default 10000)
Type: number
Range: 0-30000000
Default: 10000
other-action
Description: other-action is a JSON Block. Please see below for ddos-protection_packets-per-second_other-action
Type: Object
tcp
Description Configure packets-per-second threshold per TCP port (default: 3000)
Type: number
Range: 0-30000000
Default: 3000
tcp-action
Description: tcp-action is a JSON Block. Please see below for ddos-protection_packets-per-second_tcp-action
Type: Object
udp
Description Configure packets-per-second threshold per UDP port (default: 3000)
Type: number
Range: 0-30000000
Default: 3000
udp-action
Description: udp-action is a JSON Block. Please see below for ddos-protection_packets-per-second_udp-action
Type: Object
ddos-protection_packets-per-second_action¶
Specification
Value
Type
object
action-type
Description ‘log’: Log the event only; ‘drop’: Log, and drop all packets (default); ‘redistribute-route’: Log, Drop, and Notify upstream router to reroute the packets;
Type: string
Supported Values: log, drop, redistribute-route
Default: drop
expiration
Description To specify time to revert the action after pps is decreased to below threshold (Expiration time, in minutes (default is 3600 seconds))
Type: number
Range: 10-8640000
Default: 3600
expiration-route
Description To specify time to revert the action after pps is decreased to below threshold (Expiration time, in seconds (default is 3600 seconds))
Type: number
Range: 10-8640000
Default: 3600
forward
Description Continue forward traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
remove-wait-timer
Description Time after which IP will be removed from blackhole
Type: number
Range: 0-300
Default: 300
route-map
Description Route map name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
timer-multiply-max
Description To specify max value of timer multiplier for attacks lasted long time (Max value of timer multiplier (default is 6))
Type: number
Range: 1-100
Default: 6
ddos-protection_packets-per-second_tcp-action¶
Specification
Value
Type
object
tcp-action-type
Description ‘log’: Log the event only; ‘drop’: Log, and drop all packets (default);
Type: string
Supported Values: log, drop
Default: drop
tcp-expiration
Description To specify time to revert the action after pps is decreased to below threshold (Expiration time, in seconds (default is 30 seconds))
Type: number
Range: 10-65535
Default: 30
ddos-protection_packets-per-second_udp-action¶
Specification
Value
Type
object
udp-action-type
Description ‘log’: Log the event only; ‘drop’: Log, and drop all packets (default);
Type: string
Supported Values: log, drop
Default: drop
udp-expiration
Description To specify time to revert the action after pps is decreased to below threshold (Expiration time, in seconds (default is 30 seconds))
Type: number
Range: 10-65535
Default: 30
ddos-protection_packets-per-second_other-action¶
Specification
Value
Type
object
other-action-type
Description ‘log’: Log the event only; ‘drop’: Log, and drop all packets (default);
Type: string
Supported Values: log, drop
Default: drop
other-expiration
Description To specify time to revert the action after pps is decreased to below threshold (Expiration time, in seconds (default is 30 seconds))
Type: number
Range: 10-65535
Default: 30
ddos-protection_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘l3_entry_added’: L3 Entry Added; ‘l3_entry_deleted’: L3 Entry Deleted; ‘l3_entry_added_to_bgp’: L3 Entry added to BGP; ‘l3_entry_removed_from_bgp’: Entry removed from BGP; ‘l3_entry_added_to_hw’: L3 Entry added to HW; ‘l3_entry_removed_from_hw’: L3 Entry removed from HW; ‘l3_entry_too_many’: L3 Too many entries; ‘l3_entry_match_drop’: L3 Entry match drop; ‘l3_entry_match_drop_hw’: L3 HW entry match drop; ‘l3_entry_drop_max_hw_exceeded’: L3 Entry Drop due to HW Limit Exceeded; ‘l4_entry_added’: L4 Entry added; ‘l4_entry_deleted’: L4 Entry deleted; ‘l4_entry_added_to_hw’: L4 Entry added to HW; ‘l4_entry_removed_from_hw’: L4 Entry removed from HW; ‘l4_hw_out_of_entries’: HW out of L4 entries; ‘l4_entry_match_drop’: L4 Entry match drop; ‘l4_entry_match_drop_hw’: L4 HW Entry match drop; ‘l4_entry_drop_max_hw_exceeded’: L4 Entry Drop due to HW Limit Exceeded; ‘l4_entry_list_alloc’: L4 Entry list alloc; ‘l4_entry_list_free’: L4 Entry list free; ‘l4_entry_list_alloc_failure’: L4 Entry list alloc failures; ‘ip_node_alloc’: Node alloc; ‘ip_node_free’: Node free; ‘ip_node_alloc_failure’: Node alloc failures; ‘ip_port_block_alloc’: Port block alloc; ‘ip_port_block_free’: Port block free; ‘ip_port_block_alloc_failure’: Port block alloc failure; ‘ip_other_block_alloc’: Other block alloc; ‘ip_other_block_free’: Other block free; ‘ip_other_block_alloc_failure’: Other block alloc failure; ‘entry_added_shadow’: Entry added shadow; ‘entry_invalidated’: Entry invalidated; ‘l3_entry_add_to_bgp_failure’: L3 Entry BGP add failures; ‘l3_entry_remove_from_bgp_failure’: L3 entry BGP remove failures; ‘l3_entry_add_to_hw_failure’: L3 entry HW add failure; ‘syn_cookie_syn_ack_sent’: SYN cookie SYN ACK sent; ‘syn_cookie_verification_passed’: SYN cookie verification passed; ‘syn_cookie_verification_failed’: SYN cookie verification failed; ‘syn_cookie_conn_setup_failed’: SYN cookie connection setup failed;
Type: string
Supported Values: all, l3_entry_added, l3_entry_deleted, l3_entry_added_to_bgp, l3_entry_removed_from_bgp, l3_entry_added_to_hw, l3_entry_removed_from_hw, l3_entry_too_many, l3_entry_match_drop, l3_entry_match_drop_hw, l3_entry_drop_max_hw_exceeded, l4_entry_added, l4_entry_deleted, l4_entry_added_to_hw, l4_entry_removed_from_hw, l4_hw_out_of_entries, l4_entry_match_drop, l4_entry_match_drop_hw, l4_entry_drop_max_hw_exceeded, l4_entry_list_alloc, l4_entry_list_free, l4_entry_list_alloc_failure, ip_node_alloc, ip_node_free, ip_node_alloc_failure, ip_port_block_alloc, ip_port_block_free, ip_port_block_alloc_failure, ip_other_block_alloc, ip_other_block_free, ip_other_block_alloc_failure, entry_added_shadow, entry_invalidated, l3_entry_add_to_bgp_failure, l3_entry_remove_from_bgp_failure, l3_entry_add_to_hw_failure, syn_cookie_syn_ack_sent, syn_cookie_verification_passed, syn_cookie_verification_failed, syn_cookie_conn_setup_failed
ddos-protection_l4-entries¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ddos-protection_ip-entries¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ddos-protection_disable-nat-ip-by-bgp¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
translation¶
Specification
Value
Type
object
icmp-timeout
Description: icmp-timeout is a JSON Block. Please see below for translation_icmp-timeout
Type: Object
service-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/translation/service-timeout/{service-type}+{port}
tcp-timeout
Description TCP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))
Type: number
Range: 2-15000
Default: 300
udp-timeout
Description UDP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))
Type: number
Range: 2-15000
Default: 300
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
translation_icmp-timeout¶
Specification
Value
Type
object
fast
Description Use Fast Aging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: fast and icmp-timeout-val are mutually exclusive
icmp-timeout-val
Description Timeout in seconds (Interval of 60 seconds)
Type: number
Range: 2-15000
Mutual Exclusion: icmp-timeout-val and fast are mutually exclusive
translation_service-timeout-list¶
Specification
Value
Type
list
Block object keys
fast
Description Use Fast Aging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: fast and timeout-val are mutually exclusive
port
Description Port Number
Type: number
Range: 1-65535
port-end
Description End Port Number
Type: number
Range: 1-65535
service-type
Description ‘tcp’: TCP Protocol; ‘udp’: UDP Protocol;
Type: string
Supported Values: tcp, udp
timeout-val
Description Timeout in seconds (Interval of 60 seconds)
Type: number
Range: 2-15000
Mutual Exclusion: timeout-val and fast are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn¶
Specification
Value
Type
object
alg
Description: alg is a JSON Block. Please see below for lsn_alg
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg
all-sessions
Description: all-sessions is a JSON Block. Please see below for lsn_all-sessions
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/all-sessions
data-sessions
Description: data-sessions is a JSON Block. Please see below for lsn_data-sessions
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/data-sessions
endpoint-independent-filtering
Description: endpoint-independent-filtering is a JSON Block. Please see below for lsn_endpoint-independent-filtering
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-filtering
endpoint-independent-mapping
Description: endpoint-independent-mapping is a JSON Block. Please see below for lsn_endpoint-independent-mapping
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-mapping
enhanced-user-tracking
Description: enhanced-user-tracking is a JSON Block. Please see below for lsn_enhanced-user-tracking
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/enhanced-user-tracking
full-cone-session
Description: full-cone-session is a JSON Block. Please see below for lsn_full-cone-session
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/full-cone-session
global
Description: global is a JSON Block. Please see below for lsn_global
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/global
health-check-gateway-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}
inside
Description: inside is a JSON Block. Please see below for lsn_inside
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/inside
per-instance
Description: per-instance is a JSON Block. Please see below for lsn_per-instance
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/per-instance
performance
Description: performance is a JSON Block. Please see below for lsn_performance
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/performance
port-overloading
Description: port-overloading is a JSON Block. Please see below for lsn_port-overloading
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-overloading
port-reservation-entries
Description: port-reservation-entries is a JSON Block. Please see below for lsn_port-reservation-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-reservation-entries
port-reservation-list
radius
Description: radius is a JSON Block. Please see below for lsn_radius
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/radius
stun-timeout
Description: stun-timeout is a JSON Block. Please see below for lsn_stun-timeout
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/stun-timeout
system-status
Description: system-status is a JSON Block. Please see below for lsn_system-status
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/system-status
tcp
Description: tcp is a JSON Block. Please see below for lsn_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/tcp
user-quota-session
Description: user-quota-session is a JSON Block. Please see below for lsn_user-quota-session
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/user-quota-session
lsn_system-status¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_performance¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_performance_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘data-sessions-current-epoch’: some help string; ‘fullcone-created-current-epoch’: some help string; ‘user-quote-created-current-epoch’: some help string; ‘data-sessions-previous-epoch-first’: some help string; ‘fullcone-created-previous-epoch-first’: some help string; ‘user-quote-created-previous-epoch-first’: some help string; ‘data-sessions-previous-epoch-last’: some help string; ‘fullcone-created-previous-epoch-last’: some help string; ‘user-quote-created-previous-epoch-last’: some help string;
Type: string
Supported Values: all, data-sessions-current-epoch, fullcone-created-current-epoch, user-quote-created-current-epoch, data-sessions-previous-epoch-first, fullcone-created-previous-epoch-first, user-quote-created-previous-epoch-first, data-sessions-previous-epoch-last, fullcone-created-previous-epoch-last, user-quote-created-previous-epoch-last
lsn_health-check-gateway-list¶
Specification
Value
Type
list
Block object keys
ipv4-addr
Description Specify IPv4 Gateway
Type: string
Format: ipv4-address
ipv6-addr
Description Specify IPv6 Gateway
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_global¶
Specification
Value
Type
object
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 lsn_global_icmp
Type: Object
inbound-refresh
Description ‘enable’: Enable NAT Inbound Refresh Behavior; ‘disable’: Disable NAT Inbound Refresh Behavior;
Type: string
Supported Values: enable, disable
Default: enable
inbound-refresh-full-cone
Description ‘enable’: Enable NAT full cone refresh for inbound flows; ‘disable’: Disable NAT full cone refresh for inbound flows;
Type: string
Supported Values: enable, disable
Default: enable
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 lsn_global_logging
Type: Object
port-batching
Description: port-batching is a JSON Block. Please see below for lsn_global_port-batching
Type: Object
sampling-enable
Type: List
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
lsn_global_icmp¶
Specification
Value
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
lsn_global_logging¶
Specification
Value
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
Reference 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
Reference 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
lsn_global_logging_pool¶
Specification
Value
Type
list
Block object keys
pool-name
Description NAT pool
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference 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
Reference Object: /axapi/v3/cgnv6/template/logging
lsn_global_port-batching¶
Specification
Value
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
lsn_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘total_tcp_allocated’: Total TCP Ports Allocated; ‘total_tcp_freed’: Total TCP Ports Freed; ‘total_udp_allocated’: Total UDP Ports Allocated; ‘total_udp_freed’: Total UDP Ports Freed; ‘total_icmp_allocated’: Total ICMP Ports Allocated; ‘total_icmp_freed’: Total ICMP Ports Freed; ‘data_session_created’: Data Session Created; ‘data_session_freed’: Data Session Freed; ‘user_quota_created’: User-Quota Created; ‘user_quota_put_in_del_q’: User-Quota Freed; ‘user_quota_failure’: User-Quota Creation Failed; ‘nat_port_unavailable_tcp’: TCP NAT Port Unavailable; ‘nat_port_unavailable_udp’: UDP NAT Port Unavailable; ‘nat_port_unavailable_icmp’: ICMP NAT Port Unavailable; ‘new_user_resource_unavailable’: New User NAT Resource Unavailable; ‘tcp_user_quota_exceeded’: TCP User-Quota Exceeded; ‘udp_user_quota_exceeded’: UDP User-Quota Exceeded; ‘icmp_user_quota_exceeded’: ICMP User-Quota Exceeded; ‘extended_quota_matched’: Extended User-Quota Matched; ‘extended_quota_exceeded’: Extended User-Quota Exceeded; ‘data_sesn_user_quota_exceeded’: Data Session User-Quota Exceeded; ‘data_sesn_rate_user_quota_exceeded’: Conn Rate User-Quota Exceeded; ‘tcp_fullcone_created’: TCP Full-cone Session Created; ‘tcp_fullcone_freed’: TCP Full-cone Session Freed; ‘udp_fullcone_created’: UDP Full-cone Session Created; ‘udp_fullcone_freed’: UDP Full-cone Session Freed; ‘fullcone_failure’: Full-cone Session Creation Failed; ‘hairpin’: Hairpin Session Created; ‘fullcone_self_hairpinning_drop’: Self-Hairpinning Drop; ‘endpoint_indep_map_match’: Endpoint-Independent Mapping Matched; ‘endpoint_indep_filter_match’: Endpoint-Independent Filtering Matched; ‘inbound_filtered’: Endpoint-Dependent Filtering Drop; ‘eif_limit_exceeded’: Endpoint-Independent Filtering Inbound Limit Exceeded; ‘total_tcp_overloaded’: TCP Port Overloaded; ‘total_udp_overloaded’: UDP Port Overloaded; ‘port_overloading_smp_inserted_tcp’: TCP Port Overloading Session Created; ‘port_overloading_smp_inserted_udp’: UDP Port Overloading Session Created; ‘port_overloading_smp_free_tcp’: TCP Port Overloading Session Freed; ‘port_overloading_smp_free_udp’: UDP Port Overloading Session Freed; ‘nat_pool_unusable’: NAT Pool Unusable; ‘ha_nat_pool_unusable’: HA NAT Pool Unusable; ‘ha_nat_pool_batch_type_mismatch’: HA NAT Pool Batch Type Mismatch; ‘no_radius_profile_match’: No RADIUS Profile Match; ‘nat_ip_max_tcp_ports_allocated’: NAT IP TCP Max Ports Allocated; ‘nat_ip_max_udp_ports_allocated’: NAT IP UDP Max Ports Allocated; ‘no_class_list_match’: No Class-List Match; ‘lid_drop’: LSN LID Drop; ‘lid_pass_through’: LSN LID Pass-through; ‘fullcone_in_del_q’: Full-cone session found in delete queue; ‘fullcone_retry_lookup’: Full-cone session retry look-up; ‘fullcone_not_found’: Full-cone session not found; ‘nat_port_double_free’: NAT Port Double Free; ‘nat_port_chunk_freed_from_cpu’: NAT Port Chunks Freed From CPU; ‘nat_port_freed_from_diff_cpu’: NAT Port Freed On Different CPU; ‘nat_pool_deleted’: NAT Pool Deleted; ‘nat_esp_ip_conflicts’: LSN NAT ESP IP Conflicts; ‘nat_esp_no_control_sesn’: LSN NAT ESP No Control Session; ‘esp_user_quota_exceeded’: ESP User-Quota exceeded; ‘udp_alg_user_quota_exceeded’: UDP ALG User-Quota exceeded; ‘gre_user_quota_exceeded’: GRE User-Quota exceeded; ‘ha_classlist_mismatch’: HA Class-list Mismatch; ‘ha_user_quota_mismatch’: HA User-Quota Mismatch; ‘ha_fullcone_mismatch’: HA Full-cone Mismatch; ‘ha_port_mismatch’: HA Port Mismatch; ‘ha_dnat_mismatch’: HA Destination NAT Config Mismatch; ‘ha_nat_port_unavailable’: HA NAT Port Unavailable; ‘ha_unknown_nat_ip’: HA Unknown NAT IP; ‘ha_fullcone_failure’: HA Full-cone Session Failure; ‘ha_fullcone_create_race_failure’: HA Full-cone Create Race Failure; ‘ha_endpoint_indep_map_match’: HA Endpoint-independent Matching; ‘standby_class_list_drop’: HA Standby Class-List drop; ‘bad_tuple_nat_ip’: Bad NAT IP from tuple; ‘bad_smp_tuple_nat_ip’: Bad NAT IP from SMP tuple; ‘fullcone_inbound_nat_pool_mismatch’: Full-cone Session NAT Pool Mismatch; ‘fullcone_overflow_eim’: Full-cone Session EIM Overflow; ‘fullcone_overflow_eif’: Full-cone Session EIF Overflow; ‘cross_cpu_helper_created’: Cross CPU Session Helper Created; ‘cross_cpu_sent’: Cross CPU Helper Packets Sent; ‘cross_cpu_rcv’: Cross CPU Helper Packets Received; ‘cross_cpu_bad_l3’: Cross CPU Unsupported L3; ‘cross_cpu_bad_l4’: Cross CPU Unsupported L4; ‘cross_cpu_no_session’: Cross CPU No Session Found; ‘cross_cpu_helper_free’: Cross CPU Helper Free; ‘cross_cpu_helper_free_retry_lookup’: Cross CPU Helper Free Retry Lookup; ‘cross_cpu_helper_free_not_found’: Cross CPU Helper Free Not Found; ‘cross_cpu_helper_deleted’: Cross CPU Helper Deleted; ‘cross_cpu_helper_cpu_mismatch’: Cross CPU Helper CPU Mismatch; ‘cross_cpu_helper_nat_pool_standby’: Cross CPU Helper NAT Pool Standby; ‘cross_cpu_helper_double_add’: Cross CPU Helper Double Add Attempt; ‘mtu_exceeded’: Packet Exceeded MTU; ‘frag’: Fragmented Packets; ‘dslite_tunnel_frag’: IPv4 Fragment DS-Lite Packet; ‘sixrd_tunnel_frag’: IPv6 Fragment IPv6-in-IPv4 Packet; ‘frag_icmp’: ICMP Packet Too Big Sent; ‘frag_tunnel_icmp’: DS-Lite ICMP Packet Too Big Sent; ‘quota_ext_mem_allocated’: Quota Extension Memory Allocated; ‘quota_ext_mem_alloc_failure’: Quota Extension Out of Memory; ‘quota_ext_mem_freed’: Quota Extension Memory Freed; ‘quota_ext_put_in_del_q’: Quota Extension Put in Delete Queue; ‘port_batch_num_mismatch’: Specific Port Batch Num Ports Mismatch; ‘port_batch_interval_mismatch’: Specific Port Batch Port Interval Mismatch; ‘port_pair_alloc_bad_math’: Port Pair Alloc Bad Math; ‘free_port_from_quota_no_container’: Free Port from Quota No Container; ‘free_port_from_quota_no_port_info’: Free Port From Quota No Port Info; ‘static_nat_cross_cpu_helper_created’: Cross CPU Helper Created for Static NAT; ‘static_nat_cross_cpu_helper_deleted’: Cross CPU Helper Deleted for Static NAT; ‘static_nat_cross_cpu_helper_standby’: Cross CPU Helper Static NAT Standby; ‘static_nat_cross_cpu_helper_cpu_mismatch’: Static NAT Cross CPU Helper CPU Mismatch; ‘static_nat_cross_cpu_sent’: Static NAT Cross CPU Helper Sent; ‘static_nat_cross_cpu_rcv’: Static NAT Cross CPU Helper Packets Received; ‘static_nat_cross_cpu_bad_l3’: Static NAT Cross CPU Unsupported L3; ‘static_nat_cross_cpu_bad_l4’: Static NAT Cross CPU Unsupported L4; ‘static_nat_cross_cpu_no_session’: Static NAT Cross CPU No Session Found; ‘static_nat_cross_cpu_helper_free’: Static NAT Cross CPU Helper Free; ‘static_nat_cross_cpu_helper_free_retry_lookup’: Static NAT Cross CPU Helper Free Retry Lookup; ‘static_nat_cross_cpu_helper_free_not_found’: Static NAT Cross CPU Helper Free Not Found; ‘static_nat_ha_map_mismatch’: Static NAT Mapping Mismatch on HA Standby; ‘ip_slb_cross_cpu_sent’: IP SLB Cross CPU Packets Sent; ‘fullcone_force_deleted’: Full-cone Session Force Deleted; ‘user_quota_mem_allocated’: User-Quota Memory Allocated; ‘user_quota_mem_freed’: User-Quota Memory Freed; ‘user_quota_created_shadow’: Total User-Quota Created; ‘quota_marked_deleted’: User-Quota Marked Deleted; ‘quota_delete_not_in_bucket’: User-Quota Delete Not In Bucket; ‘user_quota_put_in_del_q_shadow’: Total User-Quota Put In Del Q; ‘tcp_out_of_state_rst_sent’: Total Out of State TCP RST sent; ‘tcp_out_of_state_rst_dropped’: Total Out of State TCP RST dropped; ‘icmp_out_of_state_uqe_admin_filtered_sent’: Total User Quota Exceeded ICMP admin filtered sent; ‘icmp_out_of_state_uqe_host_unreachable_sent’: Total User Quota Exceeded ICMP host unreachable sent; ‘icmp_out_of_state_uqe_dropped’: Total User Queue Exceeded ICMP notification dropped;
Type: string
Supported Values: all, total_tcp_allocated, total_tcp_freed, total_udp_allocated, total_udp_freed, total_icmp_allocated, total_icmp_freed, data_session_created, data_session_freed, user_quota_created, user_quota_put_in_del_q, user_quota_failure, nat_port_unavailable_tcp, nat_port_unavailable_udp, nat_port_unavailable_icmp, new_user_resource_unavailable, tcp_user_quota_exceeded, udp_user_quota_exceeded, icmp_user_quota_exceeded, extended_quota_matched, extended_quota_exceeded, data_sesn_user_quota_exceeded, data_sesn_rate_user_quota_exceeded, tcp_fullcone_created, tcp_fullcone_freed, udp_fullcone_created, udp_fullcone_freed, fullcone_failure, hairpin, fullcone_self_hairpinning_drop, endpoint_indep_map_match, endpoint_indep_filter_match, inbound_filtered, eif_limit_exceeded, total_tcp_overloaded, total_udp_overloaded, port_overloading_smp_inserted_tcp, port_overloading_smp_inserted_udp, port_overloading_smp_free_tcp, port_overloading_smp_free_udp, nat_pool_unusable, ha_nat_pool_unusable, ha_nat_pool_batch_type_mismatch, no_radius_profile_match, nat_ip_max_tcp_ports_allocated, nat_ip_max_udp_ports_allocated, no_class_list_match, lid_drop, lid_pass_through, fullcone_in_del_q, fullcone_retry_lookup, fullcone_not_found, nat_port_double_free, nat_port_chunk_freed_from_cpu, nat_port_freed_from_diff_cpu, nat_pool_deleted, nat_esp_ip_conflicts, nat_esp_no_control_sesn, esp_user_quota_exceeded, udp_alg_user_quota_exceeded, gre_user_quota_exceeded, ha_classlist_mismatch, ha_user_quota_mismatch, ha_fullcone_mismatch, ha_port_mismatch, ha_dnat_mismatch, ha_nat_port_unavailable, ha_unknown_nat_ip, ha_fullcone_failure, ha_fullcone_create_race_failure, ha_endpoint_indep_map_match, standby_class_list_drop, bad_tuple_nat_ip, bad_smp_tuple_nat_ip, fullcone_inbound_nat_pool_mismatch, fullcone_overflow_eim, fullcone_overflow_eif, cross_cpu_helper_created, cross_cpu_sent, cross_cpu_rcv, cross_cpu_bad_l3, cross_cpu_bad_l4, cross_cpu_no_session, cross_cpu_helper_free, cross_cpu_helper_free_retry_lookup, cross_cpu_helper_free_not_found, cross_cpu_helper_deleted, cross_cpu_helper_cpu_mismatch, cross_cpu_helper_nat_pool_standby, cross_cpu_helper_double_add, mtu_exceeded, frag, dslite_tunnel_frag, sixrd_tunnel_frag, frag_icmp, frag_tunnel_icmp, quota_ext_mem_allocated, quota_ext_mem_alloc_failure, quota_ext_mem_freed, quota_ext_put_in_del_q, port_batch_num_mismatch, port_batch_interval_mismatch, port_pair_alloc_bad_math, free_port_from_quota_no_container, free_port_from_quota_no_port_info, static_nat_cross_cpu_helper_created, static_nat_cross_cpu_helper_deleted, static_nat_cross_cpu_helper_standby, static_nat_cross_cpu_helper_cpu_mismatch, static_nat_cross_cpu_sent, static_nat_cross_cpu_rcv, static_nat_cross_cpu_bad_l3, static_nat_cross_cpu_bad_l4, static_nat_cross_cpu_no_session, static_nat_cross_cpu_helper_free, static_nat_cross_cpu_helper_free_retry_lookup, static_nat_cross_cpu_helper_free_not_found, static_nat_ha_map_mismatch, ip_slb_cross_cpu_sent, fullcone_force_deleted, user_quota_mem_allocated, user_quota_mem_freed, user_quota_created_shadow, quota_marked_deleted, quota_delete_not_in_bucket, user_quota_put_in_del_q_shadow, tcp_out_of_state_rst_sent, tcp_out_of_state_rst_dropped, icmp_out_of_state_uqe_admin_filtered_sent, icmp_out_of_state_uqe_host_unreachable_sent, icmp_out_of_state_uqe_dropped
counters2
Description ‘user_quota_not_found’: User-Quota Not Found; ‘tcp_fullcone_created_shadow’: Total TCP Full-cone sessions created; ‘tcp_fullcone_freed_shadow’: Total TCP Full-cone sessions freed; ‘udp_fullcone_created_shadow’: Total UDP Full-cone sessions created; ‘udp_fullcone_freed_shadow’: Total UDP Full-cone sessions freed; ‘udp_alg_fullcone_created’: Total UDP ALG Full-cone sessions created; ‘udp_alg_fullcone_freed’: Total UDP ALG Full-cone sessions freed; ‘fullcone_created’: Total Full-cone sessions created; ‘fullcone_freed’: Total Full-cone sessions freed; ‘data_session_created_shadow’: Total Data Sessions Created; ‘data_session_freed_shadow’: Total Data Sessions Freed; ‘data_session_user_quota_mismatch’: Data Session Counter Per User Mismatch; ‘extended_quota_mismatched’: Extended User-Quota Mismatched; ‘nat_port_unavailable_other’: Other NAT Port Unavailable; ‘nat_port_unavailable’: Total NAT Port Unavailable; ‘new_user_resource_unavailable_tcp’: TCP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_udp’: UDP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_icmp’: ICMP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_other’: Other New User NAT Resource Unavailable; ‘total_tcp_allocated_shadow’: Total TCP Ports Allocated; ‘total_tcp_freed_shadow’: Total TCP Ports Freed; ‘total_udp_allocated_shadow’: Total UDP Ports Allocated; ‘total_udp_freed_shadow’: Total UDP Ports Freed; ‘total_icmp_allocated_shadow’: Total ICMP Ports Allocated; ‘total_icmp_freed_shadow’: Total ICMP Ports Freed; ‘udp_alg_no_quota’: UDP ALG User-Quota Not Found; ‘udp_alg_eim_mismatch’: UDP ALG Endpoint-Independent Mapping Mismatch; ‘udp_alg_no_nat_ip’: UDP ALG User-Quota Unknown NAT IP; ‘udp_alg_alloc_failure’: UDP ALG Port Allocation Failure; ‘sip_alg_no_quota’: SIP ALG User-Quota Not Found; ‘sip_alg_quota_inc_failure’: SIP ALG User-Quota Exceeded; ‘sip_alg_no_nat_ip’: SIP ALG Unknown NAT IP; ‘sip_alg_reuse_contact_fullcone’: SIP ALG Reuse Contact Full-cone Session; ‘sip_alg_contact_fullcone_mismatch’: SIP ALG Contact Full-cone Session Mismatch; ‘sip_alg_alloc_contact_port_failure’: SIP ALG Alloc Contact NAT Port Failure; ‘sip_alg_create_contact_fullcone_failure’: SIP ALG Create Contact Full-cone Session Failure; ‘sip_alg_release_contact_port_failure’: SIP ALG Release Contact NAT Port Failure; ‘sip_alg_single_rtp_fullcone’: SIP ALG Single RTP Full-cone Found; ‘sip_alg_single_rtcp_fullcone’: SIP ALG Single RTCP Full-cone Found; ‘sip_alg_rtcp_fullcone_mismatch’: SIP ALG RTCP Full-cone NAT Port Mismatch; ‘sip_alg_reuse_rtp_rtcp_fullcone’: SIP ALG Reuse RTP/RTCP Full-cone Session; ‘sip_alg_alloc_rtp_rtcp_port_failure’: SIP ALG Alloc RTP/RTCP NAT Ports Failure; ‘sip_alg_alloc_single_port_failure’: SIP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘sip_alg_create_single_fullcone_failure’: SIP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘sip_alg_create_rtp_fullcone_failure’: SIP ALG Create RTP Full-cone Session Failure; ‘sip_alg_create_rtcp_fullcone_failure’: SIP ALG Create RTCP Full-cone Session Failure; ‘sip_alg_port_pair_alloc_from_consecutive’: SIP ALG Port Pair Allocated From Consecutive; ‘sip_alg_port_pair_alloc_from_partition’: SIP ALG Port Pair Allocated From Partition; ‘sip_alg_port_pair_alloc_from_pool_port_batch’: SIP ALG Port Pair Allocated From Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_consecutive’: SIP ALG Port Pair Allocated From Quota Consecutive; ‘sip_alg_port_pair_alloc_from_quota_partition’: SIP ALG Port Pair Allocated From Quota Partition; ‘sip_alg_port_pair_alloc_from_quota_partition_error’: SIP ALG Port Pair Allocated From Quota Partition Error; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch’: SIP ALG Port Pair Allocated From Quota Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag’: SIP ALG Port Pair Allocated From Quota Port Batch Version 2 with Frag Free Ports; ‘h323_alg_no_quota’: H323 ALG User-Quota Not Found; ‘h323_alg_quota_inc_failure’: H323 ALG User-Quota Exceeded; ‘h323_alg_no_nat_ip’: H323 ALG Unknown NAT IP; ‘h323_alg_reuse_fullcone’: H323 ALG Reuse Full-cone Session; ‘h323_alg_fullcone_mismatch’: H323 ALG Full-cone Session Mismatch; ‘h323_alg_alloc_port_failure’: H323 ALG Alloc NAT Port Failure; ‘h323_alg_create_fullcone_failure’: H323 ALG Create Full-cone Session Failure; ‘h323_alg_release_port_failure’: H323 ALG Release NAT Port Failure; ‘h323_alg_single_rtp_fullcone’: H323 ALG Single RTP Full-cone Found; ‘h323_alg_single_rtcp_fullcone’: H323 ALG Single RTCP Full-cone Found; ‘h323_alg_rtcp_fullcone_mismatch’: H323 ALG RTCP Full-cone NAT Port Mismatch; ‘h323_alg_reuse_rtp_rtcp_fullcone’: H323 ALG Reuse RTP/RTCP Full-cone Session; ‘h323_alg_alloc_rtp_rtcp_port_failure’: H323 ALG Alloc RTP/RTCP NAT Ports Failure; ‘h323_alg_alloc_single_port_failure’: H323 ALG Alloc Single RTP or RTCP NAT Port Failure; ‘h323_alg_create_single_fullcone_failure’: H323 ALG Create Single RTP or RTCP Full-cone Session Failure; ‘h323_alg_create_rtp_fullcone_failure’: H323 ALG Create RTP Full-cone Session Failure; ‘h323_alg_create_rtcp_fullcone_failure’: H323 ALG Create RTCP Full-cone Session Failure; ‘h323_alg_port_pair_alloc_from_consecutive’: H323 ALG Port Pair Allocated From Consecutive; ‘h323_alg_port_pair_alloc_from_partition’: H323 ALG Port Pair Allocated From Partition; ‘h323_alg_port_pair_alloc_from_pool_port_batch’: H323 ALG Port Pair Allocated From Pool Port Batch; ‘h323_alg_port_pair_alloc_from_quota_consecutive’: H323 ALG Port Pair Allocated From Quota Consecutive; ‘h323_alg_port_pair_alloc_from_quota_partition’: H323 ALG Port Pair Allocated From Quota Partition; ‘h323_alg_port_pair_alloc_from_quota_partition_error’: H323 ALG Port Pair Allocated From Quota Partition Error; ‘h323_alg_port_pair_alloc_from_quota_pool_port_batch’: H323 ALG Port Pair Allocated From Quota Pool Port Batch; ‘port_batch_quota_extension_alloc_failure’: Port Batch Extension Alloc Failure (No memory); ‘port_batch_free_quota_not_found’: Port Batch Quota Not Found on Free; ‘port_batch_free_port_not_found’: Port Batch Port Not Found on Free; ‘port_batch_free_wrong_partition’: Port Batch Free Wrong Partition; ‘radius_query_quota_ext_alloc_failure’: RADIUS Query Container Alloc (No Memoty); ‘radius_query_quota_ext_alloc_race_free’: RADIUS Query Container Alloc Race Free; ‘quota_extension_added’: Quota Extension Added to Quota; ‘quota_extension_removed’: Quota Extension Removed from Quota; ‘quota_extension_remove_not_found’: Quota Extension Not Found on Remove; ‘ha_sync_port_batch_sent’: HA Port Batch Extension Sync Sent; ‘ha_sync_port_batch_rcv’: HA Port Batch Extension Sync Received; ‘ha_send_port_batch_not_found’: HA Port Batch Not Found on Sync Send; ‘ha_rcv_port_not_in_port_batch’: HA Port Not in Port Batch on Sync Rcv; ‘bad_port_to_free’: Freeing Bad Port; ‘consecutive_port_free’: Port Freed from Consecutive Pool; ‘partition_port_free’: Port Freed from Partition; ‘pool_port_batch_port_free’: Port Freed from Pool Port Batch; ‘port_allocated_from_quota_consecutive’: Port Allocated from Quota Consecutive; ‘port_allocated_from_quota_partition’: Port Allocated from Quota Partition; ‘port_allocated_from_quota_pool_port_batch’: Port Allocated from Quota Pool Port Batch; ‘port_freed_from_quota_consecutive’: Port Freed from Quota Consecutive; ‘port_freed_from_quota_partition’: Port Freed from Quota Partition; ‘port_freed_from_quota_pool_port_batch’: Port Freed from Quota Pool Port Batch; ‘port_batch_allocated_to_quota’: Port Batch Allocated to Quota; ‘port_batch_freed_from_quota’: Port Batch Freed From Quota; ‘specific_port_allocated_from_quota_consecutive’: Specific Port Allocated from Quota Consecutive;
Type: string
Supported Values: user_quota_not_found, tcp_fullcone_created_shadow, tcp_fullcone_freed_shadow, udp_fullcone_created_shadow, udp_fullcone_freed_shadow, udp_alg_fullcone_created, udp_alg_fullcone_freed, fullcone_created, fullcone_freed, data_session_created_shadow, data_session_freed_shadow, data_session_user_quota_mismatch, extended_quota_mismatched, nat_port_unavailable_other, nat_port_unavailable, new_user_resource_unavailable_tcp, new_user_resource_unavailable_udp, new_user_resource_unavailable_icmp, new_user_resource_unavailable_other, total_tcp_allocated_shadow, total_tcp_freed_shadow, total_udp_allocated_shadow, total_udp_freed_shadow, total_icmp_allocated_shadow, total_icmp_freed_shadow, udp_alg_no_quota, udp_alg_eim_mismatch, udp_alg_no_nat_ip, udp_alg_alloc_failure, sip_alg_no_quota, sip_alg_quota_inc_failure, sip_alg_no_nat_ip, sip_alg_reuse_contact_fullcone, sip_alg_contact_fullcone_mismatch, sip_alg_alloc_contact_port_failure, sip_alg_create_contact_fullcone_failure, sip_alg_release_contact_port_failure, sip_alg_single_rtp_fullcone, sip_alg_single_rtcp_fullcone, sip_alg_rtcp_fullcone_mismatch, sip_alg_reuse_rtp_rtcp_fullcone, sip_alg_alloc_rtp_rtcp_port_failure, sip_alg_alloc_single_port_failure, sip_alg_create_single_fullcone_failure, sip_alg_create_rtp_fullcone_failure, sip_alg_create_rtcp_fullcone_failure, sip_alg_port_pair_alloc_from_consecutive, sip_alg_port_pair_alloc_from_partition, sip_alg_port_pair_alloc_from_pool_port_batch, sip_alg_port_pair_alloc_from_quota_consecutive, sip_alg_port_pair_alloc_from_quota_partition, sip_alg_port_pair_alloc_from_quota_partition_error, sip_alg_port_pair_alloc_from_quota_pool_port_batch, sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag, h323_alg_no_quota, h323_alg_quota_inc_failure, h323_alg_no_nat_ip, h323_alg_reuse_fullcone, h323_alg_fullcone_mismatch, h323_alg_alloc_port_failure, h323_alg_create_fullcone_failure, h323_alg_release_port_failure, h323_alg_single_rtp_fullcone, h323_alg_single_rtcp_fullcone, h323_alg_rtcp_fullcone_mismatch, h323_alg_reuse_rtp_rtcp_fullcone, h323_alg_alloc_rtp_rtcp_port_failure, h323_alg_alloc_single_port_failure, h323_alg_create_single_fullcone_failure, h323_alg_create_rtp_fullcone_failure, h323_alg_create_rtcp_fullcone_failure, h323_alg_port_pair_alloc_from_consecutive, h323_alg_port_pair_alloc_from_partition, h323_alg_port_pair_alloc_from_pool_port_batch, h323_alg_port_pair_alloc_from_quota_consecutive, h323_alg_port_pair_alloc_from_quota_partition, h323_alg_port_pair_alloc_from_quota_partition_error, h323_alg_port_pair_alloc_from_quota_pool_port_batch, port_batch_quota_extension_alloc_failure, port_batch_free_quota_not_found, port_batch_free_port_not_found, port_batch_free_wrong_partition, radius_query_quota_ext_alloc_failure, radius_query_quota_ext_alloc_race_free, quota_extension_added, quota_extension_removed, quota_extension_remove_not_found, ha_sync_port_batch_sent, ha_sync_port_batch_rcv, ha_send_port_batch_not_found, ha_rcv_port_not_in_port_batch, bad_port_to_free, consecutive_port_free, partition_port_free, pool_port_batch_port_free, port_allocated_from_quota_consecutive, port_allocated_from_quota_partition, port_allocated_from_quota_pool_port_batch, port_freed_from_quota_consecutive, port_freed_from_quota_partition, port_freed_from_quota_pool_port_batch, port_batch_allocated_to_quota, port_batch_freed_from_quota, specific_port_allocated_from_quota_consecutive
counters3
Description ‘specific_port_allocated_from_quota_partition’: Specific Port Allocated from Quota Partition; ‘specific_port_allocated_from_quota_pool_port_batch’: Specific Port Allocated from Quota Pool Port Batch; ‘port_batch_container_alloc_failure’: Port Batch Container Alloc Out of Memory; ‘port_batch_container_alloc_race_free’: Port Batch Container Race Free; ‘port_overloading_destination_conflict’: Port Overloading Destination Conflict; ‘port_overloading_out_of_memory’: Port Overloading Out of Memory; ‘port_overloading_assign_user’: Port Overloading Port Assign User; ‘port_overloading_assign_user_port_batch’: Port Overloading Port Assign User Port Batch; ‘port_overloading_inc’: Port Overloading Port Increment; ‘port_overloading_dec_on_conflict’: Port Overloading Port Decrement on Conflict; ‘port_overloading_dec_on_free’: Port Overloading Port Decrement on Free; ‘port_overloading_free_port_on_conflict’: Port Overloading Free Port on Conflict; ‘port_overloading_free_port_batch_on_conflict’: Port Overloading Free Port Batch on Conflict; ‘port_overloading_inc_overflow’: Port Overloading Inc Overflow; ‘port_overloading_attempt_consecutive_ports’: Port Overloading on Consecutive Ports; ‘port_overloading_attempt_same_partition’: Port Overloading on Same Partition; ‘port_overloading_attempt_diff_partition’: Port Overloading on Different Partition; ‘port_overloading_attempt_failed’: Port Overloading Attempt Failed; ‘port_overloading_conn_free_retry_lookup’: Port Overloading Conn Free Retry Lookup; ‘port_overloading_conn_free_not_found’: Port Overloading Conn Free Not Found; ‘port_overloading_smp_mem_allocated’: Port Overloading SMP Session Allocated; ‘port_overloading_smp_mem_freed’: Port Overloading SMP Session Freed; ‘port_overloading_smp_inserted’: Port Overloading SMP Inserted; ‘port_overloading_smp_inserted_tcp_shadow’: Total Port Overloading SMP TCP Inserted; ‘port_overloading_smp_inserted_udp_shadow’: Total Port Overloading SMP UDP Inserted; ‘port_overloading_smp_free_tcp_shadow’: Total Port Overloading SMP TCP Freed; ‘port_overloading_smp_free_udp_shadow’: Total Port Overloading SMP UDP Freed; ‘port_overloading_smp_put_in_del_q_from_conn’: Port Overloading SMP Free From Conn; ‘port_overloading_smp_free_dec_failure’: Port Overloading SMP Free Dec Failure; ‘port_overloading_smp_free_no_quota’: Port Overloading SMP Free No Quota; ‘port_overloading_smp_free_port’: Port Overloading SMP Free Port; ‘port_overloading_smp_free_port_from_quota’: Port Overloading SMP Free Port From Quota; ‘port_overloading_for_no_ports’: Port Overloading for No Ports; ‘port_overloading_for_no_ports_success’: Port Overloading for No Ports Success; ‘port_overloading_for_quota_exceeded’: Port Overloading for Quota Exceeded; ‘port_overloading_for_quota_exceeded_success’: Port Overloading for Quota Exceeded Success; ‘port_overloading_for_quota_exceeded_race’: Port Overloading for Quota Exceeded Race; ‘port_overloading_for_quota_exceeded_race_success’: Port Overloading for Quota Exceeded Race Success; ‘port_overloading_for_new_user’: Port Overloading for New User; ‘port_overloading_for_new_user_success’: Port Overloading for New User Success; ‘ha_port_overloading_attempt_failed’: HA Port Overloading Attempt Failed; ‘ha_port_overloading_for_no_ports’: HA Port Overloading for No Ports; ‘ha_port_overloading_for_no_ports_success’: HA Port Overloading for No Ports Success; ‘ha_port_overloading_for_quota_exceeded’: HA Port Overloading for Quota Exceeded; ‘ha_port_overloading_for_quota_exceeded_success’: HA Port Overloading for Quota Exceeded Success; ‘ha_port_overloading_for_quota_exceeded_race’: HA Port Overloading for Quota Exceeded Race; ‘ha_port_overloading_for_quota_exceeded_race_success’: HA Port Overloading for Quota Exceeded Race Success; ‘ha_port_overloading_for_new_user’: HA Port Overloading for New User; ‘ha_port_overloading_for_new_user_success’: HA Port Overloading for New User Success; ‘nat_pool_force_delete’: NAT Pool Force Delete; ‘quota_ext_too_many’: Quota Ext Too Many; ‘nat_pool_not_found_on_free’: NAT Pool Not Found on Free; ‘fullcone_ext_mem_freed’: LSN Fullcone Extension Memory Freed; ‘fullcone_ext_mem_allocated’: LSN Fullcone Extension Memory Allocated; ‘fullcone_ext_mem_alloc_failure’: LSN Fullcone Extension Memory Allocate Failure; ‘fullcone_ext_mem_alloc_init_faulure’: LSN Fullcone Extension Initialization Failure; ‘fullcone_ext_added’: LSN Fullcone Extension Added; ‘fullcone_ext_too_many’: LSN Fullcone Extension Too Many; ‘nat_pool_attempt_adding_multiple_free_batches’: Attempt Adding Multiple Free Batches to Quota; ‘nat_pool_add_free_batch_failed’: Add Batch to Quota Failed; ‘mgcp_alg_no_quota’: MGCP ALG User-Quota Not Found; ‘mgcp_alg_quota_inc_failure’: MGCP ALG User-Quota Exceeded; ‘mgcp_alg_no_nat_ip’: MGCP ALG Unknown NAT IP; ‘mgcp_alg_reuse_fullcone’: MGCP ALG Reuse Full-cone Session; ‘mgcp_alg_fullcone_mismatch’: MGCP ALG Full-cone Session Mismatch; ‘mgcp_alg_alloc_port_failure’: MGCP ALG Alloc NAT Port Failure; ‘mgcp_alg_create_fullcone_failure’: MGCP ALG Create Full-cone Session Failure; ‘mgcp_alg_release_port_failure’: MGCP ALG Release NAT Port Failure; ‘mgcp_alg_single_rtp_fullcone’: MGCP ALG Single RTP Full-cone Found; ‘mgcp_alg_single_rtcp_fullcone’: MGCP ALG Single RTCP Full-cone Found; ‘mgcp_alg_rtcp_fullcone_mismatch’: MGCP ALG RTCP Full-cone NAT Port Mismatch; ‘mgcp_alg_reuse_rtp_rtcp_fullcone’: MGCP ALG Reuse RTP/RTCP Full-cone Session; ‘mgcp_alg_alloc_rtp_rtcp_port_failure’: MGCP ALG Alloc RTP/RTCP NAT Ports Failure; ‘mgcp_alg_alloc_single_port_failure’: MGCP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘mgcp_alg_create_single_fullcone_failure’: MGCP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘mgcp_alg_create_rtp_fullcone_failure’: MGCP ALG Create RTP Full-cone Session Failure; ‘mgcp_alg_create_rtcp_fullcone_failure’: MGCP ALG Create RTCP Full-cone Session Failure; ‘mgcp_alg_port_pair_alloc_from_consecutive’: MGCP ALG Port Pair Allocated From Consecutive; ‘mgcp_alg_port_pair_alloc_from_partition’: MGCP ALG Port Pair Allocated From Partition; ‘mgcp_alg_port_pair_alloc_from_pool_port_batch’: MGCP ALG Port Pair Allocated From Pool Port Batch; ‘mgcp_alg_port_pair_alloc_from_quota_consecutive’: MGCP ALG Port Pair Allocated From Quota Consecutive; ‘mgcp_alg_port_pair_alloc_from_quota_partition’: MGCP ALG Port Pair Allocated From Quota Partition; ‘mgcp_alg_port_pair_alloc_from_quota_partition_error’: MGCP ALG Port Pair Allocated From Quota Partition Error; ‘mgcp_alg_port_pair_alloc_from_quota_pool_port_batch’: MGCP ALG Port Pair Allocated From Quota Pool Port Batch; ‘user_quota_unusable_drop’: User-Quota Unusable Drop; ‘user_quota_unusable’: User-Quota Marked Unusable; ‘nat_pool_same_port_batch_udp_failed’: Simultaneous Batch Allocation UDP Port Allocation Failed; ‘cross_cpu_helper_created_eim’: EIM Cross CPU Session Helper Created; ‘cross_cpu_helper_created_eif’: EIF Cross CPU Session Helper Created; ‘cross_cpu_helper_created_udp’: UDP Cross CPU Session Helper Created; ‘cross_cpu_helper_created_tcp’: TCP Cross CPU Session Helper Created; ‘cross_cpu_helper_created_icmp’: ICMP Cross CPU Session Helper Created; ‘cross_cpu_helper_created_ip’: IP Cross CPU Session Helper Created; ‘cross_cpu_helper_free_not_found_ip’: IP Cross CPU Helper Free Not Found; ‘cross_cpu_helper_free_not_found_icmp’: ICMP Cross CPU Helper Free Not Found; ‘cross_cpu_helper_free_not_found_tcp’: TCP Cross CPU Helper Free Not Found; ‘cross_cpu_helper_free_not_found_udp’: UDP Cross CPU Helper Free Not Found; ‘adc_port_allocation_failed’: ADC Port Allocation Failed; ‘adc_port_allocation_ineligible’: ADC Port Allocation Not Allowed;
Type: string
Supported Values: specific_port_allocated_from_quota_partition, specific_port_allocated_from_quota_pool_port_batch, port_batch_container_alloc_failure, port_batch_container_alloc_race_free, port_overloading_destination_conflict, port_overloading_out_of_memory, port_overloading_assign_user, port_overloading_assign_user_port_batch, port_overloading_inc, port_overloading_dec_on_conflict, port_overloading_dec_on_free, port_overloading_free_port_on_conflict, port_overloading_free_port_batch_on_conflict, port_overloading_inc_overflow, port_overloading_attempt_consecutive_ports, port_overloading_attempt_same_partition, port_overloading_attempt_diff_partition, port_overloading_attempt_failed, port_overloading_conn_free_retry_lookup, port_overloading_conn_free_not_found, port_overloading_smp_mem_allocated, port_overloading_smp_mem_freed, port_overloading_smp_inserted, port_overloading_smp_inserted_tcp_shadow, port_overloading_smp_inserted_udp_shadow, port_overloading_smp_free_tcp_shadow, port_overloading_smp_free_udp_shadow, port_overloading_smp_put_in_del_q_from_conn, port_overloading_smp_free_dec_failure, port_overloading_smp_free_no_quota, port_overloading_smp_free_port, port_overloading_smp_free_port_from_quota, port_overloading_for_no_ports, port_overloading_for_no_ports_success, port_overloading_for_quota_exceeded, port_overloading_for_quota_exceeded_success, port_overloading_for_quota_exceeded_race, port_overloading_for_quota_exceeded_race_success, port_overloading_for_new_user, port_overloading_for_new_user_success, ha_port_overloading_attempt_failed, ha_port_overloading_for_no_ports, ha_port_overloading_for_no_ports_success, ha_port_overloading_for_quota_exceeded, ha_port_overloading_for_quota_exceeded_success, ha_port_overloading_for_quota_exceeded_race, ha_port_overloading_for_quota_exceeded_race_success, ha_port_overloading_for_new_user, ha_port_overloading_for_new_user_success, nat_pool_force_delete, quota_ext_too_many, nat_pool_not_found_on_free, fullcone_ext_mem_freed, fullcone_ext_mem_allocated, fullcone_ext_mem_alloc_failure, fullcone_ext_mem_alloc_init_faulure, fullcone_ext_added, fullcone_ext_too_many, nat_pool_attempt_adding_multiple_free_batches, nat_pool_add_free_batch_failed, mgcp_alg_no_quota, mgcp_alg_quota_inc_failure, mgcp_alg_no_nat_ip, mgcp_alg_reuse_fullcone, mgcp_alg_fullcone_mismatch, mgcp_alg_alloc_port_failure, mgcp_alg_create_fullcone_failure, mgcp_alg_release_port_failure, mgcp_alg_single_rtp_fullcone, mgcp_alg_single_rtcp_fullcone, mgcp_alg_rtcp_fullcone_mismatch, mgcp_alg_reuse_rtp_rtcp_fullcone, mgcp_alg_alloc_rtp_rtcp_port_failure, mgcp_alg_alloc_single_port_failure, mgcp_alg_create_single_fullcone_failure, mgcp_alg_create_rtp_fullcone_failure, mgcp_alg_create_rtcp_fullcone_failure, mgcp_alg_port_pair_alloc_from_consecutive, mgcp_alg_port_pair_alloc_from_partition, mgcp_alg_port_pair_alloc_from_pool_port_batch, mgcp_alg_port_pair_alloc_from_quota_consecutive, mgcp_alg_port_pair_alloc_from_quota_partition, mgcp_alg_port_pair_alloc_from_quota_partition_error, mgcp_alg_port_pair_alloc_from_quota_pool_port_batch, user_quota_unusable_drop, user_quota_unusable, nat_pool_same_port_batch_udp_failed, cross_cpu_helper_created_eim, cross_cpu_helper_created_eif, cross_cpu_helper_created_udp, cross_cpu_helper_created_tcp, cross_cpu_helper_created_icmp, cross_cpu_helper_created_ip, cross_cpu_helper_free_not_found_ip, cross_cpu_helper_free_not_found_icmp, cross_cpu_helper_free_not_found_tcp, cross_cpu_helper_free_not_found_udp, adc_port_allocation_failed, adc_port_allocation_ineligible
counters4
Description ‘acl_http_domain_node_exceeded’: ACL HTTP Domain Node Exceeded; ‘fwd_ingress_packets_tcp’: Forward Ingress Packets TCP; ‘fwd_egress_packets_tcp’: Forward Egress Packets TCP; ‘rev_ingress_packets_tcp’: Reverse Ingress Packets TCP; ‘rev_egress_packets_tcp’: Reverse Egress Packets TCP; ‘fwd_ingress_bytes_tcp’: Forward Ingress Bytes TCP; ‘fwd_egress_bytes_tcp’: Forward Egress Bytes TCP; ‘rev_ingress_bytes_tcp’: Reverse Ingress Bytes TCP; ‘rev_egress_bytes_tcp’: Reverse Egress Bytes TCP; ‘fwd_ingress_packets_udp’: Forward Ingress Packets UDP; ‘fwd_egress_packets_udp’: Forward Egress Packets UDP; ‘rev_ingress_packets_udp’: Reverse Ingress Packets UDP; ‘rev_egress_packets_udp’: Reverse Egress Packets UDP; ‘fwd_ingress_bytes_udp’: Forward Ingress Bytes UDP; ‘fwd_egress_bytes_udp’: Forward Egress Bytes UDP; ‘rev_ingress_bytes_udp’: Reverse Ingress Bytes UDP; ‘rev_egress_bytes_udp’: Reverse Egress Bytes UDP; ‘fwd_ingress_packets_icmp’: Forward Ingress Packets ICMP; ‘fwd_egress_packets_icmp’: Forward Egress Packets ICMP; ‘rev_ingress_packets_icmp’: Reverse Ingress Packets ICMP; ‘rev_egress_packets_icmp’: Reverse Egress Packets ICMP; ‘fwd_ingress_bytes_icmp’: Forward Ingress Bytes ICMP; ‘fwd_egress_bytes_icmp’: Forward Egress Bytes ICMP; ‘rev_ingress_bytes_icmp’: Reverse Ingress Bytes ICMP; ‘rev_egress_bytes_icmp’: Reverse Egress Bytes ICMP; ‘fwd_ingress_packets_others’: Forward Ingress Packets OTHERS; ‘fwd_egress_packets_others’: Forward Egress Packets OTHERS; ‘rev_ingress_packets_others’: Reverse Ingress Packets OTHERS; ‘rev_egress_packets_others’: Reverse Egress Packets OTHERS; ‘fwd_ingress_bytes_others’: Forward Ingress Bytes OTHERS; ‘fwd_egress_bytes_others’: Forward Egress Bytes OTHERS; ‘rev_ingress_bytes_others’: Reverse Ingress Bytes OTHERS; ‘rev_egress_bytes_others’: Reverse Egress Bytes OTHERS; ‘fwd_ingress_pkt_size_range1’: Forward Ingress Packet size between 0 and 200; ‘fwd_ingress_pkt_size_range2’: Forward Ingress Packet size between 201 and 800; ‘fwd_ingress_pkt_size_range3’: Forward Ingress Packet size between 801 and 1550; ‘fwd_ingress_pkt_size_range4’: Forward Ingress Packet size between 1551 and 9000; ‘fwd_egress_pkt_size_range1’: Forward Egress Packet size between 0 and 200; ‘fwd_egress_pkt_size_range2’: Forward Egress Packet size between 201 and 800; ‘fwd_egress_pkt_size_range3’: Forward Egress Packet size between 801 and 1550; ‘fwd_egress_pkt_size_range4’: Forward Egress Packet size between 1551 and 9000; ‘rev_ingress_pkt_size_range1’: Reverse Ingress Packet size between 0 and 200; ‘rev_ingress_pkt_size_range2’: Reverse Ingress Packet size between 201 and 800; ‘rev_ingress_pkt_size_range3’: Reverse Ingress Packet size between 801 and 1550; ‘rev_ingress_pkt_size_range4’: Reverse Ingress Packet size between 1551 and 9000; ‘rev_egress_pkt_size_range1’: Reverse Egress Packet size between 0 and 200; ‘rev_egress_pkt_size_range2’: Reverse Egress Packet size between 201 and 800; ‘rev_egress_pkt_size_range3’: Reverse Egress Packet size between 801 and 1550; ‘rev_egress_pkt_size_range4’: Reverse Egress Packet size between 1551 and 9000;
Type: string
Supported Values: acl_http_domain_node_exceeded, fwd_ingress_packets_tcp, fwd_egress_packets_tcp, rev_ingress_packets_tcp, rev_egress_packets_tcp, fwd_ingress_bytes_tcp, fwd_egress_bytes_tcp, rev_ingress_bytes_tcp, rev_egress_bytes_tcp, fwd_ingress_packets_udp, fwd_egress_packets_udp, rev_ingress_packets_udp, rev_egress_packets_udp, fwd_ingress_bytes_udp, fwd_egress_bytes_udp, rev_ingress_bytes_udp, rev_egress_bytes_udp, fwd_ingress_packets_icmp, fwd_egress_packets_icmp, rev_ingress_packets_icmp, rev_egress_packets_icmp, fwd_ingress_bytes_icmp, fwd_egress_bytes_icmp, rev_ingress_bytes_icmp, rev_egress_bytes_icmp, fwd_ingress_packets_others, fwd_egress_packets_others, rev_ingress_packets_others, rev_egress_packets_others, fwd_ingress_bytes_others, fwd_egress_bytes_others, rev_ingress_bytes_others, rev_egress_bytes_others, fwd_ingress_pkt_size_range1, fwd_ingress_pkt_size_range2, fwd_ingress_pkt_size_range3, fwd_ingress_pkt_size_range4, fwd_egress_pkt_size_range1, fwd_egress_pkt_size_range2, fwd_egress_pkt_size_range3, fwd_egress_pkt_size_range4, rev_ingress_pkt_size_range1, rev_ingress_pkt_size_range2, rev_ingress_pkt_size_range3, rev_ingress_pkt_size_range4, rev_egress_pkt_size_range1, rev_egress_pkt_size_range2, rev_egress_pkt_size_range3, rev_egress_pkt_size_range4, chassis_incorrect_pu
lsn_alg¶
Specification
Value
Type
object
dns
Description: dns is a JSON Block. Please see below for lsn_alg_dns
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/dns
esp
Description: esp is a JSON Block. Please see below for lsn_alg_esp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/esp
ftp
Description: ftp is a JSON Block. Please see below for lsn_alg_ftp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/ftp
h323
Description: h323 is a JSON Block. Please see below for lsn_alg_h323
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/h323
mgcp
Description: mgcp is a JSON Block. Please see below for lsn_alg_mgcp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/mgcp
pptp
Description: pptp is a JSON Block. Please see below for lsn_alg_pptp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/pptp
rtp
Description: rtp is a JSON Block. Please see below for lsn_alg_rtp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/rtp
rtsp
Description: rtsp is a JSON Block. Please see below for lsn_alg_rtsp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for lsn_alg_sip
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for lsn_alg_tftp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/alg/tftp
lsn_alg_dns¶
Specification
Value
Type
object
dns-value
Description ‘disable’: Disable DNS ALG for LSN;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_esp¶
Specification
Value
Type
object
esp-value
Description ‘enable’: Enable ESP ALG for LSN; ‘enable-with-ctrl’: Enable ESP ALG for LSN with control session;
Type: string
Supported Values: enable, enable-with-ctrl
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_esp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: ESP Sessions Created; ‘placeholder-debug’: Placeholder Debug; ‘nat-ip-conflict’: NAT IP Conflict;
Type: string
Supported Values: all, session-created, placeholder-debug, nat-ip-conflict
lsn_alg_ftp¶
Specification
Value
Type
object
ftp-value
Description ‘disable’: Disable FTP ALG for LSN;
Type: string
Supported Values: disable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_ftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘port-requests’: PORT Requests From Client; ‘eprt-requests’: EPRT Requests From Client; ‘lprt-requests’: LPRT Requests From Client; ‘pasv-replies’: PASV Replies From Server; ‘epsv-replies’: EPSV Replies From Server; ‘lpsv-replies’: LPSV Replies From Server; ‘port-retransmits’: Port Mode Request Retransmits; ‘pasv-retransmits’: Passive Mode Reply Retransmits; ‘port-helper-created’: Port Mode Helper Created; ‘pasv-helper-created’: Passive Mode Helper Created; ‘port-helper-freed’: Port Mode Helper Freed; ‘pasv-helper-freed’: Passive Mode Helper Freed; ‘port-helper-unused’: Port Mode Helper Unused; ‘pasv-helper-unused’: Passive Mode Helper Unused; ‘port-helper-creation-failure’: Port Helper Creation Failure; ‘pasv-helper-creation-failure’: Passive Helper Creation Failure; ‘get-conn-ext-failure’: Get Conn Extension Failure; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch;
Type: string
Supported Values: all, port-requests, eprt-requests, lprt-requests, pasv-replies, epsv-replies, lpsv-replies, port-retransmits, pasv-retransmits, port-helper-created, pasv-helper-created, port-helper-freed, pasv-helper-freed, port-helper-unused, pasv-helper-unused, port-helper-creation-failure, pasv-helper-creation-failure, get-conn-ext-failure, smp-app-type-mismatch
lsn_alg_pptp¶
Specification
Value
Type
object
pptp-value
Description ‘enable’: Enable PPTP ALG for LSN;
Type: string
Supported Values: enable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_pptp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘calls-established’: Calls Established; ‘mismatched-pns-call-id’: Mismatched PNS Call ID; ‘gre-sessions-created’: GRE Sessions Created; ‘gre-sessions-freed’: GRE Sessions Freed; ‘no-gre-session-match’: No Matching GRE Session; ‘smp-sessions-created’: SMP Sessions Created; ‘smp-sessions-freed’: SMP Sessions Freed; ‘smp-session-creation-failure’: SMP Session Creation Failures; ‘extension-creation-failure’: Extension Creation Failures; ‘ha-sent’: HA Info Sent; ‘ha-rcv’: HA Info Received; ‘ha-no-mem’: HA Memory Allocation Failure; ‘ha-conflict’: HA Call ID Conflicts; ‘ha-overwrite’: HA Call ID Overwrites; ‘ha-call-sent’: HA Call Sent; ‘ha-call-rcv’: HA Call Received; ‘ha-smp-conflict’: HA SMP Conflicts; ‘ha-smp-in-del-q’: HA SMP Deleted; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch; ‘quota-inc’: Quota Incremented; ‘quota-dec’: Quota Decremented; ‘quota-inc-not-found’: Quota Not Found on Increment; ‘quota-dec-not-found’: Quota Not Found on Decrement; ‘call-req-pns-call-id-mismatch’: Call ID Mismatch on Call Request; ‘call-reply-pns-call-id-mismatch’: Call ID Mismatch on Call Reply; ‘call-req-retransmit’: Call Request Retransmit; ‘call-req-new’: Call Request New; ‘call-req-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘call-reply-call-id-unknown’: Call Reply Unknown Client Call ID; ‘call-reply-retransmit’: Call Reply Retransmit; ‘call-reply-retransmit-wrong-control’: Call Reply Retransmit Wrong Control; ‘call-reply-retransmit-acquired’: Call Reply Retransmit Acquired; ‘call-reply-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘smp-client-call-id-mismatch’: SMP Client Call ID Mismatch; ‘smp-alloc-failure’: SMP Session Alloc Failure; ‘gre-conn-creation-failure’: GRE Conn Alloc Failure; ‘gre-conn-ext-creation-failure’: GRE Conn Ext Alloc Failure; ‘gre-no-fwd-route’: GRE No Fwd Route; ‘gre-no-rev-route’: GRE No Rev Route; ‘gre-no-control-conn’: GRE No Control Conn; ‘gre-conn-already-exists’: GRE Conn Already Exists; ‘gre-free-no-ext’: GRE Free No Ext; ‘gre-free-no-smp’: GRE Free No SMP; ‘gre-free-smp-app-type-mismatch’: GRE Free SMP App Type Mismatch; ‘control-freed’: Control Session Freed; ‘control-free-no-ext’: Control Free No Ext; ‘control-free-no-smp’: Control Free No SMP; ‘control-free-smp-app-type-mismatch’: Control Free SMP App Type Mismatch;
Type: string
Supported Values: all, calls-established, mismatched-pns-call-id, gre-sessions-created, gre-sessions-freed, no-gre-session-match, smp-sessions-created, smp-sessions-freed, smp-session-creation-failure, extension-creation-failure, ha-sent, ha-rcv, ha-no-mem, ha-conflict, ha-overwrite, ha-call-sent, ha-call-rcv, ha-smp-conflict, ha-smp-in-del-q, smp-app-type-mismatch, quota-inc, quota-dec, quota-inc-not-found, quota-dec-not-found, call-req-pns-call-id-mismatch, call-reply-pns-call-id-mismatch, call-req-retransmit, call-req-new, call-req-ext-alloc-failure, call-reply-call-id-unknown, call-reply-retransmit, call-reply-retransmit-wrong-control, call-reply-retransmit-acquired, call-reply-ext-alloc-failure, smp-client-call-id-mismatch, smp-alloc-failure, gre-conn-creation-failure, gre-conn-ext-creation-failure, gre-no-fwd-route, gre-no-rev-route, gre-no-control-conn, gre-conn-already-exists, gre-free-no-ext, gre-free-no-smp, gre-free-smp-app-type-mismatch, control-freed, control-free-no-ext, control-free-no-smp, control-free-smp-app-type-mismatch
lsn_alg_rtsp¶
Specification
Value
Type
object
rtsp-value
Description ‘enable’: Enable RTSP ALG for LSN;
Type: string
Supported Values: enable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_rtsp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘streams-created’: Streams Created; ‘streams-freed’: Streams Freed; ‘stream-creation-failure’: Stream Creation Failures; ‘ports-allocated’: Stream Client Ports Allocated; ‘ports-freed’: Stream Client Ports Freed; ‘port-allocation-failure’: Stream Client Port Allocation Failures; ‘unknown-client-port-from-server’: Server Replies With Unknown Client Ports; ‘data-session-created’: Data Session Created; ‘data-session-freed’: Data Session Freed; ‘no-session-mem’: Data Session Creation Failures; ‘ha-sent’: HA Sent; ‘ha-rcv’: HA RCV; ‘smp-inserted’: SMP Session Inserted; ‘smp-removed’: SMP Session Removed; ‘smp-reused’: SMP Session Reused; ‘nat-pool-standby’: New Session NAT Pool Standby; ‘smp-deleted’: New Session SMP Already Deleted; ‘control-closed’: New Session Closed; ‘data-session-exists’: New Session Already Exists; ‘data-session-creation-failure’: New Data Session Creation Failure; ‘rtp-reversed’: RTP Reverse Creation; ‘rtcp-reversed’: RTCP Reverse Creation; ‘cross-cpu-sent’: Cross CPU Sent; ‘cross-cpu-rcv’: Cross CPU Received; ‘cross-cpu-no-session’: Cross CPU No Session Found; ‘cross-cpu-created’: Cross CPU Creation; ‘cross-cpu-rcv-failure’: Cross CPU Receive Failure; ‘data-free-smp-retry-lookup’: Data Session Free SMP Retry Lookup; ‘data-free-smp-not-found’: Data Session Free SMP Not Found; ‘ha-streams-sent’: HA Streams Sent; ‘ha-streams-rcv’: HA Streams Received; ‘ha-stream-incompatible’: HA Incompatible Streams Received; ‘ha-stream-exists’: HA Stream Already Exists; ‘ha-port-allocation-failure’: HA Stream Port Allocation Failure; ‘ha-data-session-sent’: HA Data Session Sent; ‘ha-data-session-rcv’: HA Data Session Received; ‘ha-data-no-smp’: HA Data Session SMP Not Found; ‘ha-control-closed’: HA New Data Control Session Closed; ‘ha-data-exists’: HA New Data Session Already Exists; ‘ha-extension-failure’: HA Conn Extension Failure; ‘ha-stream-smp-reused’: HA SMP Session Reused; ‘ha-stream-smp-acquire-failure’: HA SMP Session Acquire Failure; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch;
Type: string
Supported Values: all, streams-created, streams-freed, stream-creation-failure, ports-allocated, ports-freed, port-allocation-failure, unknown-client-port-from-server, data-session-created, data-session-freed, no-session-mem, ha-sent, ha-rcv, smp-inserted, smp-removed, smp-reused, nat-pool-standby, smp-deleted, control-closed, data-session-exists, data-session-creation-failure, rtp-reversed, rtcp-reversed, cross-cpu-sent, cross-cpu-rcv, cross-cpu-no-session, cross-cpu-created, cross-cpu-rcv-failure, data-free-smp-retry-lookup, data-free-smp-not-found, ha-streams-sent, ha-streams-rcv, ha-stream-incompatible, ha-stream-exists, ha-port-allocation-failure, ha-data-session-sent, ha-data-session-rcv, ha-data-no-smp, ha-control-closed, ha-data-exists, ha-extension-failure, ha-stream-smp-reused, ha-stream-smp-acquire-failure, smp-app-type-mismatch
lsn_alg_rtp¶
Specification
Value
Type
object
rtp-stun-timeout
Description RTP/RTCP STUN timeout (default: 5 minutes)}
Type: number
Range: 2-10
Default: 5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_sip¶
Specification
Value
Type
object
rtp-stun-timeout
Description RTP/RTCP STUN timeout in minutes (Default is 5 minutes)
Type: number
Range: 2-10
Default: 5
sampling-enable
Type: List
sip-value
Description ‘enable’: Enable SIP ALG for LSN;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_sip_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘method-register’: SIP Method REGISTER; ‘method-invite’: SIP Method INVITE; ‘method-ack’: SIP Method ACK; ‘method-cancel’: SIP Method CANCEL; ‘method-bye’: SIP Method BYE; ‘method-options’: SIP Method OPTIONS; ‘method-prack’: SIP Method PRACK; ‘method-subscribe’: SIP Method SUBSCRIBE; ‘method-notify’: SIP Method NOTIFY; ‘method-publish’: SIP Method PUBLISH; ‘method-info’: SIP Method INFO; ‘method-refer’: SIP Method REFER; ‘method-message’: SIP Method MESSAGE; ‘method-update’: SIP Method UPDATE; ‘method-unknown’: SIP Method UNKNOWN; ‘parse-error’: SIP Message Parse Error; ‘req-uri-op-failrue’: SIP Operate Request Uri Failure; ‘via-hdr-op-failrue’: SIP Operate Via Header Failure; ‘contact-hdr-op-failrue’: SIP Operate Contact Header Failure; ‘from-hdr-op-failrue’: SIP Operate From Header Failure; ‘to-hdr-op-failrue’: SIP Operate To Header Failure; ‘route-hdr-op-failrue’: SIP Operate Route Header Failure; ‘record-route-hdr-op-failrue’: SIP Operate Record-Route Header Failure; ‘content-length-hdr-op-failrue’: SIP Operate Content-Length Failure; ‘third-party-registration’: SIP Third-Party Registration; ‘conn-ext-creation-failure’: SIP Create Connection Extension Failure; ‘alloc-contact-port-failure’: SIP Alloc Contact Port Failure; ‘outside-contact-port-mismatch’: SIP Outside Contact Port Mismatch NAT Port; ‘inside-contact-port-mismatch’: SIP Inside Contact Port Mismatch; ‘third-party-sdp’: SIP Third-Party SDP; ‘sdp-process-candidate-failure’: SIP Operate SDP Media Candidate Attribute Failure; ‘sdp-op-failure’: SIP Operate SDP Failure; ‘sdp-alloc-port-map-success’: SIP Alloc SDP Port Map Success; ‘sdp-alloc-port-map-failure’: SIP Alloc SDP Port Map Failure; ‘modify-failure’: SIP Message Modify Failure; ‘rewrite-failure’: SIP Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop; ‘smp-conn-alloc-failure’: SMP Helper Conn Alloc Failure; ‘helper-found’: SMP Helper Conn Found; ‘helper-created’: SMP Helper Conn Created; ‘helper-deleted’: SMP Helper Conn Already Deleted; ‘helper-freed’: SMP Helper Conn Freed; ‘helper-failure’: SMP Helper Failure;
Type: string
Supported Values: all, method-register, method-invite, method-ack, method-cancel, method-bye, method-options, method-prack, method-subscribe, method-notify, method-publish, method-info, method-refer, method-message, method-update, method-unknown, parse-error, req-uri-op-failrue, via-hdr-op-failrue, contact-hdr-op-failrue, from-hdr-op-failrue, to-hdr-op-failrue, route-hdr-op-failrue, record-route-hdr-op-failrue, content-length-hdr-op-failrue, third-party-registration, conn-ext-creation-failure, alloc-contact-port-failure, outside-contact-port-mismatch, inside-contact-port-mismatch, third-party-sdp, sdp-process-candidate-failure, sdp-op-failure, sdp-alloc-port-map-success, sdp-alloc-port-map-failure, modify-failure, rewrite-failure, tcp-out-of-order-drop, smp-conn-alloc-failure, helper-found, helper-created, helper-deleted, helper-freed, helper-failure
lsn_alg_mgcp¶
Specification
Value
Type
object
mgcp-value
Description ‘enable’: Enable MGCP ALG for LSN;
Type: string
Supported Values: enable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_mgcp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘auep’: MGCP AUEP; ‘aucx’: MGCP AUCX; ‘crcx’: MGCP CRCX; ‘dlcx’: MGCP DLCX; ‘epcf’: MGCP EPCF; ‘mdcx’: MGCP MDCX; ‘ntfy’: MGCP NTFY; ‘rqnt’: MGCP RQNT; ‘rsip’: MGCP RSIP; ‘parse-error’: MGCP Message Parse Error; ‘conn-ext-creation-failure’: MGCP Create Connection Extension Failure; ‘third-party-sdp’: MGCP Third-Party SDP; ‘sdp-process-candidate-failure’: MGCP Operate SDP Media Candidate Attribute Failure; ‘sdp-op-failure’: MGCP Operate SDP Failure; ‘sdp-alloc-port-map-success’: MGCP Alloc SDP Port Map Success; ‘sdp-alloc-port-map-failure’: MGCP Alloc SDP Port Map Failure; ‘modify-failure’: MGCP Message Modify Failure; ‘rewrite-failure’: MGCP Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop;
Type: string
Supported Values: all, auep, aucx, crcx, dlcx, epcf, mdcx, ntfy, rqnt, rsip, parse-error, conn-ext-creation-failure, third-party-sdp, sdp-process-candidate-failure, sdp-op-failure, sdp-alloc-port-map-success, sdp-alloc-port-map-failure, modify-failure, rewrite-failure, tcp-out-of-order-drop
lsn_alg_h323¶
Specification
Value
Type
object
h323-value
Description ‘enable’: Enable H323 ALG for LSN;
Type: string
Supported Values: enable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_h323_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘h225ras-message’: H323 H225 RAS Message; ‘h225cs-message’: H323 H225 Call Signaling Message; ‘h245ctl-message’: H323 H245 Media Control Message; ‘h245-tunneled’: H323 H245 Tunnelled Message; ‘fast-start’: H323 FastStart; ‘parse-error’: Message Parse Error; ‘message-cross-multi-packets’: H323 Message Cross Multiple Packets; ‘conn-ext-creation-failure’: H323 Packet Rewrite Failure; ‘rewrite-failure’: H323 Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop; ‘h245-dynamic-addr-exceed’: H323 H245 Dynamic Address Exceed;
Type: string
Supported Values: all, h225ras-message, h225cs-message, h245ctl-message, h245-tunneled, fast-start, parse-error, message-cross-multi-packets, conn-ext-creation-failure, rewrite-failure, tcp-out-of-order-drop, h245-dynamic-addr-exceed
lsn_alg_tftp¶
Specification
Value
Type
object
sampling-enable
Type: List
tftp-value
Description ‘enable’: Enable TFTP ALG for LSN;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_alg_tftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: TFTP Client Sessions Created; ‘helper-created’: TFTP Helper Sessions created; ‘helper-freed’: TFTP Helper Sessions freed; ‘helper-freed-used’: TFTP Helper Sessions freed used; ‘helper-freed-unused’: TFTP Helper Sessions freed unused; ‘helper-already-used’: TFTP Helper Session already used; ‘helper-in-rml’: TFTP Helper Session in Remove List;
Type: string
Supported Values: all, session-created, helper-created, helper-freed, helper-freed-used, helper-freed-unused, helper-already-used, helper-in-rml
lsn_endpoint-independent-mapping¶
Specification
Value
Type
object
tcp
Description: tcp is a JSON Block. Please see below for lsn_endpoint-independent-mapping_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-mapping/tcp
udp
Description: udp is a JSON Block. Please see below for lsn_endpoint-independent-mapping_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-mapping/udp
lsn_endpoint-independent-mapping_tcp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_endpoint-independent-mapping_tcp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_endpoint-independent-mapping_udp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_endpoint-independent-mapping_udp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_endpoint-independent-filtering¶
Specification
Value
Type
object
tcp
Description: tcp is a JSON Block. Please see below for lsn_endpoint-independent-filtering_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-filtering/tcp
udp
Description: udp is a JSON Block. Please see below for lsn_endpoint-independent-filtering_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/endpoint-independent-filtering/udp
lsn_endpoint-independent-filtering_tcp¶
Specification
Value
Type
object
port-list
Type: List
session-limit
Description Limit number of EIF sessions that can be created per port
Type: number
Range: 1-65535
Default: 65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_endpoint-independent-filtering_tcp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_endpoint-independent-filtering_udp¶
Specification
Value
Type
object
port-list
Type: List
session-limit
Description Limit number of EIF sessions that can be created per port
Type: number
Range: 1-65535
Default: 65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_endpoint-independent-filtering_udp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_inside¶
Specification
Value
Type
object
source
Description: source is a JSON Block. Please see below for lsn_inside_source
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/inside/source
lsn_inside_source¶
Specification
Value
Type
object
class-list
Description Class List (Class List 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
lsn_port-reservation-list¶
Specification
Value
Type
list
Block object keys
inside
Description Inside User Address and Port Range (Inside User IP address)
Type: string
Format: ipv4-address
inside-port-end
Description Inside End Port
Type: number
Range: 1-65535
inside-port-start
Description Inside Start Port
Type: number
Range: 1-65535
nat
Description NAT IP address
Type: string
Format: ipv4-address
nat-port-end
Description NAT End Port
Type: number
Range: 1-65535
nat-port-start
Description NAT Start Port
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-reservation-entries¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_radius¶
Specification
Value
Type
object
server
Description: server is a JSON Block. Please see below for lsn_radius_server
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/radius/server
lsn_radius_server¶
Specification
Value
Type
object
accounting-interim-update
Description ‘ignore’: Ignore (default); ‘append-entry’: Append the AVPs to existing entry; ‘replace-entry’: Replace the AVPs of existing entry;
Type: string
Supported Values: ignore, append-entry, replace-entry
Default: ignore
accounting-on
Description ‘ignore’: Ignore (default); ‘delete-entries-using-attribute’: Delete entries matching attribute in RADIUS Table;
Type: string
Supported Values: ignore, delete-entries-using-attribute
Default: ignore
accounting-start
Description ‘ignore’: Ignore; ‘append-entry’: Append the AVPs to existing entry (default); ‘replace-entry’: Replace the AVPs of existing entry;
Type: string
Supported Values: ignore, append-entry, replace-entry
Default: append-entry
accounting-stop
Description ‘ignore’: Ignore; ‘delete-entry’: Delete the entry (default); ‘delete-entry-and-sessions’: Delete the entry and data sessions associated;
Type: string
Supported Values: ignore, delete-entry, delete-entry-and-sessions
Default: delete-entry
attribute
Type: List
attribute-name
Description ‘msisdn’: Clear using MSISDN; ‘imei’: Clear using IMEI; ‘imsi’: Clear using IMSI;
Type: string
Supported Values: msisdn, imei, imsi
Mutual Exclusion: attribute-name and custom-attribute-name are mutually exclusive
custom-attribute-name
Description Clear using customized attribute
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
Mutual Exclusion: custom-attribute-name and attribute-name are mutually exclusive
disable-reply
Description Toggle option for RADIUS reply packet(Default: Accounting response will be sent)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
listen-port
Description Configure the listen port of RADIUS server (Port number)
Type: number
Range: 1024-65535
remote
Description: remote is a JSON Block. Please see below for lsn_radius_server_remote
Type: Object
sampling-enable
Type: List
secret
Description Configure shared secret
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-string
Description The RADIUS secret
Type: string
Format: password
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 Join a VRRP-A failover group
Type: number
Range: 1-31
lsn_radius_server_remote¶
Specification
Value
Type
object
ip-list
Type: List
lsn_radius_server_remote_ip-list¶
Specification
Value
Type
list
Block object keys
ip-list-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
ip-list-name
Description IP-list name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ip-list-secret
Description Configure shared secret
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-list-secret-string
Description The RADIUS secret
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
lsn_radius_server_attribute¶
Specification
Value
Type
list
Block object keys
attribute-value
Description ‘inside-ipv6-prefix’: Framed IPv6 Prefix; ‘inside-ip’: Inside IP address; ‘inside-ipv6’: Inside IPv6 address; ‘imei’: International Mobile Equipment Identity (IMEI); ‘imsi’: International Mobile Subscriber Identity (IMSI); ‘msisdn’: Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3; ‘custom4’: Customized attribute 4; ‘custom5’: Customized attribute 5; ‘custom6’: Customized attribute 6;
Type: string
Supported Values: inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6
custom-number
Description RADIUS attribute number
Type: number
Range: 1-255
custom-vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
name
Description Customized attribute name
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
number
Description RADIUS attribute number
Type: number
Range: 1-255
prefix-length
Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;
Type: string
Supported Values: 32, 48, 64, 80, 96, 112
prefix-number
Description RADIUS attribute number
Type: number
Range: 1-255
prefix-vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
value
Description ‘hexadecimal’: Type of attribute value is hexadecimal;
Type: string
Supported Values: hexadecimal
vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
lsn_radius_server_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘msisdn-received’: MSISDN Received; ‘imei-received’: IMEI Received; ‘imsi-received’: IMSI Received; ‘custom-received’: Custom attribute Received; ‘radius-request-received’: RADIUS Request Received; ‘radius-request-dropped’: RADIUS Request Dropped (Malformed Packet); ‘request-bad-secret-dropped’: RADIUS Request Bad Secret Dropped; ‘request-no-key-vap-dropped’: RADIUS Request No Key Attribute Dropped; ‘request-malformed-dropped’: RADIUS Request Malformed Dropped; ‘request-ignored’: RADIUS Request Ignored; ‘radius-table-full’: RADIUS Request Dropped (Table Full); ‘secret-not-configured-dropped’: RADIUS Secret Not Configured Dropped; ‘ha-standby-dropped’: HA Standby Dropped; ‘ipv6-prefix-length-mismatch’: Framed IPV6 Prefix Length Mismatch; ‘invalid-key’: Radius Request has Invalid Key Field; ‘smp-created’: RADIUS SMP Created; ‘smp-deleted’: RADIUS SMP Deleted; ‘smp-mem-allocated’: RADIUS SMP Memory Allocated; ‘smp-mem-alloc-failed’: RADIUS SMP Memory Allocation Failed; ‘smp-mem-freed’: RADIUS SMP Memory Freed; ‘smp-in-rml’: RADIUS SMP in RML; ‘mem-allocated’: RADIUS Memory Allocated; ‘mem-alloc-failed’: RADIUS Memory Allocation Failed; ‘mem-freed’: RADIUS Memory Freed; ‘ha-sync-create-sent’: HA Record Sync Create Sent; ‘ha-sync-delete-sent’: HA Record Sync Delete Sent; ‘ha-sync-create-recv’: HA Record Sync Create Received; ‘ha-sync-delete-recv’: HA Record Sync Delete Received; ‘acct-on-filters-full’: RADIUS Acct On Request Ignored(Filters Full); ‘acct-on-dup-request’: Duplicate RADIUS Acct On Request; ‘ip-mismatch-delete’: Radius Entry IP Mismatch Delete; ‘ip-add-race-drop’: Radius Entry IP Add Race Drop; ‘ha-sync-no-key-vap-dropped’: HA Record Sync No key dropped; ‘inter-card-msg-fail-drop’: Inter-Card Message Fail Drop; ‘radius-packets-redirected’: RADIUS packets redirected (SO); ‘radius-packets-redirect-fail-dropped’: RADIUS packets dropped due to redirect failure (SO); ‘radius-packets-process-local’: RADIUS packets processed locally without redirection (SO); ‘radius-packets-dropped-not-lo’: RADIUS packets dropped dest not loopback (SO); ‘radius-inter-card-dup-redir’: RADIUS packet dropped as redirected by other blade (SO);
Type: string
Supported Values: all, msisdn-received, imei-received, imsi-received, custom-received, radius-request-received, radius-request-dropped, request-bad-secret-dropped, request-no-key-vap-dropped, request-malformed-dropped, request-ignored, radius-table-full, secret-not-configured-dropped, ha-standby-dropped, ipv6-prefix-length-mismatch, invalid-key, smp-created, smp-deleted, smp-mem-allocated, smp-mem-alloc-failed, smp-mem-freed, smp-in-rml, mem-allocated, mem-alloc-failed, mem-freed, ha-sync-create-sent, ha-sync-delete-sent, ha-sync-create-recv, ha-sync-delete-recv, acct-on-filters-full, acct-on-dup-request, ip-mismatch-delete, ip-add-race-drop, ha-sync-no-key-vap-dropped, inter-card-msg-fail-drop, radius-packets-redirected, radius-packets-redirect-fail-dropped, radius-packets-process-local, radius-packets-dropped-not-lo, radius-inter-card-dup-redir
lsn_stun-timeout¶
Specification
Value
Type
object
tcp-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn/stun-timeout/tcp/{port-start}+{port-end}
udp-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn/stun-timeout/udp/{port-start}+{port-end}
lsn_stun-timeout_tcp-list¶
Specification
Value
Type
list
Block object keys
port-end
Description Port Range (Port Range End)
Type: number
Range: 1-65535
port-start
Description Port Range (Port Range Start)
Type: number
Range: 1-65535
timeout
Description STUN timeout in minutes (default: 2 minutes)
Type: number
Range: 0-60
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_stun-timeout_udp-list¶
Specification
Value
Type
list
Block object keys
port-end
Description Port Range (Port Range End)
Type: number
Range: 1-65535
port-start
Description Port Range (Port Range Start)
Type: number
Range: 1-65535
timeout
Description STUN timeout in minutes (default: 2 minutes)
Type: number
Range: 0-60
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_tcp¶
Specification
Value
Type
object
mss-clamp
Description: mss-clamp is a JSON Block. Please see below for lsn_tcp_mss-clamp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/tcp/mss-clamp
reset-on-error
Description: reset-on-error is a JSON Block. Please see below for lsn_tcp_reset-on-error
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/tcp/reset-on-error
lsn_tcp_mss-clamp¶
Specification
Value
Type
object
min
Description Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: ((576 - 60 - 60))))
Type: number
Range: 0-1460
Default: 456
mss-clamp-type
Description ‘fixed’: Specify a fixed max value for the TCP MSS; ‘subtract’: Specify the value to subtract from the TCP MSS; ‘none’: No TCP MSS clamping (default);
Type: string
Supported Values: fixed, subtract, none
Default: none
mss-subtract
Description Specify the value to subtract from the TCP MSS (default: not configured)
Type: number
Range: 0-1460
mss-value
Description The max value allowed for the TCP MSS (default: not configured)},
Type: number
Range: 0-1460
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_tcp_reset-on-error¶
Specification
Value
Type
object
outbound
Description ‘disable’: Disable send TCP reset on error;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-overloading¶
Specification
Value
Type
object
global
Description: global is a JSON Block. Please see below for lsn_port-overloading_global
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-overloading/global
port-overloading-status
Description: port-overloading-status is a JSON Block. Please see below for lsn_port-overloading_port-overloading-status
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-overloading/port-overloading-status
tcp
Description: tcp is a JSON Block. Please see below for lsn_port-overloading_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-overloading/tcp
udp
Description: udp is a JSON Block. Please see below for lsn_port-overloading_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn/port-overloading/udp
lsn_port-overloading_port-overloading-status¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-overloading_global¶
Specification
Value
Type
object
allow-different-user
Description Allow different users to overload the same port (default: disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
unique
Description ‘destination-address’: Allow overloading when the destination addresses is unique; ‘destination-address-and-port’: Allow overloading when the destination address and port 2-tuple is unique (default);
Type: string
Supported Values: destination-address, destination-address-and-port
Default: destination-address-and-port
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-overloading_tcp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-overloading_tcp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_port-overloading_udp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_port-overloading_udp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
lsn_user-quota-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_enhanced-user-tracking¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_full-cone-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_data-sessions¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_all-sessions¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn_per-instance¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat¶
Specification
Value
Type
object
exclude-port
Description: exclude-port is a JSON Block. Please see below for nat_exclude-port
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/exclude-port
histogram
Description: histogram is a JSON Block. Please see below for nat_histogram
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/histogram
icmp
Description: icmp is a JSON Block. Please see below for nat_icmp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/icmp
icmpv6
Description: icmpv6 is a JSON Block. Please see below for nat_icmpv6
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/icmpv6
inside
Description: inside is a JSON Block. Please see below for nat_inside
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/inside
pool-group-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat/pool-group/{pool-group-name}
pool-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat/pool/{pool-name}
range-list-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat/range-list/{name}+{partition}
shared-pool
Description: shared-pool is a JSON Block. Please see below for nat_shared-pool
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/shared-pool
shared-pool-group
Description: shared-pool-group is a JSON Block. Please see below for nat_shared-pool-group
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/shared-pool-group
nat_exclude-port¶
Specification
Value
Type
object
tcp
Description: tcp is a JSON Block. Please see below for nat_exclude-port_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/exclude-port/tcp
udp
Description: udp is a JSON Block. Please see below for nat_exclude-port_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/exclude-port/udp
nat_exclude-port_tcp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_exclude-port_tcp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
nat_exclude-port_udp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_exclude-port_udp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
nat_histogram¶
Specification
Value
Type
object
bin-count
Description Number of bins in the histogram (default: 50)
Type: number
Range: 10-100
Default: 50
bin-skew
Description Percentage of bins that represent the upper bound (default: 75)
Type: number
Range: 50-80
Default: 75
data-skew
Description Percentage of data that represents the upper bound (default: 25)
Type: number
Range: 5-50
Default: 25
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_pool-list¶
Specification
Value
Type
list
Block object keys
all
Description Share with all partitions
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
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
per-batch-port-usage-warning-threshold
Description Configure warning log threshold for per batch port usage (default: disabled) (Number of ports)
Type: number
Range: 32-4096
pool-name
Description Specify pool name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-batch-v2-size
Description ‘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; ‘1024’: Allocate 1024 ports at a time; ‘2048’: Allocate 2048 ports at a time; ‘4096’: Allocate 4096 ports at a time;
Type: string
Supported Values: 64, 128, 256, 512, 1024, 2048, 4096
shared
Description Share this pool with other partitions (default: not shared)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
simultaneous-batch-allocation
Description Allocate same TCP and UDP batches at once
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
tcp-time-wait-interval
Description Minutes before TCP NAT ports can be reused
Type: number
Range: 0-10
usable-nat-ports
Description Configure usable NAT ports
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
usable-nat-ports-end
Description End Port of Usable NAT Ports
Type: number
Range: 1024-65535
usable-nat-ports-start
Description Start Port of Usable NAT Ports (needs to be even)
Type: number
Range: 1024-65535
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
nat_pool-list_exclude-ip¶
Specification
Value
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
nat_icmp¶
Specification
Value
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
nat_icmpv6¶
Specification
Value
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
nat_pool-group-list¶
Specification
Value
Type
list
Block object keys
member-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat/pool-group/{pool-group-name}/member/{pool-name}
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
nat_pool-group-list_member-list¶
Specification
Value
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
nat_inside¶
Specification
Value
Type
object
source
Description: source is a JSON Block. Please see below for nat_inside_source
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/inside/source
nat_inside_source¶
Specification
Value
Type
object
static-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat/inside/source/static/{src-address}+{partition}
statistics
Description: statistics is a JSON Block. Please see below for nat_inside_source_statistics
Type: Object
Reference Object: /axapi/v3/cgnv6/nat/inside/source/statistics
nat_inside_source_static-list¶
Specification
Value
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
nat_inside_source_statistics¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_range-list-list¶
Specification
Value
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
resource-usage¶
Specification
Value
Type
object
fixed-nat-inside-user-count
Description Total configurable CGNV6 Fixed NAT inside users
Type: number
fixed-nat-ip-addr-count
Description Total configurable CGNV6 Fixed NAT addresses
Type: number
lsn-nat-addr-count
Description Total configurable CGNV6 NAT Pool addresses
Type: number
radius-table-size
Description Total configurable CGNV6 RADIUS Table entries
Type: number
stateless-entries
Description: stateless-entries is a JSON Block. Please see below for resource-usage_stateless-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/resource-usage/stateless-entries
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-usage_stateless-entries¶
Specification
Value
Type
object
l4-session-count
Description Helper size for CGN Stateless Technologies
Type: number
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns64-virtualserver-list¶
Specification
Value
Type
list
Block object keys
enable-disable-action
Description ‘enable’: Enable Virtual Server (default); ‘disable’: Disable Virtual Server;
Type: string
Supported Values: enable, disable
Default: enable
ethernet
Description Ethernet interface
Type: number
Format: interface
ip-address
Description IP Address
Type: string
Format: ipv4-address
Mutual Exclusion: ip-address, ipv6-address, and use-if-ip are mutually exclusive
ipv6-address
Description IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address, ip-address, and use-if-ip are mutually exclusive
name
Description CGNV6 Virtual Server Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask-brief
policy
Description Policy template
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-list
Type: List
Reference Object: /axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol}
template-policy
Description Policy template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/template/policy
use-if-ip
Description Use Interface IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-if-ip, ipv6-address, and ip-address are mutually exclusive
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 Join a vrrp group (Specify ha VRRP-A vrid)
Type: number
Range: 1-31
dns64-virtualserver-list_port-list¶
Specification
Value
Type
list
Block object keys
acl-id-list
Type: List
acl-name-list
Type: List
action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: enable
auto
Description Configure auto NAT for the vport
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/cgnv6-dns64-vs-port-tmpl
pool
Description Specify NAT pool or pool group
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
port-number
Description Port
Type: number
Range: 0-65534
precedence
Description Set auto NAT pool as higher precedence for source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
protocol
Description ‘dns-udp’: DNS service over UDP;
Type: string
Supported Values: dns-udp
sampling-enable
Type: List
service-group
Description Bind a Service Group to this Virtual Server (Service Group Name)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/service-group
template-dns
Description DNS template (DNS template name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/template/dns
template-policy
Description Policy Template (Policy template name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/template/policy
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
dns64-virtualserver-list_port-list_acl-id-list¶
Specification
Value
Type
list
Block object keys
acl-id
Description ACL id VPORT
Type: number
Range: 1-199
acl-id-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-id-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
dns64-virtualserver-list_port-list_acl-name-list¶
Specification
Value
Type
list
Block object keys
acl-name
Description Apply an access list name (Named Access List)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
acl-name-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-name-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
dns64-virtualserver-list_port-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘curr_conn’: Current connection; ‘total_l4_conn’: Total L4 connections; ‘total_l7_conn’: Total L7 connections; ‘toatal_tcp_conn’: Total TCP connections; ‘total_conn’: Total connections; ‘total_fwd_bytes’: Total forward bytes; ‘total_fwd_pkts’: Total forward packets; ‘total_rev_bytes’: Total reverse bytes; ‘total_rev_pkts’: Total reverse packets; ‘total_dns_pkts’: Total DNS packets; ‘total_mf_dns_pkts’: Total MF DNS packets; ‘es_total_failure_actions’: Total failure actions; ‘compression_bytes_before’: Data into compression engine; ‘compression_bytes_after’: Data out of compression engine; ‘compression_hit’: Number of requests compressed; ‘compression_miss’: Number of requests NOT compressed; ‘compression_miss_no_client’: Compression miss no client; ‘compression_miss_template_exclusion’: Compression miss template exclusion; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total successful requests; ‘peak_conn’: Peak connections; ‘curr_conn_rate’: Current connection rate; ‘last_rsp_time’: Last response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time;
Type: string
Supported Values: all, curr_conn, total_l4_conn, total_l7_conn, toatal_tcp_conn, total_conn, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_dns_pkts, total_mf_dns_pkts, es_total_failure_actions, compression_bytes_before, compression_bytes_after, compression_hit, compression_miss, compression_miss_no_client, compression_miss_template_exclusion, curr_req, total_req, total_req_succ, peak_conn, curr_conn_rate, last_rsp_time, fastest_rsp_time, slowest_rsp_time
sctp¶
Specification
Value
Type
object
global
Description: global is a JSON Block. Please see below for sctp_global
Type: Object
Reference Object: /axapi/v3/cgnv6/sctp/global
permit-payload-protocol
Description: permit-payload-protocol is a JSON Block. Please see below for sctp_permit-payload-protocol
Type: Object
Reference Object: /axapi/v3/cgnv6/sctp/permit-payload-protocol
rate-limit
Description: rate-limit is a JSON Block. Please see below for sctp_rate-limit
Type: Object
Reference Object: /axapi/v3/cgnv6/sctp/rate-limit
rate-limit-entries
Description: rate-limit-entries is a JSON Block. Please see below for sctp_rate-limit-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/sctp/rate-limit-entries
sctp_permit-payload-protocol¶
Specification
Value
Type
object
protocol-id-list
Type: List
Reference Object: /axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-id/{id}
protocol-name-list
Type: List
Reference Object: /axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-name/{protocol}
sctp_permit-payload-protocol_protocol-name-list¶
Specification
Value
Type
list
Block object keys
protocol
Description ‘iua’: IUA; ‘m2ua’: M2UA; ‘m3ua’: M3UA; ‘sua’: SUA; ‘m2pa’: M2PA; ‘h.323’: H.323;
Type: string
Supported Values: iua, m2ua, m3ua, sua, m2pa, h.323
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sctp_permit-payload-protocol_protocol-id-list¶
Specification
Value
Type
list
Block object keys
id
Description Specify SCTP permitted payload protocol IDs
Type: number
Range: 1-63
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sctp_global¶
Specification
Value
Type
object
half-open-timeout
Description Set SCTP half-open timeout (SCTP half-open timeout in seconds (default 4))
Type: number
Range: 2-30
Default: 4
idle-timeout
Description SCTP idle timeout in minutes (default 5)
Type: number
Range: 1-63
Default: 5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sctp_rate-limit¶
Specification
Value
Type
object
destination-list
Type: List
Reference Object: /axapi/v3/cgnv6/sctp/rate-limit/destination/{ip}
source-list
Type: List
Reference Object: /axapi/v3/cgnv6/sctp/rate-limit/source/{ip}
sctp_rate-limit_source-list¶
Specification
Value
Type
list
Block object keys
ip
Description IP address
Type: string
Format: ipv4-address
rate-limit
Description Rate limit in packets per second
Type: number
Range: 1-2147483647
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sctp_rate-limit_destination-list¶
Specification
Value
Type
list
Block object keys
ip
Description IP address
Type: string
Format: ipv4-address
rate-limit
Description Rate limit in packets per second
Type: number
Range: 1-2147483647
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sctp_rate-limit-entries¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ecmp¶
Specification
Value
Type
object
hashing-type
Description ‘4-tuple-hash’: Hash on Src IP , Src Port, Dest IP and Dest Port;
Type: string
Supported Values: 4-tuple-hash
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port-list-list¶
Specification
Value
Type
list
Block object keys
name
Description Specify name of the port list
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-config
Type: List
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
port-list-list_port-config¶
Specification
Value
Type
list
Block object keys
original-port
Description Original port to be translated
Type: number
Range: 0-65535
translated-port
Description Port after translation
Type: number
Range: 0-65535
one-to-one¶
Specification
Value
Type
object
global
Description: global is a JSON Block. Please see below for one-to-one_global
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/global
mapping
Description: mapping is a JSON Block. Please see below for one-to-one_mapping
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/mapping
pool-group-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}
pool-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool/{pool-name}
shared-pool
Description: shared-pool is a JSON Block. Please see below for one-to-one_shared-pool
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/shared-pool
shared-pool-group
Description: shared-pool-group is a JSON Block. Please see below for one-to-one_shared-pool-group
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/shared-pool-group
one-to-one_global¶
Specification
Value
Type
object
mapping-timeout
Description Configure timeout for the one-to-one NAT mapping (Timeout in minutes (default: 10 minutes))
Type: number
Range: 0-180
Default: 10
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
one-to-one_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘total-map-allocated’: Total One-to-One Address Mapping Allocated; ‘total-map-freed’: Total One-to-One Address Mapping Freed; ‘map-alloc-failure’: One-to-One Address Mapping Allocation Failure; ‘map-dbl-free’: Address Mapping Double Free; ‘alloc-map-race’: Mapping Exists When Allocating Address Mapping; ‘map-not-found’: Mapping to be Released Not Found; ‘ha-map-mismatch’: HA Standby Mapping Mismatch; ‘ha-select-addr-failure’: HA Standby Allocate Address Failure; ‘ha-alloc-map-conflicts’: HA Standby Allocate Mapping Conflicts;
Type: string
Supported Values: all, total-map-allocated, total-map-freed, map-alloc-failure, map-dbl-free, alloc-map-race, map-not-found, ha-map-mismatch, ha-select-addr-failure, ha-alloc-map-conflicts
one-to-one_pool-list¶
Specification
Value
Type
list
Block object keys
end-address
Description Configure end IP address of NAT pool
Type: string
Format: ipv4-address
group
Description Share with a partition group (Partition Group Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
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
one-to-one_pool-group-list¶
Specification
Value
Type
list
Block object keys
member-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}/member/{pool-name}
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
one-to-one_pool-group-list_member-list¶
Specification
Value
Type
list
Block object keys
pool-name
Description Specify CGNv6 one-to-one 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
one-to-one_mapping¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn-rule-list-list¶
Specification
Value
Type
list
Block object keys
default
Description: default is a JSON Block. Please see below for lsn-rule-list-list_default
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}/default
domain-ip
Description: domain-ip is a JSON Block. Please see below for lsn-rule-list-list_domain-ip
Type: Object
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-ip
domain-list-name-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list}
domain-name-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-name/{name-domain}
http-match-domain-name
Description Enable match domain name in http request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-list
Type: List
Reference Object: /axapi/v3/cgnv6/lsn-rule-list/{name}/ip/{ipv4-addr}
name
Description LSN Rule-List 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
lsn-rule-list-list_domain-ip¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn-rule-list-list_domain-ip_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘placeholder’: some help string;
Type: string
Supported Values: all, placeholder
lsn-rule-list-list_default¶
Specification
Value
Type
object
rule-cfg
Type: List
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn-rule-list-list_default_rule-cfg¶
Specification
Value
Type
list
Block object keys
dscp-cfg
Description: dscp-cfg is a JSON Block. Please see below for lsn-rule-list-list_default_rule-cfg_dscp-cfg
Type: Object
icmp-others-cfg
Description: icmp-others-cfg is a JSON Block. Please see below for lsn-rule-list-list_default_rule-cfg_icmp-others-cfg
Type: Object
proto
Description ‘tcp’: TCP L4 Protocol; ‘udp’: UDP L4 Protocol; ‘icmp’: ICMP L4 Protocol; ‘others’: Other L4 Protocol; ‘dscp’: Match DSCP Value; ‘default’: Default Action;
Type: string
Supported Values: tcp, udp, icmp, others, dscp, default
tcp-cfg
Description: tcp-cfg is a JSON Block. Please see below for lsn-rule-list-list_default_rule-cfg_tcp-cfg
Type: Object
udp-cfg
Description: udp-cfg is a JSON Block. Please see below for lsn-rule-list-list_default_rule-cfg_udp-cfg
Type: Object
lsn-rule-list-list_default_rule-cfg_tcp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets; ‘template’: Template;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
http-alg
Description HTTP-ALG Template (Template Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_default_rule-cfg_udp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_default_rule-cfg_icmp-others-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_default_rule-cfg_dscp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action;
Type: string
Supported Values: action
action-type
Description ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-match
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘any’: Match any dscp value; ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
lsn-rule-list-list_default_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘placeholder’: some help string;
Type: string
Supported Values: all, placeholder
lsn-rule-list-list_domain-name-list¶
Specification
Value
Type
list
Block object keys
name-domain
Description Configure a Specific Rule-Set (Domain Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
rule-cfg
Type: List
sampling-enable
Type: List
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
lsn-rule-list-list_domain-name-list_rule-cfg¶
Specification
Value
Type
list
Block object keys
dscp-cfg
Description: dscp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-name-list_rule-cfg_dscp-cfg
Type: Object
icmp-others-cfg
Description: icmp-others-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-name-list_rule-cfg_icmp-others-cfg
Type: Object
proto
Description ‘tcp’: TCP L4 Protocol; ‘udp’: UDP L4 Protocol; ‘icmp’: ICMP L4 Protocol; ‘others’: Other L4 Protocol; ‘dscp’: Match DSCP Value; ‘default’: Default Action;
Type: string
Supported Values: tcp, udp, icmp, others, dscp, default
tcp-cfg
Description: tcp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-name-list_rule-cfg_tcp-cfg
Type: Object
udp-cfg
Description: udp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-name-list_rule-cfg_udp-cfg
Type: Object
lsn-rule-list-list_domain-name-list_rule-cfg_tcp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets; ‘template’: Template;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
http-alg
Description HTTP-ALG Template (Template Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-name-list_rule-cfg_udp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-name-list_rule-cfg_icmp-others-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-name-list_rule-cfg_dscp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action;
Type: string
Supported Values: action
action-type
Description ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-match
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘any’: Match any dscp value; ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
lsn-rule-list-list_domain-name-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘placeholder’: some help string;
Type: string
Supported Values: all, placeholder
lsn-rule-list-list_domain-list-name-list¶
Specification
Value
Type
list
Block object keys
name-domain-list
Description Configure a Specific Rule-Set (Domain List Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
rule-cfg
Type: List
sampling-enable
Type: List
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
lsn-rule-list-list_domain-list-name-list_rule-cfg¶
Specification
Value
Type
list
Block object keys
dscp-cfg
Description: dscp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-list-name-list_rule-cfg_dscp-cfg
Type: Object
icmp-others-cfg
Description: icmp-others-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-list-name-list_rule-cfg_icmp-others-cfg
Type: Object
proto
Description ‘tcp’: TCP L4 Protocol; ‘udp’: UDP L4 Protocol; ‘icmp’: ICMP L4 Protocol; ‘others’: Other L4 Protocol; ‘dscp’: Match DSCP Value; ‘default’: Default Action;
Type: string
Supported Values: tcp, udp, icmp, others, dscp, default
tcp-cfg
Description: tcp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-list-name-list_rule-cfg_tcp-cfg
Type: Object
udp-cfg
Description: udp-cfg is a JSON Block. Please see below for lsn-rule-list-list_domain-list-name-list_rule-cfg_udp-cfg
Type: Object
lsn-rule-list-list_domain-list-name-list_rule-cfg_tcp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets; ‘template’: Template;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
http-alg
Description HTTP-ALG Template (Template Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-list-name-list_rule-cfg_udp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-list-name-list_rule-cfg_icmp-others-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_domain-list-name-list_rule-cfg_dscp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action;
Type: string
Supported Values: action
action-type
Description ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-match
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘any’: Match any dscp value; ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
lsn-rule-list-list_domain-list-name-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘placeholder’: some help string;
Type: string
Supported Values: all, placeholder
lsn-rule-list-list_ip-list¶
Specification
Value
Type
list
Block object keys
ipv4-addr
Description Configure a Specific Rule-Set (IP Network Address)
Type: string
Format: ipv4-cidr
rule-cfg
Type: List
sampling-enable
Type: List
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
lsn-rule-list-list_ip-list_rule-cfg¶
Specification
Value
Type
list
Block object keys
dscp-cfg
Description: dscp-cfg is a JSON Block. Please see below for lsn-rule-list-list_ip-list_rule-cfg_dscp-cfg
Type: Object
icmp-others-cfg
Description: icmp-others-cfg is a JSON Block. Please see below for lsn-rule-list-list_ip-list_rule-cfg_icmp-others-cfg
Type: Object
proto
Description ‘tcp’: TCP L4 Protocol; ‘udp’: UDP L4 Protocol; ‘icmp’: ICMP L4 Protocol; ‘others’: Other L4 Protocol; ‘dscp’: Match DSCP Value; ‘default’: Default Action;
Type: string
Supported Values: tcp, udp, icmp, others, dscp, default
tcp-cfg
Description: tcp-cfg is a JSON Block. Please see below for lsn-rule-list-list_ip-list_rule-cfg_tcp-cfg
Type: Object
udp-cfg
Description: udp-cfg is a JSON Block. Please see below for lsn-rule-list-list_ip-list_rule-cfg_udp-cfg
Type: Object
lsn-rule-list-list_ip-list_rule-cfg_tcp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets; ‘template’: Template; ‘idle-timeout’: Configure idle timeout;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template, idle-timeout
domain
Description DNAT Using IP of a Domain (Domain Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: domain and ipv4-list are mutually exclusive
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
fast
Description ‘fast’: Fast Aging;
Type: string
Supported Values: fast
Mutual Exclusion: fast and timeout-val are mutually exclusive
http-alg
Description HTTP-ALG Template (Template Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: ipv4-list and domain are mutually exclusive
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
timeout-val
Description Timeout in seconds
Type: number
Range: 2-129600
Mutual Exclusion: timeout-val and fast are mutually exclusive
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_ip-list_rule-cfg_udp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets; ‘idle-timeout’: Configure idle timeout;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, idle-timeout
domain
Description DNAT Using IP of a Domain (Domain Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: domain and ipv4-list are mutually exclusive
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
end-port
Description End of Port Range (inclusive)
Type: number
Range: 1-65535
fast
Description ‘fast’: Fast Aging;
Type: string
Supported Values: fast
Mutual Exclusion: fast and timeout-val are mutually exclusive
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: ipv4-list and domain are mutually exclusive
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Description Port-List Name
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-port
Description Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port
Type: number
Range: 0-65535
timeout-val
Description Timeout in seconds
Type: number
Range: 2-129600
Mutual Exclusion: timeout-val and fast are mutually exclusive
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_ip-list_rule-cfg_icmp-others-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action; ‘no-action’: Exclude LSN Rule-List Action;
Type: string
Supported Values: action, no-action
action-type
Description ‘dnat’: Apply Dest NAT; ‘drop’: Drop the Packets; ‘one-to-one-snat’: Apply one-to-one source NAT for the packets; ‘pass-through’: Pass the Packets Through; ‘snat’: Redirect the Packets to a Different Source NAT Pool; ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: dnat, drop, one-to-one-snat, pass-through, snat, set-dscp
domain
Description DNAT Using IP of a Domain (Domain Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: domain and ipv4-list are mutually exclusive
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
ipv4-list
Description IP-List (IP-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: ipv4-list and domain are mutually exclusive
no-snat
Description Disable source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pool
Description NAT Pool (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description The pool is a shared pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vrid
Description VRRP-A vrid
Type: number
Range: 1-31
lsn-rule-list-list_ip-list_rule-cfg_dscp-cfg¶
Specification
Value
Type
object
action-cfg
Description ‘action’: LSN Rule-List Action;
Type: string
Supported Values: action
action-type
Description ‘set-dscp’: To set dscp value for the packets;
Type: string
Supported Values: set-dscp
dscp-direction
Description ‘inbound’: To set dscp value for inbound packets; ‘outbound’: To set dscp value for outbound packets;
Type: string
Supported Values: inbound, outbound
dscp-match
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘any’: Match any dscp value; ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
dscp-value
Description ‘default’: Default dscp (000000); ‘af11’: AF11 (001010); ‘af12’: AF12 (001100); ‘af13’: AF13 (001110); ‘af21’: AF21 (010010); ‘af22’: AF22 (010100); ‘af23’: AF23 (010110); ‘af31’: AF31 (011010); ‘af32’: AF32 (011100); ‘af33’: AF33 (011110); ‘af41’: AF41 (100010); ‘af42’: AF42 (100100); ‘af43’: AF43 (100110); ‘cs1’: CS1 (001000); ‘cs2’: CS2 (010000); ‘cs3’: CS3 (011000); ‘cs4’: CS4 (100000); ‘cs5’: CS5 (101000); ‘cs6’: CS6 (110000); ‘cs7’: CS7 (111000); ‘ef’: EF (101110); ‘0’: 000000; ‘1’: 000001; ‘2’: 000010; ‘3’: 000011; ‘4’: 000100; ‘5’: 000101; ‘6’: 000110; ‘7’: 000111; ‘8’: 001000; ‘9’: 001001; ‘10’: 001010; ‘11’: 001011; ‘12’: 001100; ‘13’: 001101; ‘14’: 001110; ‘15’: 001111; ‘16’: 010000; ‘17’: 010001; ‘18’: 010010; ‘19’: 010011; ‘20’: 010100; ‘21’: 010101; ‘22’: 010110; ‘23’: 010111; ‘24’: 011000; ‘25’: 011001; ‘26’: 011010; ‘27’: 011011; ‘28’: 011100; ‘29’: 011101; ‘30’: 011110; ‘31’: 011111; ‘32’: 100000; ‘33’: 100001; ‘34’: 100010; ‘35’: 100011; ‘36’: 100100; ‘37’: 100101; ‘38’: 100110; ‘39’: 100111; ‘40’: 101000; ‘41’: 101001; ‘42’: 101010; ‘43’: 101011; ‘44’: 101100; ‘45’: 101101; ‘46’: 101110; ‘47’: 101111; ‘48’: 110000; ‘49’: 110001; ‘50’: 110010; ‘51’: 110011; ‘52’: 110100; ‘53’: 110101; ‘54’: 110110; ‘55’: 110111; ‘56’: 111000; ‘57’: 111001; ‘58’: 111010; ‘59’: 111011; ‘60’: 111100; ‘61’: 111101; ‘62’: 111110; ‘63’: 111111;
Type: string
Supported Values: default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63
lsn-rule-list-list_ip-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘placeholder’: some help string;
Type: string
Supported Values: all, placeholder
lsn-lid-list¶
Specification
Value
Type
list
Block object keys
conn-rate-limit
Description: conn-rate-limit is a JSON Block. Please see below for lsn-lid-list_conn-rate-limit
Type: Object
ds-lite
Description: ds-lite is a JSON Block. Please see below for lsn-lid-list_ds-lite
Type: Object
extended-user-quota
Description: extended-user-quota is a JSON Block. Please see below for lsn-lid-list_extended-user-quota
Type: Object
lid-number
Description LSN Lid
Type: number
Range: 1-1023
lsn-rule-list
Description: lsn-rule-list is a JSON Block. Please see below for lsn-lid-list_lsn-rule-list
Type: Object
name
Description LSN Lid Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
override
Description ‘none’: Apply source NAT if configured (default); ‘drop’: Drop packets that match this LSN lid; ‘pass-through’: Layer-3 route packets that match this LSN lid and do not apply source NAT;
Type: string
Supported Values: none, drop, pass-through
Default: none
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
source-nat-pool
Description: source-nat-pool is a JSON Block. Please see below for lsn-lid-list_source-nat-pool
Type: Object
user-quota
Description: user-quota is a JSON Block. Please see below for lsn-lid-list_user-quota
Type: Object
user-quota-prefix-length
Description NAT64/DS-Lite user quota prefix length (Prefix Length (Default: Uses the global NAT64/DS-Lite configured value))
Type: number
Range: 1-128
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
lsn-lid-list_ds-lite¶
Specification
Value
Type
object
inside-src-permit-list
Description Class-List of IPv4 addresses permitted (Class-list to match for DS-Lite)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
lsn-lid-list_lsn-rule-list¶
Specification
Value
Type
object
destination
Description Apply LSN Rule-List on Destination (LSN Rule-List Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/lsn-rule-list
lsn-lid-list_source-nat-pool¶
Specification
Value
Type
object
pool-name
Description Source NAT Pool or Pool-Group
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description Use a shared source NAT pool or pool-group
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lsn-lid-list_extended-user-quota¶
Specification
Value
Type
object
tcp
Type: List
udp
Type: List
lsn-lid-list_extended-user-quota_tcp¶
Specification
Value
Type
list
Block object keys
tcp-service-port
Description Port (Port Value)
Type: number
Range: 1-65535
tcp-sessions
Description Number of Extended Quota sessions allowed for this service
Type: number
Range: 1-255
lsn-lid-list_extended-user-quota_udp¶
Specification
Value
Type
list
Block object keys
udp-service-port
Description Port (Port Value)
Type: number
Range: 1-65535
udp-sessions
Description Number of Extended Quota sessions allowed for this service
Type: number
Range: 1-255
lsn-lid-list_conn-rate-limit¶
Specification
Value
Type
object
conn-rate-limit-val
Description Maximum connections per second (Default: No limit)
Type: number
Range: 1-65535
lsn-lid-list_user-quota¶
Specification
Value
Type
object
icmp
Description User Quota for ICMP identifiers (NAT port quota per user (default: not configured))
Type: number
Range: 1-64000
quota-tcp
Description: quota-tcp is a JSON Block. Please see below for lsn-lid-list_user-quota_quota-tcp
Type: Object
quota-udp
Description: quota-udp is a JSON Block. Please see below for lsn-lid-list_user-quota_quota-udp
Type: Object
session
Description User Quota for number of data sessions
Type: number
Range: 1-2147483647
lsn-lid-list_user-quota_quota-udp¶
Specification
Value
Type
object
udp-quota
Description NAT port quota per user (default: not configured)
Type: number
Range: 1-64000
udp-reserve
Description Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))
Type: number
Range: 0-64000
lsn-lid-list_user-quota_quota-tcp¶
Specification
Value
Type
object
tcp-quota
Description NAT port quota per user (default: not configured)
Type: number
Range: 1-64000
tcp-reserve
Description Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value))
Type: number
Range: 0-64000
lsn-radius-profile-list¶
Specification
Value
Type
list
Block object keys
lid-profile-index
Description LSN RADIUS Profile Index
Type: number
Range: 1-16
radius
Type: List
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
lsn-radius-profile-list_radius¶
Specification
Value
Type
list
Block object keys
attribute
Description ‘custom1’: Configure RADIUS Attribute Custom 1; ‘custom2’: Configure RADIUS Attribute Custom 2; ‘custom3’: Configure RADIUS Attribute Custom 3; ‘custom4’: Configure RADIUS Attribute Custom 4; ‘custom5’: Configure RADIUS Attribute Custom 5; ‘custom6’: Configure RADIUS Attribute Custom 6; ‘imei’: Configure RADIUS Attribute IMEI; ‘imsi’: Configure RADIUS Attribute IMSI; ‘msisdn’: Configure RADIUS Attribute MSISDN; ‘default’: Configure default;
Type: string
Supported Values: custom1, custom2, custom3, custom4, custom5, custom6, imei, imsi, msisdn, default
default-lsn-lid
Description LSN Limit ID (LID index)
Type: number
Range: 1-1023
exact-value
Description Value of the attribute
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
exact-value-lsn-lid
Description LSN Limit ID (LID index)
Type: number
Range: 1-1023
starts-with
Description Value of the attribute
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
starts-with-lsn-lid
Description LSN Limit ID (LID index)
Type: number
Range: 1-1023
nat64¶
Specification
Value
Type
object
alg
Description: alg is a JSON Block. Please see below for nat64_alg
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg
enhanced-user-tracking
Description: enhanced-user-tracking is a JSON Block. Please see below for nat64_enhanced-user-tracking
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/enhanced-user-tracking
fragmentation
Description: fragmentation is a JSON Block. Please see below for nat64_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/fragmentation
full-cone-session
Description: full-cone-session is a JSON Block. Please see below for nat64_full-cone-session
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/full-cone-session
global
Description: global is a JSON Block. Please see below for nat64_global
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/global
prefix-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat64/prefix/{prefix-val}
user-quota-session
Description: user-quota-session is a JSON Block. Please see below for nat64_user-quota-session
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/user-quota-session
nat64_global¶
Specification
Value
Type
object
all
Description All packet sizes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
force-non-zero-ipv4-id
Description Enable non-zero ID field in IPv4 header if no IPv6 fragment & IPv4 pkt size is more than 88 & less than or equal to 1280 bytes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
icmp
Description: icmp is a JSON Block. Please see below for nat64_global_icmp
Type: Object
inside
Description: inside is a JSON Block. Please see below for nat64_global_inside
Type: Object
sampling-enable
Type: List
tcp
Description: tcp is a JSON Block. Please see below for nat64_global_tcp
Type: Object
user-quota-prefix-length
Description User Quota Prefix Length (Default: 128)
Type: number
Range: 1-128
Default: 128
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_global_tcp¶
Specification
Value
Type
object
mss-clamp
Description: mss-clamp is a JSON Block. Please see below for nat64_global_tcp_mss-clamp
Type: Object
reset-on-error
Description: reset-on-error is a JSON Block. Please see below for nat64_global_tcp_reset-on-error
Type: Object
nat64_global_tcp_mss-clamp¶
Specification
Value
Type
object
min
Description Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 476))
Type: number
Range: 0-1420
Default: 476
mss-clamp-type
Description ‘fixed’: Specify a fixed max value for the TCP MSS; ‘none’: No TCP MSS clamping; ‘subtract’: Specify the value to subtract from the TCP MSS (default: 20);
Type: string
Supported Values: fixed, none, subtract
Default: subtract
mss-subtract
Description Specify the value to subtract from the TCP MSS (default: 20)
Type: number
Range: 0-1420
Default: 20
mss-value
Description The max value allowed for the TCP MSS (default: not configured)
Type: number
Range: 0-1420
nat64_global_tcp_reset-on-error¶
Specification
Value
Type
object
outbound
Description ‘disable’: Disable send TCP reset on error;
Type: string
Supported Values: disable
nat64_global_inside¶
Specification
Value
Type
object
source
Description: source is a JSON Block. Please see below for nat64_global_inside_source
Type: Object
nat64_global_inside_source¶
Specification
Value
Type
object
class-list
Description Class-list to match for NAT64
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
nat64_global_icmp¶
Specification
Value
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
nat64_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘total_tcp_allocated’: Total TCP Ports Allocated; ‘total_tcp_freed’: Total TCP Ports Freed; ‘total_udp_allocated’: Total UDP Ports Allocated; ‘total_udp_freed’: Total UDP Ports Freed; ‘total_icmp_allocated’: Total ICMP Ports Allocated; ‘total_icmp_freed’: Total ICMP Ports Freed; ‘data_session_created’: Data Session Created; ‘data_session_freed’: Data Session Freed; ‘user_quota_created’: User-Quota Created; ‘user_quota_put_in_del_q’: User-Quota Freed; ‘user_quota_failure’: User-Quota Creation Failed; ‘nat_port_unavailable_tcp’: TCP NAT Port Unavailable; ‘nat_port_unavailable_udp’: UDP NAT Port Unavailable; ‘nat_port_unavailable_icmp’: ICMP NAT Port Unavailable; ‘new_user_resource_unavailable’: New User NAT Resource Unavailable; ‘tcp_user_quota_exceeded’: TCP User-Quota Exceeded; ‘udp_user_quota_exceeded’: UDP User-Quota Exceeded; ‘icmp_user_quota_exceeded’: ICMP User-Quota Exceeded; ‘extended_quota_matched’: Extended User-Quota Matched; ‘extended_quota_exceeded’: Extended User-Quota Exceeded; ‘data_sesn_user_quota_exceeded’: Data Session User-Quota Exceeded; ‘data_sesn_rate_user_quota_exceeded’: Conn Rate User-Quota Exceeded; ‘tcp_fullcone_created’: TCP Full-cone Session Created; ‘tcp_fullcone_freed’: TCP Full-cone Session Freed; ‘udp_fullcone_created’: UDP Full-cone Session Created; ‘udp_fullcone_freed’: UDP Full-cone Session Freed; ‘fullcone_failure’: Full-cone Session Creation Failed; ‘hairpin’: Hairpin Session Created; ‘fullcone_self_hairpinning_drop’: Self-Hairpinning Drop; ‘endpoint_indep_map_match’: Endpoint-Independent Mapping Matched; ‘endpoint_indep_filter_match’: Endpoint-Independent Filtering Matched; ‘inbound_filtered’: Endpoint-Dependent Filtering Drop; ‘eif_limit_exceeded’: Endpoint-Independent Filtering Inbound Limit Exceeded; ‘total_tcp_overloaded’: TCP Port Overloaded; ‘total_udp_overloaded’: UDP Port Overloaded; ‘port_overloading_smp_inserted_tcp’: TCP Port Overloading Session Created; ‘port_overloading_smp_inserted_udp’: UDP Port Overloading Session Created; ‘port_overloading_smp_free_tcp’: TCP Port Overloading Session Freed; ‘port_overloading_smp_free_udp’: UDP Port Overloading Session Freed; ‘nat_pool_unusable’: NAT Pool Unusable; ‘ha_nat_pool_unusable’: HA NAT Pool Unusable; ‘ha_nat_pool_batch_type_mismatch’: HA NAT Pool Batch Type Mismatch; ‘no_radius_profile_match’: No RADIUS Profile Match; ‘l3’: Layer 3 Forwarded Packets; ‘source_matches_prefix’: Source Address Prefix Match Drop; ‘lid_drop’: LSN LID Drop; ‘lid_pass_through’: LSN LID Pass-through; ‘no_class_list_match’: No Class-List Match; ‘user_quota_mem_allocated’: User-Quota Memory Allocated; ‘user_quota_mem_freed’: User-Quota Memory Freed; ‘user_quota_created_shadow’: Total User-Quota Created; ‘quota_marked_deleted’: User-Quota Marked Deleted; ‘quota_delete_not_in_bucket’: User-Quota Delete Not In Bucket; ‘user_quota_put_in_del_q_shadow’: Total User-Quota Put In Del Q; ‘prefix_quota_created’: Total Prefix Quota Created; ‘prefix_quota_put_in_del_q’: Total Prefix Quota Freed; ‘prefix_quota_failure’: Total Prefix Quota Failure; ‘total_user_quota_created’: Total Quota Structure Created; ‘total_user_quota_put_in_del_q’: Total Quota Structure Freed; ‘total_user_quota_failure’: Total Quota Structure Failure; ‘tcp_out_of_state_rst_sent’: Total Out of State TCP RST sent; ‘tcp_out_of_state_rst_dropped’: Total Out of State TCP RST dropped; ‘icmp_out_of_state_uqe_admin_filtered_sent’: Total User Quota Exceeded ICMP admin filtered sent; ‘icmp_out_of_state_uqe_host_unreachable_sent’: Total User Quota Exceeded ICMP host unreachable sent; ‘icmp_out_of_state_uqe_dropped’: Total User Queue Exceeded ICMP notification dropped; ‘user_quota_not_found’: User-Quota Not Found; ‘tcp_fullcone_created_shadow’: Total TCP Full-cone sessions created; ‘tcp_fullcone_freed_shadow’: Total TCP Full-cone sessions freed; ‘udp_fullcone_created_shadow’: Total UDP Full-cone sessions created; ‘udp_fullcone_freed_shadow’: Total UDP Full-cone sessions freed; ‘udp_alg_fullcone_created’: Total UDP ALG Full-cone sessions created; ‘udp_alg_fullcone_freed’: Total UDP ALG Full-cone sessions freed; ‘fullcone_created’: Total Full-cone sessions created; ‘fullcone_freed’: Total Full-cone sessions freed; ‘data_session_created_shadow’: Total Data Sessions Created; ‘data_session_freed_shadow’: Total Data Sessions Freed; ‘data_session_user_quota_mismatch’: Data Session Counter Per User Mismatch; ‘extended_quota_mismatched’: Extended User-Quota Mismatched; ‘nat_port_unavailable_other’: Other NAT Port Unavailable; ‘nat_port_unavailable’: Total NAT Port Unavailable; ‘new_user_resource_unavailable_tcp’: TCP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_udp’: UDP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_icmp’: ICMP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_other’: Other New User NAT Resource Unavailable; ‘total_tcp_allocated_shadow’: Total TCP Ports Allocated; ‘total_tcp_freed_shadow’: Total TCP Ports Freed; ‘total_udp_allocated_shadow’: Total UDP Ports Allocated; ‘total_udp_freed_shadow’: Total UDP Ports Freed; ‘total_icmp_allocated_shadow’: Total ICMP Ports Allocated; ‘total_icmp_freed_shadow’: Total ICMP Ports Freed; ‘udp_alg_no_quota’: UDP ALG User-Quota Not Found; ‘udp_alg_eim_mismatch’: UDP ALG Endpoint-Independent Mapping Mismatch; ‘udp_alg_no_nat_ip’: UDP ALG User-Quota Unknown NAT IP; ‘udp_alg_alloc_failure’: UDP ALG Port Allocation Failure; ‘sip_alg_no_quota’: SIP ALG User-Quota Not Found; ‘sip_alg_quota_inc_failure’: SIP ALG User-Quota Exceeded; ‘sip_alg_no_nat_ip’: SIP ALG Unknown NAT IP; ‘sip_alg_reuse_contact_fullcone’: SIP ALG Reuse Contact Full-cone Session; ‘sip_alg_contact_fullcone_mismatch’: SIP ALG Contact Full-cone Session Mismatch; ‘sip_alg_alloc_contact_port_failure’: SIP ALG Alloc Contact NAT Port Failure; ‘sip_alg_create_contact_fullcone_failure’: SIP ALG Create Contact Full-cone Session Failure; ‘sip_alg_release_contact_port_failure’: SIP ALG Release Contact NAT Port Failure; ‘sip_alg_single_rtp_fullcone’: SIP ALG Single RTP Full-cone Found; ‘sip_alg_single_rtcp_fullcone’: SIP ALG Single RTCP Full-cone Found; ‘sip_alg_rtcp_fullcone_mismatch’: SIP ALG RTCP Full-cone NAT Port Mismatch; ‘sip_alg_reuse_rtp_rtcp_fullcone’: SIP ALG Reuse RTP/RTCP Full-cone Session; ‘sip_alg_alloc_rtp_rtcp_port_failure’: SIP ALG Alloc RTP/RTCP NAT Ports Failure; ‘sip_alg_alloc_single_port_failure’: SIP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘sip_alg_create_single_fullcone_failure’: SIP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘sip_alg_create_rtp_fullcone_failure’: SIP ALG Create RTP Full-cone Session Failure; ‘sip_alg_create_rtcp_fullcone_failure’: SIP ALG Create RTCP Full-cone Session Failure; ‘sip_alg_port_pair_alloc_from_consecutive’: SIP ALG Port Pair Allocated From Consecutive; ‘sip_alg_port_pair_alloc_from_partition’: SIP ALG Port Pair Allocated From Partition; ‘sip_alg_port_pair_alloc_from_pool_port_batch’: SIP ALG Port Pair Allocated From Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_consecutive’: SIP ALG Port Pair Allocated From Quota Consecutive; ‘sip_alg_port_pair_alloc_from_quota_partition’: SIP ALG Port Pair Allocated From Quota Partition; ‘sip_alg_port_pair_alloc_from_quota_partition_error’: SIP ALG Port Pair Allocated From Quota Partition Error; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch’: SIP ALG Port Pair Allocated From Quota Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag’: SIP ALG Port Pair Allocated From Quota Port Batch Version 2 with Frag Free Ports;
Type: string
Supported Values: all, total_tcp_allocated, total_tcp_freed, total_udp_allocated, total_udp_freed, total_icmp_allocated, total_icmp_freed, data_session_created, data_session_freed, user_quota_created, user_quota_put_in_del_q, user_quota_failure, nat_port_unavailable_tcp, nat_port_unavailable_udp, nat_port_unavailable_icmp, new_user_resource_unavailable, tcp_user_quota_exceeded, udp_user_quota_exceeded, icmp_user_quota_exceeded, extended_quota_matched, extended_quota_exceeded, data_sesn_user_quota_exceeded, data_sesn_rate_user_quota_exceeded, tcp_fullcone_created, tcp_fullcone_freed, udp_fullcone_created, udp_fullcone_freed, fullcone_failure, hairpin, fullcone_self_hairpinning_drop, endpoint_indep_map_match, endpoint_indep_filter_match, inbound_filtered, eif_limit_exceeded, total_tcp_overloaded, total_udp_overloaded, port_overloading_smp_inserted_tcp, port_overloading_smp_inserted_udp, port_overloading_smp_free_tcp, port_overloading_smp_free_udp, nat_pool_unusable, ha_nat_pool_unusable, ha_nat_pool_batch_type_mismatch, no_radius_profile_match, l3, source_matches_prefix, lid_drop, lid_pass_through, no_class_list_match, user_quota_mem_allocated, user_quota_mem_freed, user_quota_created_shadow, quota_marked_deleted, quota_delete_not_in_bucket, user_quota_put_in_del_q_shadow, prefix_quota_created, prefix_quota_put_in_del_q, prefix_quota_failure, total_user_quota_created, total_user_quota_put_in_del_q, total_user_quota_failure, tcp_out_of_state_rst_sent, tcp_out_of_state_rst_dropped, icmp_out_of_state_uqe_admin_filtered_sent, icmp_out_of_state_uqe_host_unreachable_sent, icmp_out_of_state_uqe_dropped, user_quota_not_found, tcp_fullcone_created_shadow, tcp_fullcone_freed_shadow, udp_fullcone_created_shadow, udp_fullcone_freed_shadow, udp_alg_fullcone_created, udp_alg_fullcone_freed, fullcone_created, fullcone_freed, data_session_created_shadow, data_session_freed_shadow, data_session_user_quota_mismatch, extended_quota_mismatched, nat_port_unavailable_other, nat_port_unavailable, new_user_resource_unavailable_tcp, new_user_resource_unavailable_udp, new_user_resource_unavailable_icmp, new_user_resource_unavailable_other, total_tcp_allocated_shadow, total_tcp_freed_shadow, total_udp_allocated_shadow, total_udp_freed_shadow, total_icmp_allocated_shadow, total_icmp_freed_shadow, udp_alg_no_quota, udp_alg_eim_mismatch, udp_alg_no_nat_ip, udp_alg_alloc_failure, sip_alg_no_quota, sip_alg_quota_inc_failure, sip_alg_no_nat_ip, sip_alg_reuse_contact_fullcone, sip_alg_contact_fullcone_mismatch, sip_alg_alloc_contact_port_failure, sip_alg_create_contact_fullcone_failure, sip_alg_release_contact_port_failure, sip_alg_single_rtp_fullcone, sip_alg_single_rtcp_fullcone, sip_alg_rtcp_fullcone_mismatch, sip_alg_reuse_rtp_rtcp_fullcone, sip_alg_alloc_rtp_rtcp_port_failure, sip_alg_alloc_single_port_failure, sip_alg_create_single_fullcone_failure, sip_alg_create_rtp_fullcone_failure, sip_alg_create_rtcp_fullcone_failure, sip_alg_port_pair_alloc_from_consecutive, sip_alg_port_pair_alloc_from_partition, sip_alg_port_pair_alloc_from_pool_port_batch, sip_alg_port_pair_alloc_from_quota_consecutive, sip_alg_port_pair_alloc_from_quota_partition, sip_alg_port_pair_alloc_from_quota_partition_error, sip_alg_port_pair_alloc_from_quota_pool_port_batch, sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag
counters2
Description ‘h323_alg_no_quota’: H323 ALG User-Quota Not Found; ‘h323_alg_quota_inc_failure’: H323 ALG User-Quota Exceeded; ‘h323_alg_no_nat_ip’: H323 ALG Unknown NAT IP; ‘h323_alg_reuse_fullcone’: H323 ALG Reuse Full-cone Session; ‘h323_alg_fullcone_mismatch’: H323 ALG Full-cone Session Mismatch; ‘h323_alg_alloc_port_failure’: H323 ALG Alloc NAT Port Failure; ‘h323_alg_create_fullcone_failure’: H323 ALG Create Full-cone Session Failure; ‘h323_alg_release_port_failure’: H323 ALG Release NAT Port Failure; ‘h323_alg_single_rtp_fullcone’: H323 ALG Single RTP Full-cone Found; ‘h323_alg_single_rtcp_fullcone’: H323 ALG Single RTCP Full-cone Found; ‘h323_alg_rtcp_fullcone_mismatch’: H323 ALG RTCP Full-cone NAT Port Mismatch; ‘h323_alg_reuse_rtp_rtcp_fullcone’: H323 ALG Reuse RTP/RTCP Full-cone Session; ‘h323_alg_alloc_rtp_rtcp_port_failure’: H323 ALG Alloc RTP/RTCP NAT Ports Failure; ‘h323_alg_alloc_single_port_failure’: H323 ALG Alloc Single RTP or RTCP NAT Port Failure; ‘h323_alg_create_single_fullcone_failure’: H323 ALG Create Single RTP or RTCP Full-cone Session Failure; ‘h323_alg_create_rtp_fullcone_failure’: H323 ALG Create RTP Full-cone Session Failure; ‘h323_alg_create_rtcp_fullcone_failure’: H323 ALG Create RTCP Full-cone Session Failure; ‘h323_alg_port_pair_alloc_from_consecutive’: H323 ALG Port Pair Allocated From Consecutive; ‘h323_alg_port_pair_alloc_from_partition’: H323 ALG Port Pair Allocated From Partition; ‘h323_alg_port_pair_alloc_from_pool_port_batch’: H323 ALG Port Pair Allocated From Pool Port Batch; ‘h323_alg_port_pair_alloc_from_quota_consecutive’: H323 ALG Port Pair Allocated From Quota Consecutive; ‘h323_alg_port_pair_alloc_from_quota_partition’: H323 ALG Port Pair Allocated From Quota Partition; ‘h323_alg_port_pair_alloc_from_quota_partition_error’: H323 ALG Port Pair Allocated From Quota Partition Error; ‘h323_alg_port_pair_alloc_from_quota_pool_port_batch’: H323 ALG Port Pair Allocated From Quota Pool Port Batch; ‘port_batch_quota_extension_alloc_failure’: Port Batch Extension Alloc Failure (No memory); ‘port_batch_free_quota_not_found’: Port Batch Quota Not Found on Free; ‘port_batch_free_port_not_found’: Port Batch Port Not Found on Free; ‘port_batch_free_wrong_partition’: Port Batch Free Wrong Partition; ‘radius_query_quota_ext_alloc_failure’: RADIUS Query Container Alloc (No Memoty); ‘radius_query_quota_ext_alloc_race_free’: RADIUS Query Container Alloc Race Free; ‘quota_extension_added’: Quota Extension Added to Quota; ‘quota_extension_removed’: Quota Extension Removed from Quota; ‘quota_extension_remove_not_found’: Quota Extension Not Found on Remove; ‘ha_sync_port_batch_sent’: HA Port Batch Extension Sync Sent; ‘ha_sync_port_batch_rcv’: HA Port Batch Extension Sync Received; ‘ha_send_port_batch_not_found’: HA Port Batch Not Found on Sync Send; ‘ha_rcv_port_not_in_port_batch’: HA Port Not in Port Batch on Sync Rcv; ‘bad_port_to_free’: Freeing Bad Port; ‘consecutive_port_free’: Port Freed from Consecutive Pool; ‘partition_port_free’: Port Freed from Partition; ‘pool_port_batch_port_free’: Port Freed from Pool Port Batch; ‘port_allocated_from_quota_consecutive’: Port Allocated from Quota Consecutive; ‘port_allocated_from_quota_partition’: Port Allocated from Quota Partition; ‘port_allocated_from_quota_pool_port_batch’: Port Allocated from Quota Pool Port Batch; ‘port_freed_from_quota_consecutive’: Port Freed from Quota Consecutive; ‘port_freed_from_quota_partition’: Port Freed from Quota Partition; ‘port_freed_from_quota_pool_port_batch’: Port Freed from Quota Pool Port Batch; ‘port_batch_allocated_to_quota’: Port Batch Allocated to Quota; ‘port_batch_freed_from_quota’: Port Batch Freed From Quota; ‘specific_port_allocated_from_quota_consecutive’: Specific Port Allocated from Quota Consecutive; ‘specific_port_allocated_from_quota_partition’: Specific Port Allocated from Quota Partition; ‘specific_port_allocated_from_quota_pool_port_batch’: Specific Port Allocated from Quota Pool Port Batch; ‘port_batch_container_alloc_failure’: Port Batch Container Alloc Out of Memory; ‘port_batch_container_alloc_race_free’: Port Batch Container Race Free; ‘port_overloading_destination_conflict’: Port Overloading Destination Conflict; ‘port_overloading_out_of_memory’: Port Overloading Out of Memory; ‘port_overloading_assign_user’: Port Overloading Port Assign User; ‘port_overloading_assign_user_port_batch’: Port Overloading Port Assign User Port Batch; ‘port_overloading_inc’: Port Overloading Port Increment; ‘port_overloading_dec_on_conflict’: Port Overloading Port Decrement on Conflict; ‘port_overloading_dec_on_free’: Port Overloading Port Decrement on Free; ‘port_overloading_free_port_on_conflict’: Port Overloading Free Port on Conflict; ‘port_overloading_free_port_batch_on_conflict’: Port Overloading Free Port Batch on Conflict; ‘port_overloading_inc_overflow’: Port Overloading Inc Overflow; ‘port_overloading_attempt_consecutive_ports’: Port Overloading on Consecutive Ports; ‘port_overloading_attempt_same_partition’: Port Overloading on Same Partition; ‘port_overloading_attempt_diff_partition’: Port Overloading on Different Partition; ‘port_overloading_attempt_failed’: Port Overloading Attempt Failed; ‘port_overloading_conn_free_retry_lookup’: Port Overloading Conn Free Retry Lookup; ‘port_overloading_conn_free_not_found’: Port Overloading Conn Free Not Found; ‘port_overloading_smp_mem_allocated’: Port Overloading SMP Session Allocated; ‘port_overloading_smp_mem_freed’: Port Overloading SMP Session Freed; ‘port_overloading_smp_inserted’: Port Overloading SMP Inserted; ‘port_overloading_smp_inserted_tcp_shadow’: Total Port Overloading SMP TCP Inserted; ‘port_overloading_smp_inserted_udp_shadow’: Total Port Overloading SMP UDP Inserted; ‘port_overloading_smp_free_tcp_shadow’: Total Port Overloading SMP TCP Freed; ‘port_overloading_smp_free_udp_shadow’: Total Port Overloading SMP UDP Freed; ‘port_overloading_smp_put_in_del_q_from_conn’: Port Overloading SMP Free From Conn; ‘port_overloading_smp_free_dec_failure’: Port Overloading SMP Free Dec Failure; ‘port_overloading_smp_free_no_quota’: Port Overloading SMP Free No Quota; ‘port_overloading_smp_free_port’: Port Overloading SMP Free Port; ‘port_overloading_smp_free_port_from_quota’: Port Overloading SMP Free Port From Quota; ‘port_overloading_for_no_ports’: Port Overloading for No Ports; ‘port_overloading_for_no_ports_success’: Port Overloading for No Ports Success; ‘port_overloading_for_quota_exceeded’: Port Overloading for Quota Exceeded; ‘port_overloading_for_quota_exceeded_success’: Port Overloading for Quota Exceeded Success; ‘port_overloading_for_quota_exceeded_race’: Port Overloading for Quota Exceeded Race; ‘port_overloading_for_quota_exceeded_race_success’: Port Overloading for Quota Exceeded Race Success; ‘port_overloading_for_new_user’: Port Overloading for New User; ‘port_overloading_for_new_user_success’: Port Overloading for New User Success; ‘ha_port_overloading_attempt_failed’: HA Port Overloading Attempt Failed; ‘ha_port_overloading_for_no_ports’: HA Port Overloading for No Ports; ‘ha_port_overloading_for_no_ports_success’: HA Port Overloading for No Ports Success; ‘ha_port_overloading_for_quota_exceeded’: HA Port Overloading for Quota Exceeded; ‘ha_port_overloading_for_quota_exceeded_success’: HA Port Overloading for Quota Exceeded Success; ‘ha_port_overloading_for_quota_exceeded_race’: HA Port Overloading for Quota Exceeded Race; ‘ha_port_overloading_for_quota_exceeded_race_success’: HA Port Overloading for Quota Exceeded Race Success; ‘ha_port_overloading_for_new_user’: HA Port Overloading for New User; ‘ha_port_overloading_for_new_user_success’: HA Port Overloading for New User Success;
Type: string
Supported Values: h323_alg_no_quota, h323_alg_quota_inc_failure, h323_alg_no_nat_ip, h323_alg_reuse_fullcone, h323_alg_fullcone_mismatch, h323_alg_alloc_port_failure, h323_alg_create_fullcone_failure, h323_alg_release_port_failure, h323_alg_single_rtp_fullcone, h323_alg_single_rtcp_fullcone, h323_alg_rtcp_fullcone_mismatch, h323_alg_reuse_rtp_rtcp_fullcone, h323_alg_alloc_rtp_rtcp_port_failure, h323_alg_alloc_single_port_failure, h323_alg_create_single_fullcone_failure, h323_alg_create_rtp_fullcone_failure, h323_alg_create_rtcp_fullcone_failure, h323_alg_port_pair_alloc_from_consecutive, h323_alg_port_pair_alloc_from_partition, h323_alg_port_pair_alloc_from_pool_port_batch, h323_alg_port_pair_alloc_from_quota_consecutive, h323_alg_port_pair_alloc_from_quota_partition, h323_alg_port_pair_alloc_from_quota_partition_error, h323_alg_port_pair_alloc_from_quota_pool_port_batch, port_batch_quota_extension_alloc_failure, port_batch_free_quota_not_found, port_batch_free_port_not_found, port_batch_free_wrong_partition, radius_query_quota_ext_alloc_failure, radius_query_quota_ext_alloc_race_free, quota_extension_added, quota_extension_removed, quota_extension_remove_not_found, ha_sync_port_batch_sent, ha_sync_port_batch_rcv, ha_send_port_batch_not_found, ha_rcv_port_not_in_port_batch, bad_port_to_free, consecutive_port_free, partition_port_free, pool_port_batch_port_free, port_allocated_from_quota_consecutive, port_allocated_from_quota_partition, port_allocated_from_quota_pool_port_batch, port_freed_from_quota_consecutive, port_freed_from_quota_partition, port_freed_from_quota_pool_port_batch, port_batch_allocated_to_quota, port_batch_freed_from_quota, specific_port_allocated_from_quota_consecutive, specific_port_allocated_from_quota_partition, specific_port_allocated_from_quota_pool_port_batch, port_batch_container_alloc_failure, port_batch_container_alloc_race_free, port_overloading_destination_conflict, port_overloading_out_of_memory, port_overloading_assign_user, port_overloading_assign_user_port_batch, port_overloading_inc, port_overloading_dec_on_conflict, port_overloading_dec_on_free, port_overloading_free_port_on_conflict, port_overloading_free_port_batch_on_conflict, port_overloading_inc_overflow, port_overloading_attempt_consecutive_ports, port_overloading_attempt_same_partition, port_overloading_attempt_diff_partition, port_overloading_attempt_failed, port_overloading_conn_free_retry_lookup, port_overloading_conn_free_not_found, port_overloading_smp_mem_allocated, port_overloading_smp_mem_freed, port_overloading_smp_inserted, port_overloading_smp_inserted_tcp_shadow, port_overloading_smp_inserted_udp_shadow, port_overloading_smp_free_tcp_shadow, port_overloading_smp_free_udp_shadow, port_overloading_smp_put_in_del_q_from_conn, port_overloading_smp_free_dec_failure, port_overloading_smp_free_no_quota, port_overloading_smp_free_port, port_overloading_smp_free_port_from_quota, port_overloading_for_no_ports, port_overloading_for_no_ports_success, port_overloading_for_quota_exceeded, port_overloading_for_quota_exceeded_success, port_overloading_for_quota_exceeded_race, port_overloading_for_quota_exceeded_race_success, port_overloading_for_new_user, port_overloading_for_new_user_success, ha_port_overloading_attempt_failed, ha_port_overloading_for_no_ports, ha_port_overloading_for_no_ports_success, ha_port_overloading_for_quota_exceeded, ha_port_overloading_for_quota_exceeded_success, ha_port_overloading_for_quota_exceeded_race, ha_port_overloading_for_quota_exceeded_race_success, ha_port_overloading_for_new_user, ha_port_overloading_for_new_user_success
counters3
Description ‘nat_pool_force_delete’: NAT Pool Force Delete; ‘quota_ext_too_many’: Quota Ext Too Many; ‘nat_pool_not_found_on_free’: NAT Pool Not Found on Free; ‘standby_class_list_drop’: Standby Class-List Drop; ‘dst_prefix_mismatch’: Destination Prefix Mismatch Drop; ‘fullcone_inbound_nat_pool_mismatch’: Full-cone Session NAT Pool Mismatch; ‘6rd_no_match_domain_drop’: Sixrd Packets Domain Not Found; ‘ha_prefix_not_found’: HA No Matching Prefix Found; ‘nat_pool_attempt_adding_multiple_free_batches’: Attempt Adding Multiple Free Batches to Quota; ‘nat_pool_add_free_batch_failed’: Add Batch to Quota Failed; ‘mgcp_alg_no_quota’: MGCP ALG User-Quota Not Found; ‘mgcp_alg_quota_inc_failure’: MGCP ALG User-Quota Exceeded; ‘mgcp_alg_no_nat_ip’: MGCP ALG Unknown NAT IP; ‘mgcp_alg_reuse_fullcone’: MGCP ALG Reuse Full-cone Session; ‘mgcp_alg_fullcone_mismatch’: MGCP ALG Full-cone Session Mismatch; ‘mgcp_alg_alloc_port_failure’: MGCP ALG Alloc NAT Port Failure; ‘mgcp_alg_create_fullcone_failure’: MGCP ALG Create Full-cone Session Failure; ‘mgcp_alg_release_port_failure’: MGCP ALG Release NAT Port Failure; ‘mgcp_alg_single_rtp_fullcone’: MGCP ALG Single RTP Full-cone Found; ‘mgcp_alg_single_rtcp_fullcone’: MGCP ALG Single RTCP Full-cone Found; ‘mgcp_alg_rtcp_fullcone_mismatch’: MGCP ALG RTCP Full-cone NAT Port Mismatch; ‘mgcp_alg_reuse_rtp_rtcp_fullcone’: MGCP ALG Reuse RTP/RTCP Full-cone Session; ‘mgcp_alg_alloc_rtp_rtcp_port_failure’: MGCP ALG Alloc RTP/RTCP NAT Ports Failure; ‘mgcp_alg_alloc_single_port_failure’: MGCP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘mgcp_alg_create_single_fullcone_failure’: MGCP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘mgcp_alg_create_rtp_fullcone_failure’: MGCP ALG Create RTP Full-cone Session Failure; ‘mgcp_alg_create_rtcp_fullcone_failure’: MGCP ALG Create RTCP Full-cone Session Failure; ‘mgcp_alg_port_pair_alloc_from_consecutive’: MGCP ALG Port Pair Allocated From Consecutive; ‘mgcp_alg_port_pair_alloc_from_partition’: MGCP ALG Port Pair Allocated From Partition; ‘mgcp_alg_port_pair_alloc_from_pool_port_batch’: MGCP ALG Port Pair Allocated From Pool Port Batch; ‘mgcp_alg_port_pair_alloc_from_quota_consecutive’: MGCP ALG Port Pair Allocated From Quota Consecutive; ‘mgcp_alg_port_pair_alloc_from_quota_partition’: MGCP ALG Port Pair Allocated From Quota Partition; ‘mgcp_alg_port_pair_alloc_from_quota_partition_error’: MGCP ALG Port Pair Allocated From Quota Partition Error; ‘mgcp_alg_port_pair_alloc_from_quota_pool_port_batch’: MGCP ALG Port Pair Allocated From Quota Pool Port Batch; ‘user_quota_unusable_drop’: User-Quota Unusable Drop; ‘user_quota_unusable’: User-Quota Marked Unusable; ‘nat_pool_same_port_batch_udp_failed’: Simultaneous Batch Allocation UDP Port Allocation Failed; ‘adc_port_allocation_failed’: ADC Port Allocation Failed; ‘adc_port_allocation_ineligible’: ADC Port Allocation Not Allowed; ‘fwd_ingress_packets_tcp’: Forward Ingress Packets TCP; ‘fwd_egress_packets_tcp’: Forward Egress Packets TCP; ‘rev_ingress_packets_tcp’: Reverse Ingress Packets TCP; ‘rev_egress_packets_tcp’: Reverse Egress Packets TCP; ‘fwd_ingress_bytes_tcp’: Forward Ingress Bytes TCP; ‘fwd_egress_bytes_tcp’: Forward Egress Bytes TCP; ‘rev_ingress_bytes_tcp’: Reverse Ingress Bytes TCP; ‘rev_egress_bytes_tcp’: Reverse Egress Bytes TCP; ‘fwd_ingress_packets_udp’: Forward Ingress Packets UDP; ‘fwd_egress_packets_udp’: Forward Egress Packets UDP; ‘rev_ingress_packets_udp’: Reverse Ingress Packets UDP; ‘rev_egress_packets_udp’: Reverse Egress Packets UDP; ‘fwd_ingress_bytes_udp’: Forward Ingress Bytes UDP; ‘fwd_egress_bytes_udp’: Forward Egress Bytes UDP; ‘rev_ingress_bytes_udp’: Reverse Ingress Bytes UDP; ‘rev_egress_bytes_udp’: Reverse Egress Bytes UDP; ‘fwd_ingress_packets_icmp’: Forward Ingress Packets ICMP; ‘fwd_egress_packets_icmp’: Forward Egress Packets ICMP; ‘rev_ingress_packets_icmp’: Reverse Ingress Packets ICMP; ‘rev_egress_packets_icmp’: Reverse Egress Packets ICMP; ‘fwd_ingress_bytes_icmp’: Forward Ingress Bytes ICMP; ‘fwd_egress_bytes_icmp’: Forward Egress Bytes ICMP; ‘rev_ingress_bytes_icmp’: Reverse Ingress Bytes ICMP; ‘rev_egress_bytes_icmp’: Reverse Egress Bytes ICMP; ‘fwd_ingress_packets_others’: Forward Ingress Packets OTHERS; ‘fwd_egress_packets_others’: Forward Egress Packets OTHERS; ‘rev_ingress_packets_others’: Reverse Ingress Packets OTHERS; ‘rev_egress_packets_others’: Reverse Egress Packets OTHERS; ‘fwd_ingress_bytes_others’: Forward Ingress Bytes OTHERS; ‘fwd_egress_bytes_others’: Forward Egress Bytes OTHERS; ‘rev_ingress_bytes_others’: Reverse Ingress Bytes OTHERS; ‘rev_egress_bytes_others’: Reverse Egress Bytes OTHERS; ‘fwd_ingress_pkt_size_range1’: Forward Ingress Packet size between 0 and 200; ‘fwd_ingress_pkt_size_range2’: Forward Ingress Packet size between 201 and 800; ‘fwd_ingress_pkt_size_range3’: Forward Ingress Packet size between 801 and 1550; ‘fwd_ingress_pkt_size_range4’: Forward Ingress Packet size between 1551 and 9000; ‘fwd_egress_pkt_size_range1’: Forward Egress Packet size between 0 and 200; ‘fwd_egress_pkt_size_range2’: Forward Egress Packet size between 201 and 800; ‘fwd_egress_pkt_size_range3’: Forward Egress Packet size between 801 and 1550; ‘fwd_egress_pkt_size_range4’: Forward Egress Packet size between 1551 and 9000; ‘rev_ingress_pkt_size_range1’: Reverse Ingress Packet size between 0 and 200; ‘rev_ingress_pkt_size_range2’: Reverse Ingress Packet size between 201 and 800; ‘rev_ingress_pkt_size_range3’: Reverse Ingress Packet size between 801 and 1550; ‘rev_ingress_pkt_size_range4’: Reverse Ingress Packet size between 1551 and 9000; ‘rev_egress_pkt_size_range1’: Reverse Egress Packet size between 0 and 200; ‘rev_egress_pkt_size_range2’: Reverse Egress Packet size between 201 and 800; ‘rev_egress_pkt_size_range3’: Reverse Egress Packet size between 801 and 1550; ‘rev_egress_pkt_size_range4’: Reverse Egress Packet size between 1551 and 9000; ‘prefix_quota_mismatch’: Prefix Quota NAT IP Mismatch;
Type: string
Supported Values: nat_pool_force_delete, quota_ext_too_many, nat_pool_not_found_on_free, standby_class_list_drop, dst_prefix_mismatch, fullcone_inbound_nat_pool_mismatch, 6rd_no_match_domain_drop, ha_prefix_not_found, nat_pool_attempt_adding_multiple_free_batches, nat_pool_add_free_batch_failed, mgcp_alg_no_quota, mgcp_alg_quota_inc_failure, mgcp_alg_no_nat_ip, mgcp_alg_reuse_fullcone, mgcp_alg_fullcone_mismatch, mgcp_alg_alloc_port_failure, mgcp_alg_create_fullcone_failure, mgcp_alg_release_port_failure, mgcp_alg_single_rtp_fullcone, mgcp_alg_single_rtcp_fullcone, mgcp_alg_rtcp_fullcone_mismatch, mgcp_alg_reuse_rtp_rtcp_fullcone, mgcp_alg_alloc_rtp_rtcp_port_failure, mgcp_alg_alloc_single_port_failure, mgcp_alg_create_single_fullcone_failure, mgcp_alg_create_rtp_fullcone_failure, mgcp_alg_create_rtcp_fullcone_failure, mgcp_alg_port_pair_alloc_from_consecutive, mgcp_alg_port_pair_alloc_from_partition, mgcp_alg_port_pair_alloc_from_pool_port_batch, mgcp_alg_port_pair_alloc_from_quota_consecutive, mgcp_alg_port_pair_alloc_from_quota_partition, mgcp_alg_port_pair_alloc_from_quota_partition_error, mgcp_alg_port_pair_alloc_from_quota_pool_port_batch, user_quota_unusable_drop, user_quota_unusable, nat_pool_same_port_batch_udp_failed, adc_port_allocation_failed, adc_port_allocation_ineligible, fwd_ingress_packets_tcp, fwd_egress_packets_tcp, rev_ingress_packets_tcp, rev_egress_packets_tcp, fwd_ingress_bytes_tcp, fwd_egress_bytes_tcp, rev_ingress_bytes_tcp, rev_egress_bytes_tcp, fwd_ingress_packets_udp, fwd_egress_packets_udp, rev_ingress_packets_udp, rev_egress_packets_udp, fwd_ingress_bytes_udp, fwd_egress_bytes_udp, rev_ingress_bytes_udp, rev_egress_bytes_udp, fwd_ingress_packets_icmp, fwd_egress_packets_icmp, rev_ingress_packets_icmp, rev_egress_packets_icmp, fwd_ingress_bytes_icmp, fwd_egress_bytes_icmp, rev_ingress_bytes_icmp, rev_egress_bytes_icmp, fwd_ingress_packets_others, fwd_egress_packets_others, rev_ingress_packets_others, rev_egress_packets_others, fwd_ingress_bytes_others, fwd_egress_bytes_others, rev_ingress_bytes_others, rev_egress_bytes_others, fwd_ingress_pkt_size_range1, fwd_ingress_pkt_size_range2, fwd_ingress_pkt_size_range3, fwd_ingress_pkt_size_range4, fwd_egress_pkt_size_range1, fwd_egress_pkt_size_range2, fwd_egress_pkt_size_range3, fwd_egress_pkt_size_range4, rev_ingress_pkt_size_range1, rev_ingress_pkt_size_range2, rev_ingress_pkt_size_range3, rev_ingress_pkt_size_range4, rev_egress_pkt_size_range1, rev_egress_pkt_size_range2, rev_egress_pkt_size_range3, rev_egress_pkt_size_range4, prefix_quota_mismatch
nat64_alg¶
Specification
Value
Type
object
esp
Description: esp is a JSON Block. Please see below for nat64_alg_esp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/esp
ftp
Description: ftp is a JSON Block. Please see below for nat64_alg_ftp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/ftp
h323
Description: h323 is a JSON Block. Please see below for nat64_alg_h323
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/h323
mgcp
Description: mgcp is a JSON Block. Please see below for nat64_alg_mgcp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/mgcp
pptp
Description: pptp is a JSON Block. Please see below for nat64_alg_pptp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/pptp
rtsp
Description: rtsp is a JSON Block. Please see below for nat64_alg_rtsp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for nat64_alg_sip
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for nat64_alg_tftp
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/alg/tftp
nat64_alg_esp¶
Specification
Value
Type
object
esp-enable
Description ‘enable’: Enable NAT64 ESP ALG; ‘enable-with-ctrl’: Enable ESP NAT64 ALG with control session;
Type: string
Supported Values: enable, enable-with-ctrl
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_esp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: ESP Sessions Created; ‘nat-ip-conflict’: NAT IP Conflict;
Type: string
Supported Values: all, session-created, nat-ip-conflict
nat64_alg_ftp¶
Specification
Value
Type
object
ftp-enable
Description ‘disable’: Disable NAT64 FTP ALG;
Type: string
Supported Values: disable
trans-eprt-to-port
Description ‘disable’: disable;
Type: string
Supported Values: disable
trans-epsv-to-pasv
Description ‘disable’: disable;
Type: string
Supported Values: disable
trans-lprt-to-port
Description ‘disable’: disable;
Type: string
Supported Values: disable
trans-lpsv-to-pasv
Description ‘disable’: disable;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
xlat-no-trans-pasv
Description ‘enable’: enable;
Type: string
Supported Values: enable
nat64_alg_pptp¶
Specification
Value
Type
object
pptp-enable
Description ‘enable’: Enable NAT64 PPTP ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_rtsp¶
Specification
Value
Type
object
rtsp-enable
Description ‘enable’: Enable NAT64 RTSP ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_sip¶
Specification
Value
Type
object
sip-enable
Description ‘enable’: Enable NAT64 SIP ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_h323¶
Specification
Value
Type
object
h323-enable
Description ‘enable’: Enable NAT64 H323 ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_mgcp¶
Specification
Value
Type
object
mgcp-enable
Description ‘enable’: Enable NAT64 MGCP ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_alg_tftp¶
Specification
Value
Type
object
tftp-enable
Description ‘enable’: Enable NAT64 TFTP ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_fragmentation¶
Specification
Value
Type
object
df-bit-transparency
Description: df-bit-transparency is a JSON Block. Please see below for nat64_fragmentation_df-bit-transparency
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/fragmentation/df-bit-transparency
inbound
Description: inbound is a JSON Block. Please see below for nat64_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for nat64_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/nat64/fragmentation/outbound
nat64_fragmentation_df-bit-transparency¶
Specification
Value
Type
object
df-bit-value
Description ‘enable’: Add an empty IPv6 fragmentation header if IPv4 DF bit is zero;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_fragmentation_inbound¶
Specification
Value
Type
object
count
Description Configure number of ICMP messages sent when DF set. Default is 1
Type: number
Range: 1-5
Default: 1
df-set
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 fragmentation; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_fragmentation_outbound¶
Specification
Value
Type
object
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation (default); ‘send-icmpv6’: Send ICMPv6 Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_prefix-list¶
Specification
Value
Type
list
Block object keys
class-list
Description Class-list to match for NAT64
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
prefix-val
Description NAT64 Prefix
Type: string
Format: ipv6-address-plen
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
nat64_user-quota-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_enhanced-user-tracking¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat64_full-cone-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite¶
Specification
Value
Type
object
alg
Description: alg is a JSON Block. Please see below for ds-lite_alg
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg
fragmentation
Description: fragmentation is a JSON Block. Please see below for ds-lite_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/fragmentation
full-cone-session
Description: full-cone-session is a JSON Block. Please see below for ds-lite_full-cone-session
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/full-cone-session
global
Description: global is a JSON Block. Please see below for ds-lite_global
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/global
port-reservation-entries
Description: port-reservation-entries is a JSON Block. Please see below for ds-lite_port-reservation-entries
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/port-reservation-entries
port-reservation-list
user-quota-session
Description: user-quota-session is a JSON Block. Please see below for ds-lite_user-quota-session
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/user-quota-session
ds-lite_global¶
Specification
Value
Type
object
icmp
Description: icmp is a JSON Block. Please see below for ds-lite_global_icmp
Type: Object
inside
Description: inside is a JSON Block. Please see below for ds-lite_global_inside
Type: Object
ip-checksum-error
Description ‘fix’: Fix the bad checksum (default); ‘drop’: Drop packets with a bad checksum;
Type: string
Supported Values: fix, drop
Default: fix
l4-checksum-error
Description ‘propagate’: Propagate the bad checksum (default); ‘fix’: Fix the bad checksum; ‘drop’: Drop packets with a bad checksum;
Type: string
Supported Values: propagate, fix, drop
Default: propagate
sampling-enable
Type: List
tcp
Description: tcp is a JSON Block. Please see below for ds-lite_global_tcp
Type: Object
user-quota-prefix-length
Description User Quota Prefix Length (Default: 128)
Type: number
Range: 1-128
Default: 128
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_global_tcp¶
Specification
Value
Type
object
mss-clamp
Description: mss-clamp is a JSON Block. Please see below for ds-lite_global_tcp_mss-clamp
Type: Object
reset-on-error
Description: reset-on-error is a JSON Block. Please see below for ds-lite_global_tcp_reset-on-error
Type: Object
ds-lite_global_tcp_mss-clamp¶
Specification
Value
Type
object
min
Description Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: ((576 - 60 - 60 - 40))))
Type: number
Range: 0-1420
Default: 416
mss-clamp-type
Description ‘fixed’: Specify a fixed max value for the TCP MSS; ‘none’: No TCP MSS clamping; ‘subtract’: Specify the value to subtract from the TCP MSS (default: 40);
Type: string
Supported Values: fixed, none, subtract
Default: subtract
mss-subtract
Description Specify the value to subtract from the TCP MSS (default: 40)
Type: number
Range: 0-1420
Default: 40
mss-value
Description The max value allowed for the TCP MSS (default: not configured)
Type: number
Range: 0-1420
ds-lite_global_tcp_reset-on-error¶
Specification
Value
Type
object
outbound
Description ‘disable’: Disable send TCP reset on error;
Type: string
Supported Values: disable
ds-lite_global_inside¶
Specification
Value
Type
object
source
Description: source is a JSON Block. Please see below for ds-lite_global_inside_source
Type: Object
ds-lite_global_inside_source¶
Specification
Value
Type
object
class-list
Description Class-list to match for DS-Lite
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ds-lite_global_icmp¶
Specification
Value
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
ds-lite_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘total_tcp_allocated’: Total TCP Ports Allocated; ‘total_tcp_freed’: Total TCP Ports Freed; ‘total_udp_allocated’: Total UDP Ports Allocated; ‘total_udp_freed’: Total UDP Ports Freed; ‘total_icmp_allocated’: Total ICMP Ports Allocated; ‘total_icmp_freed’: Total ICMP Ports Freed; ‘data_session_created’: Data Session Created; ‘data_session_freed’: Data Session Freed; ‘user_quota_created’: User-Quota Created; ‘user_quota_put_in_del_q’: User-Quota Freed; ‘user_quota_failure’: User-Quota Creation Failed; ‘nat_port_unavailable_tcp’: TCP NAT Port Unavailable; ‘nat_port_unavailable_udp’: UDP NAT Port Unavailable; ‘nat_port_unavailable_icmp’: ICMP NAT Port Unavailable; ‘new_user_resource_unavailable’: New User NAT Resource Unavailable; ‘tcp_user_quota_exceeded’: TCP User-Quota Exceeded; ‘udp_user_quota_exceeded’: UDP User-Quota Exceeded; ‘icmp_user_quota_exceeded’: ICMP User-Quota Exceeded; ‘extended_quota_matched’: Extended User-Quota Matched; ‘extended_quota_exceeded’: Extended User-Quota Exceeded; ‘data_sesn_user_quota_exceeded’: Data Session User-Quota Exceeded; ‘data_sesn_rate_user_quota_exceeded’: Conn Rate User-Quota Exceeded; ‘tcp_fullcone_created’: TCP Full-cone Session Created; ‘tcp_fullcone_freed’: TCP Full-cone Session Freed; ‘udp_fullcone_created’: UDP Full-cone Session Created; ‘udp_fullcone_freed’: UDP Full-cone Session Freed; ‘fullcone_failure’: Full-cone Session Creation Failed; ‘hairpin’: Hairpin Session Created; ‘fullcone_self_hairpinning_drop’: Self-Hairpinning Drop; ‘endpoint_indep_map_match’: Endpoint-Independent Mapping Matched; ‘endpoint_indep_filter_match’: Endpoint-Independent Filtering Matched; ‘inbound_filtered’: Endpoint-Dependent Filtering Drop; ‘eif_limit_exceeded’: Endpoint-Independent Filtering Inbound Limit Exceeded; ‘total_tcp_overloaded’: TCP Port Overloaded; ‘total_udp_overloaded’: UDP Port Overloaded; ‘port_overloading_smp_inserted_tcp’: TCP Port Overloading Session Created; ‘port_overloading_smp_inserted_udp’: UDP Port Overloading Session Created; ‘port_overloading_smp_free_tcp’: TCP Port Overloading Session Freed; ‘port_overloading_smp_free_udp’: UDP Port Overloading Session Freed; ‘nat_pool_unusable’: NAT Pool Unusable; ‘ha_nat_pool_unusable’: HA NAT Pool Unusable; ‘ha_nat_pool_batch_type_mismatch’: HA NAT Pool Batch Type Mismatch; ‘no_radius_profile_match’: No RADIUS Profile Match; ‘truncated_packet’: Truncated Packet; ‘lid_drop’: LSN LID Drop; ‘lid_pass_through’: LSN LID Pass-through; ‘no_class_list_match’: No Class-List Match; ‘class_list_permit_drop’: Permit Class-List Drop; ‘user_quota_mem_allocated’: User-Quota Memory Allocated; ‘user_quota_mem_freed’: User-Quota Memory Freed; ‘user_quota_created_shadow’: Total User-Quota Created; ‘quota_marked_deleted’: User-Quota Marked Deleted; ‘quota_delete_not_in_bucket’: User-Quota Delete Not In Bucket; ‘user_quota_put_in_del_q_shadow’: Total User-Quota Put In Del Q; ‘prefix_quota_created’: Total Prefix Quota Created; ‘prefix_quota_put_in_del_q’: Total Prefix Quota Freed; ‘prefix_quota_failure’: Total Prefix Quota Failure; ‘total_user_quota_created’: Total Quota Structure Created; ‘total_user_quota_put_in_del_q’: Total Quota Structure Freed; ‘total_user_quota_failure’: Total Quota Structure Failure; ‘tcp_out_of_state_rst_sent’: Total Out of State TCP RST sent; ‘tcp_out_of_state_rst_dropped’: Total Out of State TCP RST dropped; ‘icmp_out_of_state_uqe_admin_filtered_sent’: Total User Quota Exceeded ICMP admin filtered sent; ‘icmp_out_of_state_uqe_host_unreachable_sent’: Total User Quota Exceeded ICMP host unreachable sent; ‘icmp_out_of_state_uqe_dropped’: Total User Queue Exceeded ICMP notification dropped; ‘user_quota_not_found’: User-Quota Not Found; ‘tcp_fullcone_created_shadow’: Total TCP Full-cone sessions created; ‘tcp_fullcone_freed_shadow’: Total TCP Full-cone sessions freed; ‘udp_fullcone_created_shadow’: Total UDP Full-cone sessions created; ‘udp_fullcone_freed_shadow’: Total UDP Full-cone sessions freed; ‘udp_alg_fullcone_created’: Total UDP ALG Full-cone sessions created; ‘udp_alg_fullcone_freed’: Total UDP ALG Full-cone sessions freed; ‘fullcone_created’: Total Full-cone sessions created; ‘fullcone_freed’: Total Full-cone sessions freed; ‘data_session_created_shadow’: Total Data Sessions Created; ‘data_session_freed_shadow’: Total Data Sessions Freed; ‘data_session_user_quota_mismatch’: Data Session Counter Per User Mismatch; ‘extended_quota_mismatched’: Extended User-Quota Mismatched; ‘nat_port_unavailable_other’: Other NAT Port Unavailable; ‘nat_port_unavailable’: Total NAT Port Unavailable; ‘new_user_resource_unavailable_tcp’: TCP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_udp’: UDP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_icmp’: ICMP New User NAT Resource Unavailable; ‘new_user_resource_unavailable_other’: Other New User NAT Resource Unavailable; ‘total_tcp_allocated_shadow’: Total TCP Ports Allocated; ‘total_tcp_freed_shadow’: Total TCP Ports Freed; ‘total_udp_allocated_shadow’: Total UDP Ports Allocated; ‘total_udp_freed_shadow’: Total UDP Ports Freed; ‘total_icmp_allocated_shadow’: Total ICMP Ports Allocated; ‘total_icmp_freed_shadow’: Total ICMP Ports Freed; ‘udp_alg_no_quota’: UDP ALG User-Quota Not Found; ‘udp_alg_eim_mismatch’: UDP ALG Endpoint-Independent Mapping Mismatch; ‘udp_alg_no_nat_ip’: UDP ALG User-Quota Unknown NAT IP; ‘udp_alg_alloc_failure’: UDP ALG Port Allocation Failure; ‘sip_alg_no_quota’: SIP ALG User-Quota Not Found; ‘sip_alg_quota_inc_failure’: SIP ALG User-Quota Exceeded; ‘sip_alg_no_nat_ip’: SIP ALG Unknown NAT IP; ‘sip_alg_reuse_contact_fullcone’: SIP ALG Reuse Contact Full-cone Session; ‘sip_alg_contact_fullcone_mismatch’: SIP ALG Contact Full-cone Session Mismatch; ‘sip_alg_alloc_contact_port_failure’: SIP ALG Alloc Contact NAT Port Failure; ‘sip_alg_create_contact_fullcone_failure’: SIP ALG Create Contact Full-cone Session Failure; ‘sip_alg_release_contact_port_failure’: SIP ALG Release Contact NAT Port Failure; ‘sip_alg_single_rtp_fullcone’: SIP ALG Single RTP Full-cone Found; ‘sip_alg_single_rtcp_fullcone’: SIP ALG Single RTCP Full-cone Found; ‘sip_alg_rtcp_fullcone_mismatch’: SIP ALG RTCP Full-cone NAT Port Mismatch; ‘sip_alg_reuse_rtp_rtcp_fullcone’: SIP ALG Reuse RTP/RTCP Full-cone Session; ‘sip_alg_alloc_rtp_rtcp_port_failure’: SIP ALG Alloc RTP/RTCP NAT Ports Failure; ‘sip_alg_alloc_single_port_failure’: SIP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘sip_alg_create_single_fullcone_failure’: SIP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘sip_alg_create_rtp_fullcone_failure’: SIP ALG Create RTP Full-cone Session Failure; ‘sip_alg_create_rtcp_fullcone_failure’: SIP ALG Create RTCP Full-cone Session Failure; ‘sip_alg_port_pair_alloc_from_consecutive’: SIP ALG Port Pair Allocated From Consecutive; ‘sip_alg_port_pair_alloc_from_partition’: SIP ALG Port Pair Allocated From Partition; ‘sip_alg_port_pair_alloc_from_pool_port_batch’: SIP ALG Port Pair Allocated From Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_consecutive’: SIP ALG Port Pair Allocated From Quota Consecutive; ‘sip_alg_port_pair_alloc_from_quota_partition’: SIP ALG Port Pair Allocated From Quota Partition; ‘sip_alg_port_pair_alloc_from_quota_partition_error’: SIP ALG Port Pair Allocated From Quota Partition Error; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch’: SIP ALG Port Pair Allocated From Quota Pool Port Batch; ‘sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag’: SIP ALG Port Pair Allocated From Quota Port Batch Version 2 with Frag Free Ports;
Type: string
Supported Values: all, total_tcp_allocated, total_tcp_freed, total_udp_allocated, total_udp_freed, total_icmp_allocated, total_icmp_freed, data_session_created, data_session_freed, user_quota_created, user_quota_put_in_del_q, user_quota_failure, nat_port_unavailable_tcp, nat_port_unavailable_udp, nat_port_unavailable_icmp, new_user_resource_unavailable, tcp_user_quota_exceeded, udp_user_quota_exceeded, icmp_user_quota_exceeded, extended_quota_matched, extended_quota_exceeded, data_sesn_user_quota_exceeded, data_sesn_rate_user_quota_exceeded, tcp_fullcone_created, tcp_fullcone_freed, udp_fullcone_created, udp_fullcone_freed, fullcone_failure, hairpin, fullcone_self_hairpinning_drop, endpoint_indep_map_match, endpoint_indep_filter_match, inbound_filtered, eif_limit_exceeded, total_tcp_overloaded, total_udp_overloaded, port_overloading_smp_inserted_tcp, port_overloading_smp_inserted_udp, port_overloading_smp_free_tcp, port_overloading_smp_free_udp, nat_pool_unusable, ha_nat_pool_unusable, ha_nat_pool_batch_type_mismatch, no_radius_profile_match, truncated_packet, lid_drop, lid_pass_through, no_class_list_match, class_list_permit_drop, user_quota_mem_allocated, user_quota_mem_freed, user_quota_created_shadow, quota_marked_deleted, quota_delete_not_in_bucket, user_quota_put_in_del_q_shadow, prefix_quota_created, prefix_quota_put_in_del_q, prefix_quota_failure, total_user_quota_created, total_user_quota_put_in_del_q, total_user_quota_failure, tcp_out_of_state_rst_sent, tcp_out_of_state_rst_dropped, icmp_out_of_state_uqe_admin_filtered_sent, icmp_out_of_state_uqe_host_unreachable_sent, icmp_out_of_state_uqe_dropped, user_quota_not_found, tcp_fullcone_created_shadow, tcp_fullcone_freed_shadow, udp_fullcone_created_shadow, udp_fullcone_freed_shadow, udp_alg_fullcone_created, udp_alg_fullcone_freed, fullcone_created, fullcone_freed, data_session_created_shadow, data_session_freed_shadow, data_session_user_quota_mismatch, extended_quota_mismatched, nat_port_unavailable_other, nat_port_unavailable, new_user_resource_unavailable_tcp, new_user_resource_unavailable_udp, new_user_resource_unavailable_icmp, new_user_resource_unavailable_other, total_tcp_allocated_shadow, total_tcp_freed_shadow, total_udp_allocated_shadow, total_udp_freed_shadow, total_icmp_allocated_shadow, total_icmp_freed_shadow, udp_alg_no_quota, udp_alg_eim_mismatch, udp_alg_no_nat_ip, udp_alg_alloc_failure, sip_alg_no_quota, sip_alg_quota_inc_failure, sip_alg_no_nat_ip, sip_alg_reuse_contact_fullcone, sip_alg_contact_fullcone_mismatch, sip_alg_alloc_contact_port_failure, sip_alg_create_contact_fullcone_failure, sip_alg_release_contact_port_failure, sip_alg_single_rtp_fullcone, sip_alg_single_rtcp_fullcone, sip_alg_rtcp_fullcone_mismatch, sip_alg_reuse_rtp_rtcp_fullcone, sip_alg_alloc_rtp_rtcp_port_failure, sip_alg_alloc_single_port_failure, sip_alg_create_single_fullcone_failure, sip_alg_create_rtp_fullcone_failure, sip_alg_create_rtcp_fullcone_failure, sip_alg_port_pair_alloc_from_consecutive, sip_alg_port_pair_alloc_from_partition, sip_alg_port_pair_alloc_from_pool_port_batch, sip_alg_port_pair_alloc_from_quota_consecutive, sip_alg_port_pair_alloc_from_quota_partition, sip_alg_port_pair_alloc_from_quota_partition_error, sip_alg_port_pair_alloc_from_quota_pool_port_batch, sip_alg_port_pair_alloc_from_quota_pool_port_batch_with_frag
counters2
Description ‘h323_alg_no_quota’: H323 ALG User-Quota Not Found; ‘h323_alg_quota_inc_failure’: H323 ALG User-Quota Exceeded; ‘h323_alg_no_nat_ip’: H323 ALG Unknown NAT IP; ‘h323_alg_reuse_fullcone’: H323 ALG Reuse Full-cone Session; ‘h323_alg_fullcone_mismatch’: H323 ALG Full-cone Session Mismatch; ‘h323_alg_alloc_port_failure’: H323 ALG Alloc NAT Port Failure; ‘h323_alg_create_fullcone_failure’: H323 ALG Create Full-cone Session Failure; ‘h323_alg_release_port_failure’: H323 ALG Release NAT Port Failure; ‘h323_alg_single_rtp_fullcone’: H323 ALG Single RTP Full-cone Found; ‘h323_alg_single_rtcp_fullcone’: H323 ALG Single RTCP Full-cone Found; ‘h323_alg_rtcp_fullcone_mismatch’: H323 ALG RTCP Full-cone NAT Port Mismatch; ‘h323_alg_reuse_rtp_rtcp_fullcone’: H323 ALG Reuse RTP/RTCP Full-cone Session; ‘h323_alg_alloc_rtp_rtcp_port_failure’: H323 ALG Alloc RTP/RTCP NAT Ports Failure; ‘h323_alg_alloc_single_port_failure’: H323 ALG Alloc Single RTP or RTCP NAT Port Failure; ‘h323_alg_create_single_fullcone_failure’: H323 ALG Create Single RTP or RTCP Full-cone Session Failure; ‘h323_alg_create_rtp_fullcone_failure’: H323 ALG Create RTP Full-cone Session Failure; ‘h323_alg_create_rtcp_fullcone_failure’: H323 ALG Create RTCP Full-cone Session Failure; ‘h323_alg_port_pair_alloc_from_consecutive’: H323 ALG Port Pair Allocated From Consecutive; ‘h323_alg_port_pair_alloc_from_partition’: H323 ALG Port Pair Allocated From Partition; ‘h323_alg_port_pair_alloc_from_pool_port_batch’: H323 ALG Port Pair Allocated From Pool Port Batch; ‘h323_alg_port_pair_alloc_from_quota_consecutive’: H323 ALG Port Pair Allocated From Quota Consecutive; ‘h323_alg_port_pair_alloc_from_quota_partition’: H323 ALG Port Pair Allocated From Quota Partition; ‘h323_alg_port_pair_alloc_from_quota_partition_error’: H323 ALG Port Pair Allocated From Quota Partition Error; ‘h323_alg_port_pair_alloc_from_quota_pool_port_batch’: H323 ALG Port Pair Allocated From Quota Pool Port Batch; ‘port_batch_quota_extension_alloc_failure’: Port Batch Extension Alloc Failure (No memory); ‘port_batch_free_quota_not_found’: Port Batch Quota Not Found on Free; ‘port_batch_free_port_not_found’: Port Batch Port Not Found on Free; ‘port_batch_free_wrong_partition’: Port Batch Free Wrong Partition; ‘radius_query_quota_ext_alloc_failure’: RADIUS Query Container Alloc (No Memoty); ‘radius_query_quota_ext_alloc_race_free’: RADIUS Query Container Alloc Race Free; ‘quota_extension_added’: Quota Extension Added to Quota; ‘quota_extension_removed’: Quota Extension Removed from Quota; ‘quota_extension_remove_not_found’: Quota Extension Not Found on Remove; ‘ha_sync_port_batch_sent’: HA Port Batch Extension Sync Sent; ‘ha_sync_port_batch_rcv’: HA Port Batch Extension Sync Received; ‘ha_send_port_batch_not_found’: HA Port Batch Not Found on Sync Send; ‘ha_rcv_port_not_in_port_batch’: HA Port Not in Port Batch on Sync Rcv; ‘bad_port_to_free’: Freeing Bad Port; ‘consecutive_port_free’: Port Freed from Consecutive Pool; ‘partition_port_free’: Port Freed from Partition; ‘pool_port_batch_port_free’: Port Freed from Pool Port Batch; ‘port_allocated_from_quota_consecutive’: Port Allocated from Quota Consecutive; ‘port_allocated_from_quota_partition’: Port Allocated from Quota Partition; ‘port_allocated_from_quota_pool_port_batch’: Port Allocated from Quota Pool Port Batch; ‘port_freed_from_quota_consecutive’: Port Freed from Quota Consecutive; ‘port_freed_from_quota_partition’: Port Freed from Quota Partition; ‘port_freed_from_quota_pool_port_batch’: Port Freed from Quota Pool Port Batch; ‘port_batch_allocated_to_quota’: Port Batch Allocated to Quota; ‘port_batch_freed_from_quota’: Port Batch Freed From Quota; ‘specific_port_allocated_from_quota_consecutive’: Specific Port Allocated from Quota Consecutive; ‘specific_port_allocated_from_quota_partition’: Specific Port Allocated from Quota Partition; ‘specific_port_allocated_from_quota_pool_port_batch’: Specific Port Allocated from Quota Pool Port Batch; ‘port_batch_container_alloc_failure’: Port Batch Container Alloc Out of Memory; ‘port_batch_container_alloc_race_free’: Port Batch Container Race Free; ‘port_overloading_destination_conflict’: Port Overloading Destination Conflict; ‘port_overloading_out_of_memory’: Port Overloading Out of Memory; ‘port_overloading_assign_user’: Port Overloading Port Assign User; ‘port_overloading_assign_user_port_batch’: Port Overloading Port Assign User Port Batch; ‘port_overloading_inc’: Port Overloading Port Increment; ‘port_overloading_dec_on_conflict’: Port Overloading Port Decrement on Conflict; ‘port_overloading_dec_on_free’: Port Overloading Port Decrement on Free; ‘port_overloading_free_port_on_conflict’: Port Overloading Free Port on Conflict; ‘port_overloading_free_port_batch_on_conflict’: Port Overloading Free Port Batch on Conflict; ‘port_overloading_inc_overflow’: Port Overloading Inc Overflow; ‘port_overloading_attempt_consecutive_ports’: Port Overloading on Consecutive Ports; ‘port_overloading_attempt_same_partition’: Port Overloading on Same Partition; ‘port_overloading_attempt_diff_partition’: Port Overloading on Different Partition; ‘port_overloading_attempt_failed’: Port Overloading Attempt Failed; ‘port_overloading_conn_free_retry_lookup’: Port Overloading Conn Free Retry Lookup; ‘port_overloading_conn_free_not_found’: Port Overloading Conn Free Not Found; ‘port_overloading_smp_mem_allocated’: Port Overloading SMP Session Allocated; ‘port_overloading_smp_mem_freed’: Port Overloading SMP Session Freed; ‘port_overloading_smp_inserted’: Port Overloading SMP Inserted; ‘port_overloading_smp_inserted_tcp_shadow’: Total Port Overloading SMP TCP Inserted; ‘port_overloading_smp_inserted_udp_shadow’: Total Port Overloading SMP UDP Inserted; ‘port_overloading_smp_free_tcp_shadow’: Total Port Overloading SMP TCP Freed; ‘port_overloading_smp_free_udp_shadow’: Total Port Overloading SMP UDP Freed; ‘port_overloading_smp_put_in_del_q_from_conn’: Port Overloading SMP Free From Conn; ‘port_overloading_smp_free_dec_failure’: Port Overloading SMP Free Dec Failure; ‘port_overloading_smp_free_no_quota’: Port Overloading SMP Free No Quota; ‘port_overloading_smp_free_port’: Port Overloading SMP Free Port; ‘port_overloading_smp_free_port_from_quota’: Port Overloading SMP Free Port From Quota; ‘port_overloading_for_no_ports’: Port Overloading for No Ports; ‘port_overloading_for_no_ports_success’: Port Overloading for No Ports Success; ‘port_overloading_for_quota_exceeded’: Port Overloading for Quota Exceeded; ‘port_overloading_for_quota_exceeded_success’: Port Overloading for Quota Exceeded Success; ‘port_overloading_for_quota_exceeded_race’: Port Overloading for Quota Exceeded Race; ‘port_overloading_for_quota_exceeded_race_success’: Port Overloading for Quota Exceeded Race Success; ‘port_overloading_for_new_user’: Port Overloading for New User; ‘port_overloading_for_new_user_success’: Port Overloading for New User Success; ‘ha_port_overloading_attempt_failed’: HA Port Overloading Attempt Failed; ‘ha_port_overloading_for_no_ports’: HA Port Overloading for No Ports; ‘ha_port_overloading_for_no_ports_success’: HA Port Overloading for No Ports Success; ‘ha_port_overloading_for_quota_exceeded’: HA Port Overloading for Quota Exceeded; ‘ha_port_overloading_for_quota_exceeded_success’: HA Port Overloading for Quota Exceeded Success; ‘ha_port_overloading_for_quota_exceeded_race’: HA Port Overloading for Quota Exceeded Race; ‘ha_port_overloading_for_quota_exceeded_race_success’: HA Port Overloading for Quota Exceeded Race Success; ‘ha_port_overloading_for_new_user’: HA Port Overloading for New User; ‘ha_port_overloading_for_new_user_success’: HA Port Overloading for New User Success;
Type: string
Supported Values: h323_alg_no_quota, h323_alg_quota_inc_failure, h323_alg_no_nat_ip, h323_alg_reuse_fullcone, h323_alg_fullcone_mismatch, h323_alg_alloc_port_failure, h323_alg_create_fullcone_failure, h323_alg_release_port_failure, h323_alg_single_rtp_fullcone, h323_alg_single_rtcp_fullcone, h323_alg_rtcp_fullcone_mismatch, h323_alg_reuse_rtp_rtcp_fullcone, h323_alg_alloc_rtp_rtcp_port_failure, h323_alg_alloc_single_port_failure, h323_alg_create_single_fullcone_failure, h323_alg_create_rtp_fullcone_failure, h323_alg_create_rtcp_fullcone_failure, h323_alg_port_pair_alloc_from_consecutive, h323_alg_port_pair_alloc_from_partition, h323_alg_port_pair_alloc_from_pool_port_batch, h323_alg_port_pair_alloc_from_quota_consecutive, h323_alg_port_pair_alloc_from_quota_partition, h323_alg_port_pair_alloc_from_quota_partition_error, h323_alg_port_pair_alloc_from_quota_pool_port_batch, port_batch_quota_extension_alloc_failure, port_batch_free_quota_not_found, port_batch_free_port_not_found, port_batch_free_wrong_partition, radius_query_quota_ext_alloc_failure, radius_query_quota_ext_alloc_race_free, quota_extension_added, quota_extension_removed, quota_extension_remove_not_found, ha_sync_port_batch_sent, ha_sync_port_batch_rcv, ha_send_port_batch_not_found, ha_rcv_port_not_in_port_batch, bad_port_to_free, consecutive_port_free, partition_port_free, pool_port_batch_port_free, port_allocated_from_quota_consecutive, port_allocated_from_quota_partition, port_allocated_from_quota_pool_port_batch, port_freed_from_quota_consecutive, port_freed_from_quota_partition, port_freed_from_quota_pool_port_batch, port_batch_allocated_to_quota, port_batch_freed_from_quota, specific_port_allocated_from_quota_consecutive, specific_port_allocated_from_quota_partition, specific_port_allocated_from_quota_pool_port_batch, port_batch_container_alloc_failure, port_batch_container_alloc_race_free, port_overloading_destination_conflict, port_overloading_out_of_memory, port_overloading_assign_user, port_overloading_assign_user_port_batch, port_overloading_inc, port_overloading_dec_on_conflict, port_overloading_dec_on_free, port_overloading_free_port_on_conflict, port_overloading_free_port_batch_on_conflict, port_overloading_inc_overflow, port_overloading_attempt_consecutive_ports, port_overloading_attempt_same_partition, port_overloading_attempt_diff_partition, port_overloading_attempt_failed, port_overloading_conn_free_retry_lookup, port_overloading_conn_free_not_found, port_overloading_smp_mem_allocated, port_overloading_smp_mem_freed, port_overloading_smp_inserted, port_overloading_smp_inserted_tcp_shadow, port_overloading_smp_inserted_udp_shadow, port_overloading_smp_free_tcp_shadow, port_overloading_smp_free_udp_shadow, port_overloading_smp_put_in_del_q_from_conn, port_overloading_smp_free_dec_failure, port_overloading_smp_free_no_quota, port_overloading_smp_free_port, port_overloading_smp_free_port_from_quota, port_overloading_for_no_ports, port_overloading_for_no_ports_success, port_overloading_for_quota_exceeded, port_overloading_for_quota_exceeded_success, port_overloading_for_quota_exceeded_race, port_overloading_for_quota_exceeded_race_success, port_overloading_for_new_user, port_overloading_for_new_user_success, ha_port_overloading_attempt_failed, ha_port_overloading_for_no_ports, ha_port_overloading_for_no_ports_success, ha_port_overloading_for_quota_exceeded, ha_port_overloading_for_quota_exceeded_success, ha_port_overloading_for_quota_exceeded_race, ha_port_overloading_for_quota_exceeded_race_success, ha_port_overloading_for_new_user, ha_port_overloading_for_new_user_success
counters3
Description ‘nat_pool_force_delete’: NAT Pool Force Delete; ‘quota_ext_too_many’: Quota Ext Too Many; ‘nat_pool_not_found_on_free’: NAT Pool Not Found on Free; ‘standby_class_list_drop’: Standby Class-List Drop; ‘fullcone_inbound_nat_pool_mismatch’: Full-cone Session NAT Pool Mismatch; ‘bad_ip_tot_len’: Bad IPv4 Total Length; ‘ip_checksum_verified’: IP Checksum Verified; ‘ip_checksum_fixed’: IP Checksum Fixed; ‘ip_checksum_bad_drop’: IP Checksum Bad Drop; ‘ip_frag_checksum_fixed’: IP Frag Checksum Fixed; ‘l4_checksum_verified’: L4 Checksum Verified; ‘l4_checksum_fixed’: L4 Checksum Fixed; ‘l4_checksum_bad_drop’: L4 Checksum Bad Drop; ‘jumbo_list_bad_l4_len’: Jumbo List Bad L4 Len; ‘frag_list_bad_l4_len’: Frag List Bad L4 Len; ‘nat_pool_attempt_adding_multiple_free_batches’: Attempt Adding Multiple Free Batches to Quota; ‘nat_pool_add_free_batch_failed’: Add Batch to Quota Failed; ‘mgcp_alg_no_quota’: MGCP ALG User-Quota Not Found; ‘mgcp_alg_quota_inc_failure’: MGCP ALG User-Quota Exceeded; ‘mgcp_alg_no_nat_ip’: MGCP ALG Unknown NAT IP; ‘mgcp_alg_reuse_fullcone’: MGCP ALG Reuse Full-cone Session; ‘mgcp_alg_fullcone_mismatch’: MGCP ALG Full-cone Session Mismatch; ‘mgcp_alg_alloc_port_failure’: MGCP ALG Alloc NAT Port Failure; ‘mgcp_alg_create_fullcone_failure’: MGCP ALG Create Full-cone Session Failure; ‘mgcp_alg_release_port_failure’: MGCP ALG Release NAT Port Failure; ‘mgcp_alg_single_rtp_fullcone’: MGCP ALG Single RTP Full-cone Found; ‘mgcp_alg_single_rtcp_fullcone’: MGCP ALG Single RTCP Full-cone Found; ‘mgcp_alg_rtcp_fullcone_mismatch’: MGCP ALG RTCP Full-cone NAT Port Mismatch; ‘mgcp_alg_reuse_rtp_rtcp_fullcone’: MGCP ALG Reuse RTP/RTCP Full-cone Session; ‘mgcp_alg_alloc_rtp_rtcp_port_failure’: MGCP ALG Alloc RTP/RTCP NAT Ports Failure; ‘mgcp_alg_alloc_single_port_failure’: MGCP ALG Alloc Single RTP or RTCP NAT Port Failure; ‘mgcp_alg_create_single_fullcone_failure’: MGCP ALG Create Single RTP or RTCP Full-cone Session Failure; ‘mgcp_alg_create_rtp_fullcone_failure’: MGCP ALG Create RTP Full-cone Session Failure; ‘mgcp_alg_create_rtcp_fullcone_failure’: MGCP ALG Create RTCP Full-cone Session Failure; ‘mgcp_alg_port_pair_alloc_from_consecutive’: MGCP ALG Port Pair Allocated From Consecutive; ‘mgcp_alg_port_pair_alloc_from_partition’: MGCP ALG Port Pair Allocated From Partition; ‘mgcp_alg_port_pair_alloc_from_pool_port_batch’: MGCP ALG Port Pair Allocated From Pool Port Batch; ‘mgcp_alg_port_pair_alloc_from_quota_consecutive’: MGCP ALG Port Pair Allocated From Quota Consecutive; ‘mgcp_alg_port_pair_alloc_from_quota_partition’: MGCP ALG Port Pair Allocated From Quota Partition; ‘mgcp_alg_port_pair_alloc_from_quota_partition_error’: MGCP ALG Port Pair Allocated From Quota Partition Error; ‘mgcp_alg_port_pair_alloc_from_quota_pool_port_batch’: MGCP ALG Port Pair Allocated From Quota Pool Port Batch; ‘user_quota_unusable_drop’: User-Quota Unusable Drop; ‘user_quota_unusable’: User-Quota Marked Unusable; ‘nat_pool_same_port_batch_udp_failed’: Simultaneous Batch Allocation UDP Port Allocation Failed; ‘fwd_ingress_packets_tcp’: Forward Ingress Packets TCP; ‘fwd_egress_packets_tcp’: Forward Egress Packets TCP; ‘rev_ingress_packets_tcp’: Reverse Ingress Packets TCP; ‘rev_egress_packets_tcp’: Reverse Egress Packets TCP; ‘fwd_ingress_bytes_tcp’: Forward Ingress Bytes TCP; ‘fwd_egress_bytes_tcp’: Forward Egress Bytes TCP; ‘rev_ingress_bytes_tcp’: Reverse Ingress Bytes TCP; ‘rev_egress_bytes_tcp’: Reverse Egress Bytes TCP; ‘fwd_ingress_packets_udp’: Forward Ingress Packets UDP; ‘fwd_egress_packets_udp’: Forward Egress Packets UDP; ‘rev_ingress_packets_udp’: Reverse Ingress Packets UDP; ‘rev_egress_packets_udp’: Reverse Egress Packets UDP; ‘fwd_ingress_bytes_udp’: Forward Ingress Bytes UDP; ‘fwd_egress_bytes_udp’: Forward Egress Bytes UDP; ‘rev_ingress_bytes_udp’: Reverse Ingress Bytes UDP; ‘rev_egress_bytes_udp’: Reverse Egress Bytes UDP; ‘fwd_ingress_packets_icmp’: Forward Ingress Packets ICMP; ‘fwd_egress_packets_icmp’: Forward Egress Packets ICMP; ‘rev_ingress_packets_icmp’: Reverse Ingress Packets ICMP; ‘rev_egress_packets_icmp’: Reverse Egress Packets ICMP; ‘fwd_ingress_bytes_icmp’: Forward Ingress Bytes ICMP; ‘fwd_egress_bytes_icmp’: Forward Egress Bytes ICMP; ‘rev_ingress_bytes_icmp’: Reverse Ingress Bytes ICMP; ‘rev_egress_bytes_icmp’: Reverse Egress Bytes ICMP; ‘fwd_ingress_packets_others’: Forward Ingress Packets OTHERS; ‘fwd_egress_packets_others’: Forward Egress Packets OTHERS; ‘rev_ingress_packets_others’: Reverse Ingress Packets OTHERS; ‘rev_egress_packets_others’: Reverse Egress Packets OTHERS; ‘fwd_ingress_bytes_others’: Forward Ingress Bytes OTHERS; ‘fwd_egress_bytes_others’: Forward Egress Bytes OTHERS; ‘rev_ingress_bytes_others’: Reverse Ingress Bytes OTHERS; ‘rev_egress_bytes_others’: Reverse Egress Bytes OTHERS; ‘fwd_ingress_pkt_size_range1’: Forward Ingress Packet size between 0 and 200; ‘fwd_ingress_pkt_size_range2’: Forward Ingress Packet size between 201 and 800; ‘fwd_ingress_pkt_size_range3’: Forward Ingress Packet size between 801 and 1550; ‘fwd_ingress_pkt_size_range4’: Forward Ingress Packet size between 1551 and 9000; ‘fwd_egress_pkt_size_range1’: Forward Egress Packet size between 0 and 200; ‘fwd_egress_pkt_size_range2’: Forward Egress Packet size between 201 and 800; ‘fwd_egress_pkt_size_range3’: Forward Egress Packet size between 801 and 1550; ‘fwd_egress_pkt_size_range4’: Forward Egress Packet size between 1551 and 9000; ‘rev_ingress_pkt_size_range1’: Reverse Ingress Packet size between 0 and 200; ‘rev_ingress_pkt_size_range2’: Reverse Ingress Packet size between 201 and 800; ‘rev_ingress_pkt_size_range3’: Reverse Ingress Packet size between 801 and 1550; ‘rev_ingress_pkt_size_range4’: Reverse Ingress Packet size between 1551 and 9000; ‘rev_egress_pkt_size_range1’: Reverse Egress Packet size between 0 and 200; ‘rev_egress_pkt_size_range2’: Reverse Egress Packet size between 201 and 800; ‘rev_egress_pkt_size_range3’: Reverse Egress Packet size between 801 and 1550; ‘rev_egress_pkt_size_range4’: Reverse Egress Packet size between 1551 and 9000; ‘prefix_quota_mismatch’: Prefix Quota NAT IP Mismatch;
Type: string
Supported Values: nat_pool_force_delete, quota_ext_too_many, nat_pool_not_found_on_free, standby_class_list_drop, fullcone_inbound_nat_pool_mismatch, bad_ip_tot_len, ip_checksum_verified, ip_checksum_fixed, ip_checksum_bad_drop, ip_frag_checksum_fixed, l4_checksum_verified, l4_checksum_fixed, l4_checksum_bad_drop, jumbo_list_bad_l4_len, frag_list_bad_l4_len, nat_pool_attempt_adding_multiple_free_batches, nat_pool_add_free_batch_failed, mgcp_alg_no_quota, mgcp_alg_quota_inc_failure, mgcp_alg_no_nat_ip, mgcp_alg_reuse_fullcone, mgcp_alg_fullcone_mismatch, mgcp_alg_alloc_port_failure, mgcp_alg_create_fullcone_failure, mgcp_alg_release_port_failure, mgcp_alg_single_rtp_fullcone, mgcp_alg_single_rtcp_fullcone, mgcp_alg_rtcp_fullcone_mismatch, mgcp_alg_reuse_rtp_rtcp_fullcone, mgcp_alg_alloc_rtp_rtcp_port_failure, mgcp_alg_alloc_single_port_failure, mgcp_alg_create_single_fullcone_failure, mgcp_alg_create_rtp_fullcone_failure, mgcp_alg_create_rtcp_fullcone_failure, mgcp_alg_port_pair_alloc_from_consecutive, mgcp_alg_port_pair_alloc_from_partition, mgcp_alg_port_pair_alloc_from_pool_port_batch, mgcp_alg_port_pair_alloc_from_quota_consecutive, mgcp_alg_port_pair_alloc_from_quota_partition, mgcp_alg_port_pair_alloc_from_quota_partition_error, mgcp_alg_port_pair_alloc_from_quota_pool_port_batch, user_quota_unusable_drop, user_quota_unusable, nat_pool_same_port_batch_udp_failed, fwd_ingress_packets_tcp, fwd_egress_packets_tcp, rev_ingress_packets_tcp, rev_egress_packets_tcp, fwd_ingress_bytes_tcp, fwd_egress_bytes_tcp, rev_ingress_bytes_tcp, rev_egress_bytes_tcp, fwd_ingress_packets_udp, fwd_egress_packets_udp, rev_ingress_packets_udp, rev_egress_packets_udp, fwd_ingress_bytes_udp, fwd_egress_bytes_udp, rev_ingress_bytes_udp, rev_egress_bytes_udp, fwd_ingress_packets_icmp, fwd_egress_packets_icmp, rev_ingress_packets_icmp, rev_egress_packets_icmp, fwd_ingress_bytes_icmp, fwd_egress_bytes_icmp, rev_ingress_bytes_icmp, rev_egress_bytes_icmp, fwd_ingress_packets_others, fwd_egress_packets_others, rev_ingress_packets_others, rev_egress_packets_others, fwd_ingress_bytes_others, fwd_egress_bytes_others, rev_ingress_bytes_others, rev_egress_bytes_others, fwd_ingress_pkt_size_range1, fwd_ingress_pkt_size_range2, fwd_ingress_pkt_size_range3, fwd_ingress_pkt_size_range4, fwd_egress_pkt_size_range1, fwd_egress_pkt_size_range2, fwd_egress_pkt_size_range3, fwd_egress_pkt_size_range4, rev_ingress_pkt_size_range1, rev_ingress_pkt_size_range2, rev_ingress_pkt_size_range3, rev_ingress_pkt_size_range4, rev_egress_pkt_size_range1, rev_egress_pkt_size_range2, rev_egress_pkt_size_range3, rev_egress_pkt_size_range4, prefix_quota_mismatch
ds-lite_alg¶
Specification
Value
Type
object
ftp
Description: ftp is a JSON Block. Please see below for ds-lite_alg_ftp
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/ftp
h323
Description: h323 is a JSON Block. Please see below for ds-lite_alg_h323
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/h323
mgcp
Description: mgcp is a JSON Block. Please see below for ds-lite_alg_mgcp
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/mgcp
pptp
Description: pptp is a JSON Block. Please see below for ds-lite_alg_pptp
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/pptp
rtsp
Description: rtsp is a JSON Block. Please see below for ds-lite_alg_rtsp
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for ds-lite_alg_sip
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for ds-lite_alg_tftp
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/alg/tftp
ds-lite_alg_ftp¶
Specification
Value
Type
object
ftp-enable
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_pptp¶
Specification
Value
Type
object
pptp-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_rtsp¶
Specification
Value
Type
object
rtsp-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_sip¶
Specification
Value
Type
object
sip-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_h323¶
Specification
Value
Type
object
h323-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_mgcp¶
Specification
Value
Type
object
mgcp-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_alg_tftp¶
Specification
Value
Type
object
tftp-enable
Description ‘enable’: Enable ALG;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for ds-lite_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for ds-lite_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/ds-lite/fragmentation/outbound
ds-lite_fragmentation_inbound¶
Specification
Value
Type
object
count
Description Configure number of ICMP messages sent when DF set. Default is 1
Type: number
Range: 1-5
Default: 1
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 Fragmentation; ‘ipv6’: Use IPv6 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv4, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv4, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_fragmentation_outbound¶
Specification
Value
Type
object
count
Description Configure number of ICMP messages sent when DF set. Default is 1
Type: number
Range: 1-5
Default: 1
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 Fragmentation; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmp, send-icmpv6
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMPv6 Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_port-reservation-list¶
Specification
Value
Type
list
Block object keys
inside
Description Inside User Address and Port Range (DS-Lite Inside User’s Tunnel Source IPv6 Address)
Type: string
Format: ipv6-address
inside-addr
Description Inside User IP address
Type: string
Format: ipv4-address
inside-end-port
Description Inside End Port
Type: number
Range: 1-65535
inside-start-port
Description Inside Start Port
Type: number
Range: 1-65535
nat
Description NAT Port Range (NAT IP address)
Type: string
Format: ipv4-address
nat-end-port
Description NAT End Port
Type: number
Range: 1-65535
nat-start-port
Description NAT Start Port
Type: number
Range: 1-65535
tunnel-dest-address
Description DS-Lite Inside User’s Tunnel Destination IPv6 Address
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_port-reservation-entries¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_user-quota-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ds-lite_full-cone-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sixrd¶
Specification
Value
Type
object
domain-list
Type: List
Reference Object: /axapi/v3/cgnv6/sixrd/domain/{name}
fragmentation
Description: fragmentation is a JSON Block. Please see below for sixrd_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/sixrd/fragmentation
sixrd_domain-list¶
Specification
Value
Type
list
Block object keys
br-ipv4-address
Description 6rd BR IPv4 address
Type: string
Format: ipv4-address
ce-ipv4-netmask
Description Mask length
Type: string
Format: ipv4-netmask-brief
ce-ipv4-network
Description Customer Edge IPv4 network
Type: string
Format: ipv4-address
ipv6-prefix
Description IPv6 prefix
Type: string
Format: ipv6-address-plen
mtu
Description Tunnel MTU
Type: number
Range: 1280-1480
name
Description 6rd Domain name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
sampling-enable
Type: List
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
sixrd_domain-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘outbound-tcp-packets-received’: Outbound TCP packets received; ‘outbound-udp-packets-received’: Outbound UDP packets received; ‘outbound-icmp-packets-received’: Outbound ICMP packets received; ‘outbound-other-packets-received’: Outbound other packets received; ‘outbound-packets-drop’: Outbound packets dropped; ‘outbound-ipv6-dest-unreachable’: Outbound IPv6 destination unreachable; ‘outbound-fragment-ipv6’: Outbound Fragmented IPv6; ‘inbound-tcp-packets-received’: Inbound TCP packets received; ‘inbound-udp-packets-received’: Inbound UDP packets received; ‘inbound-icmp-packets-received’: Inbound ICMP packets received; ‘inbound-other-packets-received’: Inbound other packets received; ‘inbound-packets-drop’: Inbound packets dropped; ‘inbound-ipv4-dest-unreachable’: Inbound IPv4 destination unreachable; ‘inbound-fragment-ipv4’: Inbound Fragmented IPv4; ‘inbound-tunnel-fragment-ipv6’: Inbound Fragmented IPv6 in tunnel; ‘vport-matched’: Traffic match SLB virtual port; ‘unknown-delegated-prefix’: Unknown 6rd delegated prefix; ‘packet-too-big’: Packet too big; ‘not-local-ip’: Not local IP; ‘fragment-error’: Fragment processing errors; ‘other-error’: Other errors;
Type: string
Supported Values: all, outbound-tcp-packets-received, outbound-udp-packets-received, outbound-icmp-packets-received, outbound-other-packets-received, outbound-packets-drop, outbound-ipv6-dest-unreachable, outbound-fragment-ipv6, inbound-tcp-packets-received, inbound-udp-packets-received, inbound-icmp-packets-received, inbound-other-packets-received, inbound-packets-drop, inbound-ipv4-dest-unreachable, inbound-fragment-ipv4, inbound-tunnel-fragment-ipv6, vport-matched, unknown-delegated-prefix, packet-too-big, not-local-ip, fragment-error, other-error
sixrd_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for sixrd_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/sixrd/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for sixrd_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/sixrd/fragmentation/outbound
sixrd_fragmentation_inbound¶
Specification
Value
Type
object
action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 Fragmentation for oversize packets; ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big) (default);
Type: string
Supported Values: drop, ipv4, ipv6, send-icmpv6
Default: send-icmpv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sixrd_fragmentation_outbound¶
Specification
Value
Type
object
action
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 Fragmentation for oversize packets (default); ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv6, send-icmp, send-icmpv6
Default: ipv6
count
Description Configure number of ICMP messages sent when DF set. Default is 1
Type: number
Range: 1-5
df-set
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 Fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv6, send-icmp, send-icmpv6
Default: send-icmp
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6¶
Specification
Value
Type
object
active-binding-table
Description: active-binding-table is a JSON Block. Please see below for lw-4o6_active-binding-table
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/active-binding-table
all-binding-tables
Description: all-binding-tables is a JSON Block. Please see below for lw-4o6_all-binding-tables
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/all-binding-tables
binding-table-files-status
Description: binding-table-files-status is a JSON Block. Please see below for lw-4o6_binding-table-files-status
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/binding-table-files-status
binding-table-list
Type: List
Reference Object: /axapi/v3/cgnv6/lw-4o6/binding-table/{name}
binding-table-validate
Description: binding-table-validate is a JSON Block. Please see below for lw-4o6_binding-table-validate
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/binding-table-validate
fragmentation
Description: fragmentation is a JSON Block. Please see below for lw-4o6_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/fragmentation
global
Description: global is a JSON Block. Please see below for lw-4o6_global
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/global
health-check-gateway-list
Type: List
Reference Object: /axapi/v3/cgnv6/lw-4o6/health-check-gateway/{ipv4-addr}+{ipv6-addr}
validation-log-files
Description: validation-log-files is a JSON Block. Please see below for lw-4o6_validation-log-files
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/validation-log-files
lw-4o6_global¶
Specification
Value
Type
object
hairpinning
Description ‘filter-all’: Disable all Hairpinning; ‘filter-none’: Allow all Hairpinning (default); ‘filter-self-ip’: Block Hairpinning to same IP; ‘filter-self-ip-port’: Block hairpinning to same IP and Port combination;
Type: string
Supported Values: filter-all, filter-none, filter-self-ip, filter-self-ip-port
Default: filter-none
icmp-inbound
Description ‘drop’: Drop Inbound ICMP packets; ‘handle’: Handle Inbound ICMP packets(default);
Type: string
Supported Values: drop, handle
Default: handle
inside-src-access-list
Description Access List for inside IPv4 addresses (ACL ID)
Type: number
Range: 1-199
nat-prefix-list
Description Configure LW-4over6 NAT Prefix List (LW-4over6 NAT Prefix Class-list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
no-forward-match
Description: no-forward-match is a JSON Block. Please see below for lw-4o6_global_no-forward-match
Type: Object
no-reverse-match
Description: no-reverse-match is a JSON Block. Please see below for lw-4o6_global_no-reverse-match
Type: Object
sampling-enable
Type: List
use-binding-table
Description Bind LW-4over6 binding table for use (LW-4over6 Binding Table 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
lw-4o6_global_no-forward-match¶
Specification
Value
Type
object
send-icmpv6
Description Send ICMPv6 Type 1 Code 5
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lw-4o6_global_no-reverse-match¶
Specification
Value
Type
object
send-icmp
Description Send ICMP Type 3 Code 1
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lw-4o6_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘entry_count’: Total Entries Configured; ‘self_hairpinning_drop’: Self-Hairpinning Drops; ‘all_hairpinning_drop’: All Hairpinning Drops; ‘no_match_icmpv6_sent’: No-Forward-Match ICMPv6 Sent; ‘no_match_icmp_sent’: No-Reverse-Match ICMP Sent; ‘icmp_inbound_drop’: Inbound ICMP Drops; ‘fwd_lookup_failed’: Forward Route Lookup Failed; ‘rev_lookup_failed’: Reverse Route Lookup Failed; ‘interface_not_configured’: LW-4over6 Interfaces not Configured Drops; ‘no_binding_table_matches_fwd’: No Forward Binding Table Entry Match Drops; ‘no_binding_table_matches_rev’: No Reverse Binding Table Entry Match Drops; ‘session_count’: LW-4over6 Session Count; ‘system_address_drop’: LW-4over6 System Address Drops;
Type: string
Supported Values: all, entry_count, self_hairpinning_drop, all_hairpinning_drop, no_match_icmpv6_sent, no_match_icmp_sent, icmp_inbound_drop, fwd_lookup_failed, rev_lookup_failed, interface_not_configured, no_binding_table_matches_fwd, no_binding_table_matches_rev, session_count, system_address_drop
lw-4o6_health-check-gateway-list¶
Specification
Value
Type
list
Block object keys
ipv4-addr
Description LW-4over6 IPv4 Gateway
Type: string
Format: ipv4-address
ipv6-addr
Description LW-4over6 IPv6 Gateway
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_binding-table-validate¶
Specification
Value
Type
object
binding-name
Description LW-4over6 Binding Table Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
lw-4o6_binding-table-list¶
Specification
Value
Type
list
Block object keys
name
Description LW-4over6 Binding Table Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
tunnel-address-list
Type: List
Reference Object: /axapi/v3/cgnv6/lw-4o6/binding-table/{name}/tunnel-address/{ipv6-tunnel-addr}
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
lw-4o6_binding-table-list_tunnel-address-list¶
Specification
Value
Type
list
Block object keys
ipv6-tunnel-addr
Description Tunnel IPv6 Endpoint Address
Type: string
Format: ipv6-address
nat-address-list
Type: List
Reference Object: /axapi/v3/cgnv6/lw-4o6/binding-table/{name}/tunnel-address/{ipv6-tunnel-addr}/nat-address/{ipv4-nat-addr}
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
lw-4o6_binding-table-list_tunnel-address-list_nat-address-list¶
Specification
Value
Type
list
Block object keys
ipv4-nat-addr
Description NAT IPv4 Address
Type: string
Format: ipv4-address
port-range-list
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
lw-4o6_binding-table-list_tunnel-address-list_nat-address-list_port-range-list¶
Specification
Value
Type
list
Block object keys
port-end
Description Port Range End
Type: number
Range: 1-65535
port-start
Description Single Port or Port Range Start
Type: number
Range: 1-65535
tunnel-endpoint-address
Description Configure LW-4over6 IPIP Tunnel Endpoint Address (LW-4over6 Tunnel Endpoint Address)
Type: string
Format: ipv6-address
lw-4o6_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for lw-4o6_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for lw-4o6_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/lw-4o6/fragmentation/outbound
lw-4o6_fragmentation_inbound¶
Specification
Value
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv4, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv4, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_fragmentation_outbound¶
Specification
Value
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set)(default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmp, send-icmpv6
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_active-binding-table¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_binding-table-files-status¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_all-binding-tables¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lw-4o6_validation-log-files¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall¶
Specification
Value
Type
object
alg
Description: alg is a JSON Block. Please see below for stateful-firewall_alg
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg
endpoint-independent-filtering
Description: endpoint-independent-filtering is a JSON Block. Please see below for stateful-firewall_endpoint-independent-filtering
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering
global
Description: global is a JSON Block. Please see below for stateful-firewall_global
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/global
stun-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/stateful-firewall/stun-timeout/{port}+{port-end}
tcp
Description: tcp is a JSON Block. Please see below for stateful-firewall_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/tcp
udp
Description: udp is a JSON Block. Please see below for stateful-firewall_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/udp
vrid
Description: vrid is a JSON Block. Please see below for stateful-firewall_vrid
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/vrid
stateful-firewall_global¶
Specification
Value
Type
object
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
sampling-enable
Type: List
stateful-firewall-value
Description ‘enable’: Enable stateful firewall;
Type: string
Supported Values: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘tcp_packet_process’: TCP Packet Process; ‘udp_packet_process’: UDP Packet Process; ‘other_packet_process’: Other Packet Process; ‘packet_inbound_deny’: Inbound Packet Denied; ‘packet_process_failure’: Packet Error Drop; ‘outbound_session_created’: Outbound Session Created; ‘outbound_session_freed’: Outbound Session Freed; ‘inbound_session_created’: Inbound Session Created; ‘inbound_session_freed’: Inbound Session Freed; ‘tcp_session_created’: TCP Session Created; ‘tcp_session_freed’: TCP Session Freed; ‘udp_session_created’: UDP Session Created; ‘udp_session_freed’: UDP Session Freed; ‘other_session_created’: Other Session Created; ‘other_session_freed’: Other Session Freed; ‘session_creation_failure’: Session Creation Failure; ‘no_fwd_route’: No Forward Route; ‘no_rev_route’: No Reverse Route; ‘packet_standby_drop’: Standby Drop; ‘tcp_fullcone_created’: TCP Full-cone Created; ‘tcp_fullcone_freed’: TCP Full-cone Freed; ‘udp_fullcone_created’: UDP Full-cone Created; ‘udp_fullcone_freed’: UDP Full-cone Freed; ‘fullcone_creation_failure’: Full-Cone Creation Failure; ‘eif_process’: Endpnt-Independent Filter Matched; ‘one_arm_drop’: One-Arm Drop; ‘no_class_list_match’: No Class-List Match Drop; ‘outbound_session_created_shadow’: Outbound Session Created Shadow; ‘outbound_session_freed_shadow’: Outbound Session Freed Shadow; ‘inbound_session_created_shadow’: Inbound Session Created Shadow; ‘inbound_session_freed_shadow’: Inbound Session Freed Shadow; ‘tcp_session_created_shadow’: TCP Session Created Shadow; ‘tcp_session_freed_shadow’: TCP Session Freed Shadow; ‘udp_session_created_shadow’: UDP Session Created Shadow; ‘udp_session_freed_shadow’: UDP Session Freed Shadow; ‘other_session_created_shadow’: Other Session Created Shadow; ‘other_session_freed_shadow’: Other Session Freed Shadow; ‘session_creation_failure_shadow’: Session Creation Failure Shadow; ‘bad_session_freed’: Bad Session Proto on Free; ‘ctl_mem_alloc’: Memory Alloc; ‘ctl_mem_free’: Memory Free; ‘tcp_fullcone_created_shadow’: TCP Full-cone Created Shadow; ‘tcp_fullcone_freed_shadow’: TCP Full-cone Freed Shadow; ‘udp_fullcone_created_shadow’: UDP Full-cone Created Shadow; ‘udp_fullcone_freed_shadow’: UDP Full-cone Freed Shadow; ‘fullcone_in_del_q’: Full-cone Found in Delete Queue; ‘fullcone_overflow_eim’: EIM Overflow; ‘fullcone_overflow_eif’: EIF Overflow; ‘fullcone_free_found’: Full-cone Free Found From Conn; ‘fullcone_free_retry_lookup’: Full-cone Retry Look-up; ‘fullcone_free_not_found’: Full-cone Free Not Found; ‘eif_limit_exceeded’: EIF Limit Exceeded; ‘eif_disable_drop’: EIF Disable Drop; ‘eif_process_failure’: EIF Process Failure; ‘eif_filtered’: EIF Filtered; ‘ha_standby_session_created’: HA Standby Session Created; ‘ha_standby_session_eim’: HA Standby Session EIM; ‘ha_standby_session_eif’: HA Standby Session EIF;
Type: string
Supported Values: all, tcp_packet_process, udp_packet_process, other_packet_process, packet_inbound_deny, packet_process_failure, outbound_session_created, outbound_session_freed, inbound_session_created, inbound_session_freed, tcp_session_created, tcp_session_freed, udp_session_created, udp_session_freed, other_session_created, other_session_freed, session_creation_failure, no_fwd_route, no_rev_route, packet_standby_drop, tcp_fullcone_created, tcp_fullcone_freed, udp_fullcone_created, udp_fullcone_freed, fullcone_creation_failure, eif_process, one_arm_drop, no_class_list_match, outbound_session_created_shadow, outbound_session_freed_shadow, inbound_session_created_shadow, inbound_session_freed_shadow, tcp_session_created_shadow, tcp_session_freed_shadow, udp_session_created_shadow, udp_session_freed_shadow, other_session_created_shadow, other_session_freed_shadow, session_creation_failure_shadow, bad_session_freed, ctl_mem_alloc, ctl_mem_free, tcp_fullcone_created_shadow, tcp_fullcone_freed_shadow, udp_fullcone_created_shadow, udp_fullcone_freed_shadow, fullcone_in_del_q, fullcone_overflow_eim, fullcone_overflow_eif, fullcone_free_found, fullcone_free_retry_lookup, fullcone_free_not_found, eif_limit_exceeded, eif_disable_drop, eif_process_failure, eif_filtered, ha_standby_session_created, ha_standby_session_eim, ha_standby_session_eif
stateful-firewall_alg¶
Specification
Value
Type
object
ftp
Description: ftp is a JSON Block. Please see below for stateful-firewall_alg_ftp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/ftp
pptp
Description: pptp is a JSON Block. Please see below for stateful-firewall_alg_pptp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/pptp
rtp
Description: rtp is a JSON Block. Please see below for stateful-firewall_alg_rtp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/rtp
rtsp
Description: rtsp is a JSON Block. Please see below for stateful-firewall_alg_rtsp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for stateful-firewall_alg_sip
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for stateful-firewall_alg_tftp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/alg/tftp
stateful-firewall_alg_ftp¶
Specification
Value
Type
object
ftp-value
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_ftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘client-port-request’: PORT Requests From Client; ‘client-eprt-request’: EPRT Requests From Client; ‘server-pasv-reply’: PASV Replies From Server; ‘server-epsv-reply’: EPSV Replies From Server; ‘port-retransmits’: PORT Retransmits; ‘pasv-retransmits’: PASV Retransmits; ‘smp-app-type-mismatch’: SMP App Type Mismatch; ‘retransmit-sanity-check-failure’: Retransmit Sanity Check Failure; ‘smp-conn-alloc-failure’: SMP Helper Conn Alloc Failure; ‘port-helper-created’: PORT Helper Created; ‘pasv-helper-created’: PASV Helper Created; ‘port-helper-acquire-in-del-q’: PORT Helper Acquire In Del Queue; ‘port-helper-acquire-already-used’: PORT Helper Acquire Already Used; ‘pasv-helper-acquire-in-del-q’: PASV Helper Acquire In Del Queue; ‘pasv-helper-acquire-already-used’: PASV Helper Acquire Already Used; ‘port-helper-freed-used’: PORT Helper Freed Used; ‘port-helper-freed-unused’: PORT Helper Freed Unused; ‘pasv-helper-freed-used’: PASV Helper Freed Used; ‘pasv-helper-freed-unused’: PASV Helper Freed Unused;
Type: string
Supported Values: all, client-port-request, client-eprt-request, server-pasv-reply, server-epsv-reply, port-retransmits, pasv-retransmits, smp-app-type-mismatch, retransmit-sanity-check-failure, smp-conn-alloc-failure, port-helper-created, pasv-helper-created, port-helper-acquire-in-del-q, port-helper-acquire-already-used, pasv-helper-acquire-in-del-q, pasv-helper-acquire-already-used, port-helper-freed-used, port-helper-freed-unused, pasv-helper-freed-used, pasv-helper-freed-unused
stateful-firewall_alg_pptp¶
Specification
Value
Type
object
pptp-value
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_pptp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘calls-established’: Calls Established; ‘call-req-pns-call-id-mismatch’: Call ID Mismatch on Call Request; ‘call-reply-pns-call-id-mismatch’: Call ID Mismatch on Call Reply; ‘gre-session-created’: GRE Session Created; ‘gre-session-freed’: GRE Session Freed; ‘call-req-retransmit’: Call Request Retransmit; ‘call-req-new’: Call Request New; ‘call-req-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘call-reply-call-id-unknown’: Call Reply Unknown Client Call ID; ‘call-reply-retransmit’: Call Reply Retransmit; ‘call-reply-ext-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘smp-app-type-mismatch’: SMP App Type Mismatch; ‘smp-client-call-id-mismatch’: SMP Client Call ID Mismatch; ‘smp-sessions-created’: SMP Session Created; ‘smp-sessions-freed’: SMP Session Freed; ‘smp-alloc-failure’: SMP Session Alloc Failure; ‘gre-conn-creation-failure’: GRE Conn Alloc Failure; ‘gre-conn-ext-creation-failure’: GRE Conn Ext Alloc Failure; ‘gre-no-fwd-route’: GRE No Fwd Route; ‘gre-no-rev-route’: GRE No Rev Route; ‘gre-no-control-conn’: GRE No Control Conn; ‘gre-conn-already-exists’: GRE Conn Already Exists; ‘gre-free-no-ext’: GRE Free No Ext; ‘gre-free-no-smp’: GRE Free No SMP; ‘gre-free-smp-app-type-mismatch’: GRE Free SMP App Type Mismatch; ‘control-freed’: Control Session Freed; ‘control-free-no-ext’: Control Free No Ext; ‘control-free-no-smp’: Control Free No SMP; ‘control-free-smp-app-type-mismatch’: Control Free SMP App Type Mismatch;
Type: string
Supported Values: all, calls-established, call-req-pns-call-id-mismatch, call-reply-pns-call-id-mismatch, gre-session-created, gre-session-freed, call-req-retransmit, call-req-new, call-req-ext-alloc-failure, call-reply-call-id-unknown, call-reply-retransmit, call-reply-ext-ext-alloc-failure, smp-app-type-mismatch, smp-client-call-id-mismatch, smp-sessions-created, smp-sessions-freed, smp-alloc-failure, gre-conn-creation-failure, gre-conn-ext-creation-failure, gre-no-fwd-route, gre-no-rev-route, gre-no-control-conn, gre-conn-already-exists, gre-free-no-ext, gre-free-no-smp, gre-free-smp-app-type-mismatch, control-freed, control-free-no-ext, control-free-no-smp, control-free-smp-app-type-mismatch
stateful-firewall_alg_rtp¶
Specification
Value
Type
object
rtp-stun-timeout
Description RTP/RTCP STUN timeout (default: 5 minutes)}
Type: number
Range: 2-10
Default: 5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_rtsp¶
Specification
Value
Type
object
rtsp-value
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_rtsp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘transport-inserted’: Transport Created; ‘transport-freed’: Transport Freed; ‘transport-alloc-failure’: Transport Alloc Failure; ‘data-session-created’: Data Session Created; ‘data-session-freed’: Data Session Freed; ‘ext-creation-failure’: Extension Creation Failure; ‘transport-add-to-ext’: Transport Added to Extension; ‘transport-removed-from-ext’: Transport Removed from Extension; ‘transport-too-many’: Too Many Transports for Control Conn; ‘transport-already-in-ext’: Transport Already in Extension; ‘transport-exists’: Transport Already Exists; ‘transport-link-ext-failure-control’: Transport Link to Extension Failure Control; ‘transport-link-ext-data’: Transport Link to Extension Data; ‘transport-link-ext-failure-data’: Transport Link to Extension Failure Data; ‘transport-inserted-shadow’: Transport Inserted Shadow; ‘transport-creation-race’: Transport Create Race; ‘transport-alloc-failure-shadow’: Transport Alloc Failure Shadow; ‘transport-put-in-del-q’: Transport Put in Delete Queue; ‘transport-freed-shadow’: Transport Freed Shadow; ‘transport-acquired-from-control’: Transport Acquired Control; ‘transport-found-from-prev-control’: Transport Found From Prev Control; ‘transport-acquire-failure-from-control’: Transport Acquire Failure Control; ‘transport-released-from-control’: Transport Released Control; ‘transport-double-release-from-control’: Transport Double Release Control; ‘transport-acquired-from-data’: Transport Acquired Data; ‘transport-acquire-failure-from-data’: Transport Acquire Failure Data; ‘transport-released-from-data’: Transport Released Data; ‘transport-double-release-from-data’: Transport Double Release Data; ‘transport-retry-lookup-on-data-free’: Transport Retry Lookup Data; ‘transport-not-found-on-data-free’: Transport Not Found Data; ‘data-session-created-shadow’: Data Session Created Shadow; ‘data-session-freed-shadow’: Data Session Freed Shadow; ‘ha-control-ext-creation-failure’: HA Control Extension Creation Failure; ‘ha-control-session-created’: HA Control Session Created; ‘ha-data-session-created’: HA Data Session Created;
Type: string
Supported Values: all, transport-inserted, transport-freed, transport-alloc-failure, data-session-created, data-session-freed, ext-creation-failure, transport-add-to-ext, transport-removed-from-ext, transport-too-many, transport-already-in-ext, transport-exists, transport-link-ext-failure-control, transport-link-ext-data, transport-link-ext-failure-data, transport-inserted-shadow, transport-creation-race, transport-alloc-failure-shadow, transport-put-in-del-q, transport-freed-shadow, transport-acquired-from-control, transport-found-from-prev-control, transport-acquire-failure-from-control, transport-released-from-control, transport-double-release-from-control, transport-acquired-from-data, transport-acquire-failure-from-data, transport-released-from-data, transport-double-release-from-data, transport-retry-lookup-on-data-free, transport-not-found-on-data-free, data-session-created-shadow, data-session-freed-shadow, ha-control-ext-creation-failure, ha-control-session-created, ha-data-session-created
stateful-firewall_alg_sip¶
Specification
Value
Type
object
sampling-enable
Type: List
sip-value
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_sip_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘stat-request’: Request Received; ‘stat-response’: Response Received; ‘method-register’: Method REGISTER; ‘method-invite’: Method INVITE; ‘method-ack’: Method ACK; ‘method-cancel’: Method CANCEL; ‘method-bye’: Method BYE; ‘method-port-config’: Method OPTIONS; ‘method-prack’: Method PRACK; ‘method-subscribe’: Method SUBSCRIBE; ‘method-notify’: Method NOTIFY; ‘method-publish’: Method PUBLISH; ‘method-info’: Method INFO; ‘method-refer’: Method REFER; ‘method-message’: Method MESSAGE; ‘method-update’: Method UPDATE; ‘method-unknown’: Method Unknown; ‘parse-error’: Message Parse Error; ‘keep-alive’: Keep Alive; ‘contact-error’: Contact Process Error; ‘sdp-error’: SDP Process Error; ‘rtp-port-no-op’: RTP Port No Op; ‘rtp-rtcp-port-success’: RTP RTCP Port Success; ‘rtp-port-failure’: RTP Port Failure; ‘rtcp-port-failure’: RTCP Port Failure; ‘contact-port-no-op’: Contact Port No Op; ‘contact-port-success’: Contact Port Success; ‘contact-port-failure’: Contact Port Failure; ‘contact-new’: Contact Alloc; ‘contact-alloc-failure’: Contact Alloc Failure; ‘contact-eim’: Contact EIM; ‘contact-eim-set’: Contact EIM Set; ‘rtp-new’: RTP Alloc; ‘rtp-alloc-failure’: RTP Alloc Failure; ‘rtp-eim’: RTP EIM;
Type: string
Supported Values: all, stat-request, stat-response, method-register, method-invite, method-ack, method-cancel, method-bye, method-port-config, method-prack, method-subscribe, method-notify, method-publish, method-info, method-refer, method-message, method-update, method-unknown, parse-error, keep-alive, contact-error, sdp-error, rtp-port-no-op, rtp-rtcp-port-success, rtp-port-failure, rtcp-port-failure, contact-port-no-op, contact-port-success, contact-port-failure, contact-new, contact-alloc-failure, contact-eim, contact-eim-set, rtp-new, rtp-alloc-failure, rtp-eim
stateful-firewall_alg_tftp¶
Specification
Value
Type
object
sampling-enable
Type: List
tftp-value
Description ‘disable’: Disable ALG;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_alg_tftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: TFTP Client Sessions created; ‘helper-created’: TFTP Helper Sessions created; ‘helper-freed’: TFTP Helper Sessions freed; ‘helper-freed-used’: TFTP Helper Sessions freed used; ‘helper-freed-unused’: TFTP Helper Sessions freed unused; ‘helper-already-used’: TFTP Helper Session already used; ‘helper-in-rml’: TFTP Helper Session in Remove List;
Type: string
Supported Values: all, session-created, helper-created, helper-freed, helper-freed-used, helper-freed-unused, helper-already-used, helper-in-rml
stateful-firewall_endpoint-independent-filtering¶
Specification
Value
Type
object
tcp
Description: tcp is a JSON Block. Please see below for stateful-firewall_endpoint-independent-filtering_tcp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering/tcp
udp
Description: udp is a JSON Block. Please see below for stateful-firewall_endpoint-independent-filtering_udp
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering/udp
stateful-firewall_endpoint-independent-filtering_tcp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_endpoint-independent-filtering_tcp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
stateful-firewall_endpoint-independent-filtering_udp¶
Specification
Value
Type
object
port-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_endpoint-independent-filtering_udp_port-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
port-end
Description Port Range End
Type: number
stateful-firewall_stun-timeout-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
Range: 1-65535
port-end
Description Port Range End
Type: number
Range: 1-65535
stun-timeout-val-port-range
Description STUN timeout (default: 2 minutes)
Type: number
Range: 0-60
Default: 2
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_tcp¶
Specification
Value
Type
object
idle-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/stateful-firewall/tcp/idle-timeout/{port}+{port-end}
stun-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/stateful-firewall/tcp/stun-timeout/{port}+{port-end}
syn-timeout
Description: syn-timeout is a JSON Block. Please see below for stateful-firewall_tcp_syn-timeout
Type: Object
Reference Object: /axapi/v3/cgnv6/stateful-firewall/tcp/syn-timeout
stateful-firewall_tcp_idle-timeout-list¶
Specification
Value
Type
list
Block object keys
idle-timeout-val-port-range
Description Set Idle timeout for IPv4 and IPv6 TCP established sessions (Idle timeout for IPv4 and IPv6 TCP established sessions (default: 300 seconds))
Type: number
Range: 60-15000
Default: 300
port
Description Single Destination Port or Port Range Start
Type: number
Range: 1-65535
port-end
Description Port Range End
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_tcp_stun-timeout-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
Range: 1-65535
port-end
Description Port Range End
Type: number
Range: 1-65535
stun-timeout-val-port-range
Description STUN timeout (default: 2minutes)
Type: number
Range: 0-60
Default: 2
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_tcp_syn-timeout¶
Specification
Value
Type
object
syn-timeout-val
Description Set Seconds session can remain in half-open state before being deleted (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
stateful-firewall_udp¶
Specification
Value
Type
object
idle-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}
stun-timeout-list
Type: List
Reference Object: /axapi/v3/cgnv6/stateful-firewall/udp/stun-timeout/{port}+{port-end}
stateful-firewall_udp_idle-timeout-list¶
Specification
Value
Type
list
Block object keys
fast
Description Fast aging for idle sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: fast and idle-timeout-val-port-range are mutually exclusive
idle-timeout-val-port-range
Description Idle timeout for IPv4 and IPv6 TCP established sessions (Idle timeout for IPv4 and IPv6 TCP established sessions (default: 300 seconds))
Type: number
Range: 60-15000
Default: 300
Mutual Exclusion: idle-timeout-val-port-range and fast are mutually exclusive
port
Description Single Destination Port or Port Range Start
Type: number
Range: 1-65535
port-end
Description Port Range End
Type: number
Range: 1-65535
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_udp_stun-timeout-list¶
Specification
Value
Type
list
Block object keys
port
Description Single Destination Port or Port Range Start
Type: number
Range: 1-65535
port-end
Description Port Range End
Type: number
Range: 1-65535
stun-timeout-val-port-range
Description STUN timeout (default: 2 minutes)
Type: number
Range: 0-60
Default: 2
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stateful-firewall_vrid¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid-value
Description Set VRRP-A vrid for stateful firewall (IPv4 and IPv6)
Type: number
Range: 1-31
nat46-stateless¶
Specification
Value
Type
object
fragmentation
Description: fragmentation is a JSON Block. Please see below for nat46-stateless_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless/fragmentation
global
Description: global is a JSON Block. Please see below for nat46-stateless_global
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless/global
partition-prefix-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat46-stateless/partition-prefix/{partition}
prefix
Description: prefix is a JSON Block. Please see below for nat46-stateless_prefix
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless/prefix
static-dest-mapping-list
Type: List
Reference Object: /axapi/v3/cgnv6/nat46-stateless/static-dest-mapping/{v4-address}+{v6-address}
nat46-stateless_global¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat46-stateless_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘outbound_ipv4_received’: Outbound IPv4 packets received; ‘outbound_ipv4_drop’: Outbound IPv4 packets dropped; ‘outbound_ipv4_fragment_received’: Outbound IPv4 fragment packets received; ‘outbound_ipv6_unreachable’: Outbound IPv6 destination unreachable; ‘outbound_ipv6_fragmented’: Outbound IPv6 packets fragmented; ‘inbound_ipv6_received’: Inbound IPv6 packets received; ‘inbound_ipv6_drop’: Inbound IPv6 packets dropped; ‘inbound_ipv6_fragment_received’: Inbound IPv6 fragment packets received; ‘inbound_ipv4_unreachable’: Inbound IPv4 destination unreachable; ‘inbound_ipv4_fragmented’: Inbound IPv4 packets fragmented; ‘packet_too_big’: Packet too big; ‘fragment_error’: Fragment processing errors; ‘icmpv6_to_icmp’: ICMPv6 to ICMP; ‘icmpv6_to_icmp_error’: ICMPv6 to ICMP errors; ‘icmp_to_icmpv6’: ICMP to ICMPv6; ‘icmp_to_icmpv6_error’: ICMP to ICMPv6 errors; ‘ha_standby’: HA is standby; ‘other_error’: Other errors; ‘conn_count’: conn count;
Type: string
Supported Values: all, outbound_ipv4_received, outbound_ipv4_drop, outbound_ipv4_fragment_received, outbound_ipv6_unreachable, outbound_ipv6_fragmented, inbound_ipv6_received, inbound_ipv6_drop, inbound_ipv6_fragment_received, inbound_ipv4_unreachable, inbound_ipv4_fragmented, packet_too_big, fragment_error, icmpv6_to_icmp, icmpv6_to_icmp_error, icmp_to_icmpv6, icmp_to_icmpv6_error, ha_standby, other_error, conn_count
nat46-stateless_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for nat46-stateless_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for nat46-stateless_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/nat46-stateless/fragmentation/outbound
nat46-stateless_fragmentation_inbound¶
Specification
Value
Type
object
action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat46-stateless_fragmentation_outbound¶
Specification
Value
Type
object
action
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 Fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv6
Default: ipv6
count
Description Configure number of ICMP messages sent when DF set. Default is 1
Type: number
Range: 1-5
Default: 1
df-set
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 Fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv6, send-icmp
Default: send-icmp
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat46-stateless_prefix¶
Specification
Value
Type
object
ipv6-prefix
Description IPv6 prefix
Type: string
Format: ipv6-address-plen
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
nat46-stateless_partition-prefix-list¶
Specification
Value
Type
list
Block object keys
ipv6-prefix
Description IPv6 prefix
Type: string
Format: ipv6-address-plen
partition
Description Partition Name
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
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
nat46-stateless_static-dest-mapping-list¶
Specification
Value
Type
list
Block object keys
count
Description Set number of consecutive mappings (Number of mappings)
Type: number
shared
Description Share/Expose this mapping with other partitions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
to-shared
Description Send NATed traffic through shared partition
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
v4-address
Description IPv4 address
Type: string
Format: ipv4-address
v6-address
Description IPv6 address
Type: string
Format: ipv6-address
vrid
Description VRRP-A vrid (Specify ha VRRP-A vrid)
Type: number
Range: 1-31
fixed-nat¶
Specification
Value
Type
object
alg
Description: alg is a JSON Block. Please see below for fixed-nat_alg
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg
disable
Description: disable is a JSON Block. Please see below for fixed-nat_disable
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/disable
disabled-config
Description: disabled-config is a JSON Block. Please see below for fixed-nat_disabled-config
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/disabled-config
full-cone-session
Description: full-cone-session is a JSON Block. Please see below for fixed-nat_full-cone-session
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/full-cone-session
global
Description: global is a JSON Block. Please see below for fixed-nat_global
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/global
histogram
Description: histogram is a JSON Block. Please see below for fixed-nat_histogram
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/histogram
inside
Description: inside is a JSON Block. Please see below for fixed-nat_inside
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/inside
per-instance
Description: per-instance is a JSON Block. Please see below for fixed-nat_per-instance
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/per-instance
port-mapping
Description: port-mapping is a JSON Block. Please see below for fixed-nat_port-mapping
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/port-mapping
port-mapping-files
Description: port-mapping-files is a JSON Block. Please see below for fixed-nat_port-mapping-files
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/port-mapping-files
user-quota
Description: user-quota is a JSON Block. Please see below for fixed-nat_user-quota
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/user-quota
fixed-nat_full-cone-session¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_global¶
Specification
Value
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
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_global_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘total-nat-in-use’: Total NAT Addresses in-use; ‘total-tcp-allocated’: Total TCP Ports Allocated; ‘total-tcp-freed’: Total TCP Ports Freed; ‘total-udp-allocated’: Total UDP Ports Allocated; ‘total-udp-freed’: Total UDP Ports Freed; ‘total-icmp-allocated’: Total ICMP Ports Allocated; ‘total-icmp-freed’: Total ICMP Ports Freed; ‘nat44-data-session-created’: NAT44 Data Sessions Created; ‘nat44-data-session-freed’: NAT44 Data Sessions Freed; ‘nat64-data-session-created’: NAT64 Data Sessions Created; ‘nat64-data-session-freed’: NAT64 Data Sessions Freed; ‘dslite-data-session-created’: DS-Lite Data Sessions Created; ‘dslite-data-session-freed’: DS-Lite Data Sessions Freed; ‘nat-port-unavailable-tcp’: TCP NAT Port Unavailable; ‘nat-port-unavailable-udp’: UDP NAT Port Unavailable; ‘nat-port-unavailable-icmp’: ICMP NAT Port Unavailable; ‘session-user-quota-exceeded’: Sessions User Quota Exceeded; ‘nat44-tcp-fullcone-created’: NAT44 TCP Full-Cone Created; ‘nat44-tcp-fullcone-freed’: NAT44 TCP Full-Cone Freed; ‘nat44-udp-fullcone-created’: NAT44 UDP Full-Cone Created; ‘nat44-udp-fullcone-freed’: NAT44 UDP Full-Cone Freed; ‘nat44-udp-alg-fullcone-created’: NAT44 UDP ALG Full-Cone Created; ‘nat44-udp-alg-fullcone-freed’: NAT44 UDP ALG Full-Cone Freed; ‘nat64-tcp-fullcone-created’: NAT64 TCP Full-Cone Created; ‘nat64-tcp-fullcone-freed’: NAT64 TCP Full-Cone Freed; ‘nat64-udp-fullcone-created’: NAT64 UDP Full-Cone Created; ‘nat64-udp-fullcone-freed’: NAT64 UDP Full-Cone Freed; ‘nat64-udp-alg-fullcone-created’: NAT64 UDP ALG Full-Cone Created; ‘nat64-udp-alg-fullcone-freed’: NAT64 UDP ALG Full-Cone Freed; ‘dslite-tcp-fullcone-created’: DS-Lite TCP Full-Cone Created; ‘dslite-tcp-fullcone-freed’: DS-Lite TCP Full-Cone Freed; ‘dslite-udp-fullcone-created’: DS-Lite UDP Full-Cone Created; ‘dslite-udp-fullcone-freed’: DS-Lite UDP Full-Cone Freed; ‘dslite-udp-alg-fullcone-created’: DS-Lite UDP ALG Full-Cone Created; ‘dslite-udp-alg-fullcone-freed’: DS-Lite UDP ALG Full-Cone Freed; ‘fullcone-failure’: Full-Cone Session Creation Failed; ‘nat44-eim-match’: NAT44 Endpoint-Independent-Mapping Matched; ‘nat64-eim-match’: NAT64 Endpoint-Independent-Mapping Matched; ‘dslite-eim-match’: DS-Lite Endpoint-Independent-Mapping Matched; ‘nat44-eif-match’: NAT44 Endpoint-Independent-Filtering Matched; ‘nat64-eif-match’: NAT64 Endpoint-Independent-Filtering Matched; ‘dslite-eif-match’: DS-Lite Endpoint-Independent-Filtering Matched; ‘nat44-inbound-filtered’: NAT44 Endpoint-Dependent Filtering Drop; ‘nat64-inbound-filtered’: NAT64 Endpoint-Dependent Filtering Drop; ‘dslite-inbound-filtered’: DS-Lite Endpoint-Dependent Filtering Drop; ‘nat44-eif-limit-exceeded’: NAT44 Endpoint-Independent-Filtering Limit Exceeded; ‘nat64-eif-limit-exceeded’: NAT64 Endpoint-Independent-Filtering Limit Exceeded; ‘dslite-eif-limit-exceeded’: DS-Lite Endpoint-Independent-Filtering Limit Exceeded; ‘nat44-hairpin’: NAT44 Hairpin Session Created; ‘nat64-hairpin’: NAT64 Hairpin Session Created; ‘dslite-hairpin’: DS-Lite Hairpin Session Created; ‘standby-drop’: Fixed NAT LID Standby Drop; ‘fixed-nat-fullcone-self-hairpinning-drop’: Self-Hairpinning Drop; ‘sixrd-drop’: Fixed NAT IPv6 in IPv4 Packet Drop; ‘dest-rlist-drop’: Fixed NAT Dest Rule List Drop; ‘dest-rlist-pass-through’: Fixed NAT Dest Rule List Pass-Through; ‘dest-rlist-snat-drop’: Fixed NAT Dest Rules List Source NAT Drop; ‘cross-cpu-helper-created’: Cross CPU Helper Session Created; ‘cross-cpu-helper-free-retry-lookup’: Cross CPU Helper Session Free Retry Lookup; ‘cross-cpu-helper-free-not-found’: Cross CPU Helper Session Free not Found; ‘cross-cpu-helper-free’: Cross CPU Helper Session Freed; ‘cross-cpu-rcv’: Cross CPU Helper Packets Received; ‘cross-cpu-bad-l3’: Cross CPU Unsupported L3; ‘cross-cpu-bad-l4’: Cross CPU Unsupported L4; ‘cross-cpu-no-session’: Cross CPU no Session Found; ‘cross-cpu-helper-deleted’: Cross CPU Helper Session Deleted; ‘cross-cpu-helper-fixed-nat-lid-standby’: Cross CPU Helper Fixed NAT LID Standby; ‘cross-cpu-helper-cpu-mismatch’: Cross CPU Helper CPU Mismatch; ‘cross-cpu-sent’: Cross CPU Helper Packets Sent; ‘config-not-found’: Fixed NAT Config not Found; ‘fullcone-in-del-q’: Full-Cone Session in Delete Queue; ‘fullcone-overflow’: Full-Cone Session Conn-Count Overflow; ‘fullcone-inbound-idx-mismatch’: Full-Cone Session Fixed NAT LID mismatch; ‘fullcone-retry-lookup’: Full-cone session retry look-up; ‘fullcone-not-found’: Full-cone session not found; ‘fullcone-overflow-eim’: Full-cone EIM Overflow; ‘fullcone-overflow-eif’: Full-cone EIF Overflow; ‘ha-config-mismatch’: HA Fixed NAT Config Mismatch; ‘ha-user-quota-exceeded’: HA User Quota Exceeded; ‘ha-fullcone-mismatch’: HA Full-Cone Mismatch; ‘ha-dnat-mismatch’: HA Destination NAT Config Mismatch; ‘ha-nat-port-unavailable’: HA NAT Port Unavailable; ‘ha-fullcone-failure’: HA Full-Cone Failure; ‘ha-endpoint-indep-map-match’: HA Endpoint-Independent-Mapping Match; ‘udp-alg-eim-mismatch’: UDP ALG Endpoint-Independent Mapping Mismatch; ‘udp-alg-no-nat-ip’: UDP ALG User-Quota Unknown NAT IP; ‘udp-alg-alloc-failure’: UDP ALG Port Allocation Failure; ‘mtu-exceeded’: Packet Exceeded MTU; ‘frag’: Fragmented Packets; ‘frag-icmp’: ICMP Packet Too Big Sent; ‘periodic-log-msg-alloc’: Fixed NAT Periodic Log Msg Allocated; ‘periodic-log-msg-free’: Fixed NAT Periodic Log Msg Freed; ‘disable-log-msg-alloc’: Fixed NAT Disable Log Msg Allocated; ‘disable-log-msg-free’: Fixed NAT Disable Log Msg Freed; ‘sip-alg-reuse-contact-fullcone’: SIP ALG Reuse Contact Full-cone Session; ‘sip-alg-contact-fullcone-mismatch’: SIP ALG Contact Full-cone Session Mismatch; ‘sip-alg-create-contact-fullcone-failure’: SIP ALG Create Contact Full-cone Session Failure; ‘sip-alg-single-rtp-fullcone’: SIP ALG Single RTP Full-cone Found; ‘sip-alg-rtcp-fullcone-mismatch’: SIP ALG RTCP Full-cone NAT Port Mismatch; ‘sip-alg-reuse-rtp-rtcp-fullcone’: SIP ALG Reuse RTP/RTCP Full-cone Session; ‘sip-alg-single-rtcp-fullcone’: SIP ALG Single RTCP Full-cone Found; ‘sip-alg-create-rtp-fullcone-failure’: SIP ALG Create RTP Full-cone Session Failure; ‘sip-alg-create-rtcp-fullcone-failure’: SIP ALG Create RTCP Full-cone Session Failure; ‘icmp-out-of-state-uqe-admin-filtered-sent’: Total User Quota Exceeded ICMP admin filtered sent; ‘icmp-out-of-state-uqe-host-unreachable-sent’: Total User Quota Exceeded ICMP host unreachable sent; ‘icmp-out-of-state-uqe-dropped’: Total User Queue Exceeded ICMP notification dropped; ‘nat-esp-ip-conflicts’: Fixed NAT ESP IP Conflicts; ‘total-tcp-allocated-shadow’: Total TCP Ports Allocated; ‘total-tcp-freed-shadow’: Total TCP Ports Freed; ‘total-udp-allocated-shadow’: Total UDP Ports Allocated; ‘total-udp-freed-shadow’: Total UDP Ports Freed; ‘total-icmp-allocated-shadow’: Total ICMP Ports Allocated; ‘total-icmp-freed-shadow’: Total ICMP Ports Freed; ‘nat44-data-session-created-shadow’: NAT44 Data Sessions Created; ‘nat44-data-session-freed-shadow’: NAT44 Data Sessions Freed; ‘nat64-data-session-created-shadow’: NAT64 Data Sessions Created; ‘nat64-data-session-freed-shadow’: NAT64 Data Sessions Freed; ‘dslite-data-session-created-shadow’: DS-Lite Data Sessions Created; ‘dslite-data-session-freed-shadow’: DS-Lite Data Sessions Freed; ‘nat44-tcp-fullcone-created-shadow’: NAT44 TCP Full-Cone Created; ‘nat44-tcp-fullcone-freed-shadow’: NAT44 TCP Full-Cone Freed; ‘nat44-udp-fullcone-created-shadow’: NAT44 UDP Full-Cone Created; ‘nat44-udp-fullcone-freed-shadow’: NAT44 UDP Full-Cone Freed; ‘nat44-udp-alg-fullcone-created-shadow’: NAT44 UDP ALG Full-Cone Created;
Type: string
Supported Values: all, total-nat-in-use, total-tcp-allocated, total-tcp-freed, total-udp-allocated, total-udp-freed, total-icmp-allocated, total-icmp-freed, nat44-data-session-created, nat44-data-session-freed, nat64-data-session-created, nat64-data-session-freed, dslite-data-session-created, dslite-data-session-freed, nat-port-unavailable-tcp, nat-port-unavailable-udp, nat-port-unavailable-icmp, session-user-quota-exceeded, nat44-tcp-fullcone-created, nat44-tcp-fullcone-freed, nat44-udp-fullcone-created, nat44-udp-fullcone-freed, nat44-udp-alg-fullcone-created, nat44-udp-alg-fullcone-freed, nat64-tcp-fullcone-created, nat64-tcp-fullcone-freed, nat64-udp-fullcone-created, nat64-udp-fullcone-freed, nat64-udp-alg-fullcone-created, nat64-udp-alg-fullcone-freed, dslite-tcp-fullcone-created, dslite-tcp-fullcone-freed, dslite-udp-fullcone-created, dslite-udp-fullcone-freed, dslite-udp-alg-fullcone-created, dslite-udp-alg-fullcone-freed, fullcone-failure, nat44-eim-match, nat64-eim-match, dslite-eim-match, nat44-eif-match, nat64-eif-match, dslite-eif-match, nat44-inbound-filtered, nat64-inbound-filtered, dslite-inbound-filtered, nat44-eif-limit-exceeded, nat64-eif-limit-exceeded, dslite-eif-limit-exceeded, nat44-hairpin, nat64-hairpin, dslite-hairpin, standby-drop, fixed-nat-fullcone-self-hairpinning-drop, sixrd-drop, dest-rlist-drop, dest-rlist-pass-through, dest-rlist-snat-drop, cross-cpu-helper-created, cross-cpu-helper-free-retry-lookup, cross-cpu-helper-free-not-found, cross-cpu-helper-free, cross-cpu-rcv, cross-cpu-bad-l3, cross-cpu-bad-l4, cross-cpu-no-session, cross-cpu-helper-deleted, cross-cpu-helper-fixed-nat-lid-standby, cross-cpu-helper-cpu-mismatch, cross-cpu-sent, config-not-found, fullcone-in-del-q, fullcone-overflow, fullcone-inbound-idx-mismatch, fullcone-retry-lookup, fullcone-not-found, fullcone-overflow-eim, fullcone-overflow-eif, ha-config-mismatch, ha-user-quota-exceeded, ha-fullcone-mismatch, ha-dnat-mismatch, ha-nat-port-unavailable, ha-fullcone-failure, ha-endpoint-indep-map-match, udp-alg-eim-mismatch, udp-alg-no-nat-ip, udp-alg-alloc-failure, mtu-exceeded, frag, frag-icmp, periodic-log-msg-alloc, periodic-log-msg-free, disable-log-msg-alloc, disable-log-msg-free, sip-alg-reuse-contact-fullcone, sip-alg-contact-fullcone-mismatch, sip-alg-create-contact-fullcone-failure, sip-alg-single-rtp-fullcone, sip-alg-rtcp-fullcone-mismatch, sip-alg-reuse-rtp-rtcp-fullcone, sip-alg-single-rtcp-fullcone, sip-alg-create-rtp-fullcone-failure, sip-alg-create-rtcp-fullcone-failure, icmp-out-of-state-uqe-admin-filtered-sent, icmp-out-of-state-uqe-host-unreachable-sent, icmp-out-of-state-uqe-dropped, nat-esp-ip-conflicts, total-tcp-allocated-shadow, total-tcp-freed-shadow, total-udp-allocated-shadow, total-udp-freed-shadow, total-icmp-allocated-shadow, total-icmp-freed-shadow, nat44-data-session-created-shadow, nat44-data-session-freed-shadow, nat64-data-session-created-shadow, nat64-data-session-freed-shadow, dslite-data-session-created-shadow, dslite-data-session-freed-shadow, nat44-tcp-fullcone-created-shadow, nat44-tcp-fullcone-freed-shadow, nat44-udp-fullcone-created-shadow, nat44-udp-fullcone-freed-shadow, nat44-udp-alg-fullcone-created-shadow
counters2
Description ‘nat44-udp-alg-fullcone-freed-shadow’: NAT44 UDP ALG Full-Cone Freed; ‘nat64-tcp-fullcone-created-shadow’: NAT64 TCP Full-Cone Created; ‘nat64-tcp-fullcone-freed-shadow’: NAT64 TCP Full-Cone Freed; ‘nat64-udp-fullcone-created-shadow’: NAT64 UDP Full-Cone Created; ‘nat64-udp-fullcone-freed-shadow’: NAT64 UDP Full-Cone Freed; ‘nat64-udp-alg-fullcone-created-shadow’: NAT64 UDP ALG Full-Cone Created; ‘nat64-udp-alg-fullcone-freed-shadow’: NAT64 UDP ALG Full-Cone Freed; ‘dslite-tcp-fullcone-created-shadow’: DS-Lite TCP Full-Cone Created; ‘dslite-tcp-fullcone-freed-shadow’: DS-Lite TCP Full-Cone Freed; ‘dslite-udp-fullcone-created-shadow’: DS-Lite UDP Full-Cone Created; ‘dslite-udp-fullcone-freed-shadow’: DS-Lite UDP Full-Cone Freed; ‘dslite-udp-alg-fullcone-created-shadow’: DS-Lite UDP ALG Full-Cone Created; ‘dslite-udp-alg-fullcone-freed-shadow’: DS-Lite UDP ALG Full-Cone Freed; ‘h323-alg-reuse-fullcone’: H323 ALG Reuse Full-cone Session; ‘h323-alg-fullcone-mismatch’: H323 ALG Full-cone Session Mismatch; ‘h323-alg-create-fullcone-failure’: H323 ALG Create Full-cone Session Failure; ‘h323-alg-single-rtp-fullcone’: H323 ALG Single RTP Full-cone Found; ‘h323-alg-rtcp-fullcone-mismatch’: H323 ALG RTCP Full-cone NAT Port Mismatch; ‘h323-alg-reuse-rtp-rtcp-fullcone’: H323 ALG Reuse RTP/RTCP Full-cone Session; ‘h323-alg-single-rtcp-fullcone’: H323 ALG Single RTCP Full-cone Found; ‘h323-alg-create-rtp-fullcone-failure’: H323 ALG Create RTP Full-cone Session Failure; ‘h323-alg-create-rtcp-fullcone-failure’: H323 ALG Create RTCP Full-cone Session Failure; ‘mgcp-alg-reuse-fullcone’: MGCP ALG Reuse Full-cone Session; ‘mgcp-alg-fullcone-mismatch’: MGCP ALG Full-cone Session Mismatch; ‘mgcp-alg-create-fullcone-failure’: MGCP ALG Create Full-cone Session Failure; ‘mgcp-alg-single-rtp-fullcone’: MGCP ALG Single RTP Full-cone Found; ‘mgcp-alg-rtcp-fullcone-mismatch’: MGCP ALG RTCP Full-cone NAT Port Mismatch; ‘mgcp-alg-reuse-rtp-rtcp-fullcone’: MGCP ALG Reuse RTP/RTCP Full-cone Session; ‘mgcp-alg-single-rtcp-fullcone’: MGCP ALG Single RTCP Full-cone Found; ‘mgcp-alg-create-rtp-fullcone-failure’: MGCP ALG Create RTP Full-cone Session Failure; ‘mgcp-alg-create-rtcp-fullcone-failure’: MGCP ALG Create RTCP Full-cone Session Failure; ‘user-unusable-drop’: Fixed NAT User Unusable Drop; ‘ipv4-user-unusable’: Fixed NAT IPv4 User Marked Unusable; ‘ipv6-user-unusable’: Fixed NAT IPv6 User Marked Unusable; ‘ipd-disabled’: Fixed NAT IPD disabled; ‘dslite_tunnel_frag’: IPv4 Fragment DS-Lite Packet; ‘total-tcp-overload-acquired’: Total TCP ports acquired for port overloading; ‘total-udp-overload-acquired’: Total UDP ports acquired for port overloading; ‘total-tcp-overload-released’: Total TCP ports released from port overloading; ‘total-udp-overload-released’: Total UDP ports released from port overloading; ‘total-tcp-alloc-overload’: Total TCP ports allocated via overload; ‘total-udp-alloc-overload’: Total UDP ports allocated via overload; ‘total-tcp-free-overload’: Total TCP ports freed via overload; ‘total-udp-free-overload’: Total UDP ports freed via overload; ‘port-overload-smp-delete-scheduled’: Port overload SMP conn delete scheduled; ‘port-overload-smp-mem-allocated’: Port overload SMP mem allocated; ‘port-overload-out-of-memory’: Port overload out of memory; ‘port-overload-smp-free’: Port overload SMP conn free; ‘port-overload-smp-free-no-lid’: Port overload SMP conn free no lid; ‘port-overload-free-smp-not-found’: Port overload free SMP conn not found; ‘port-overload-failed’: Port overload failed; ‘total-tcp-overload-acquired-shadow’: Total TCP ports acquired for port overloading shadow; ‘total-udp-overload-acquired-shadow’: Total UDP ports acquired for port overloading shadow; ‘total-tcp-overload-released-shadow’: Total TCP ports released from port overloading shadow; ‘total-udp-overload-released-shadow’: Total UDP ports released from port overloading shadow; ‘total-tcp-alloc-overload-shadow’: Total TCP allocated via overload shadow; ‘total-udp-alloc-overload-shadow’: Total UDP allocated via overload shadow; ‘total-tcp-free-overload-shadow’: Total TCP freed via overload shadow; ‘total-udp-free-overload-shadow’: Total UDP freed via overload shadow; ‘ha-session-user-quota-exceeded’: HA Sessions User Quota Exceeded; ‘tcp-user-quota-exceeded’: TCP User Quota Exceeded; ‘udp-user-quota-exceeded’: UDP User Quota Exceeded; ‘icmp-user-quota-exceeded’: ICMP User Quota Exceeded; ‘ha-tcp-user-quota-exceeded’: HA TCP User Quota Exceeded; ‘ha-udp-user-quota-exceeded’: HA UDP User Quota Exceeded; ‘ha-icmp-user-quota-exceeded’: HA ICMP User Quota Exceeded; ‘ha-nat-port-unavailable-tcp’: HA TCP NAT Port Unavailable; ‘ha-nat-port-unavailable-udp’: HA UDP NAT Port Unavailable; ‘ha-nat-port-unavailable-icmp’: HA ICMP NAT Port Unavailable; ‘fnat44_fwd_ingress_packets_tcp’: Fixed NAT44 Forward Ingress Packets TCP; ‘fnat44_fwd_egress_packets_tcp’: Fixed NAT44 Forward Egress Packets TCP; ‘fnat44_rev_ingress_packets_tcp’: Fixed NAT44 Reverse Ingress Packets TCP; ‘fnat44_rev_egress_packets_tcp’: Fixed NAT44 Reverse Egress Packets TCP; ‘fnat44_fwd_ingress_bytes_tcp’: Fixed NAT44 Forward Ingress Bytes TCP; ‘fnat44_fwd_egress_bytes_tcp’: Fixed NAT44 Forward Egress Bytes TCP; ‘fnat44_rev_ingress_bytes_tcp’: Fixed NAT44 Reverse Ingress Bytes TCP; ‘fnat44_rev_egress_bytes_tcp’: Fixed NAT44 Reverse Egress Bytes TCP; ‘fnat44_fwd_ingress_packets_udp’: Fixed NAT44 Forward Ingress Packets UDP; ‘fnat44_fwd_egress_packets_udp’: Fixed NAT44 Forward Egress Packets UDP; ‘fnat44_rev_ingress_packets_udp’: Fixed NAT44 Reverse Ingress Packets UDP; ‘fnat44_rev_egress_packets_udp’: Fixed NAT44 Reverse Egress Packets UDP; ‘fnat44_fwd_ingress_bytes_udp’: Fixed NAT44 Forward Ingress Bytes UDP; ‘fnat44_fwd_egress_bytes_udp’: Fixed NAT44 Forward Egress Bytes UDP; ‘fnat44_rev_ingress_bytes_udp’: Fixed NAT44 Reverse Ingress Bytes UDP; ‘fnat44_rev_egress_bytes_udp’: Fixed NAT44 Reverse Egress Bytes UDP; ‘fnat44_fwd_ingress_packets_icmp’: Fixed NAT44 Forward Ingress Packets ICMP; ‘fnat44_fwd_egress_packets_icmp’: Fixed NAT44 Forward Egress Packets ICMP; ‘fnat44_rev_ingress_packets_icmp’: Fixed NAT44 Reverse Ingress Packets ICMP; ‘fnat44_rev_egress_packets_icmp’: Fixed NAT44 Reverse Egress Packets ICMP; ‘fnat44_fwd_ingress_bytes_icmp’: Fixed NAT44 Forward Ingress Bytes ICMP; ‘fnat44_fwd_egress_bytes_icmp’: Fixed NAT44 Forward Egress Bytes ICMP; ‘fnat44_rev_ingress_bytes_icmp’: Fixed NAT44 Reverse Ingress Bytes ICMP; ‘fnat44_rev_egress_bytes_icmp’: Fixed NAT44 Reverse Egress Bytes ICMP; ‘fnat44_fwd_ingress_packets_others’: Fixed NAT44 Forward Ingress Packets OTHERS; ‘fnat44_fwd_egress_packets_others’: Fixed NAT44 Forward Egress Packets OTHERS; ‘fnat44_rev_ingress_packets_others’: Fixed NAT44 Reverse Ingress Packets OTHERS; ‘fnat44_rev_egress_packets_others’: Fixed NAT44 Reverse Egress Packets OTHERS; ‘fnat44_fwd_ingress_bytes_others’: Fixed NAT44 Forward Ingress Bytes OTHERS; ‘fnat44_fwd_egress_bytes_others’: Fixed NAT44 Forward Egress Bytes OTHERS; ‘fnat44_rev_ingress_bytes_others’: Fixed NAT44 Reverse Ingress Bytes OTHERS; ‘fnat44_rev_egress_bytes_others’: Fixed NAT44 Reverse Egress Bytes OTHERS; ‘fnat44_fwd_ingress_pkt_size_range1’: Fixed NAT44 Forward Ingress Packet size between 0 and 200; ‘fnat44_fwd_ingress_pkt_size_range2’: Fixed NAT44 Forward Ingress Packet size between 201 and 800; ‘fnat44_fwd_ingress_pkt_size_range3’: Fixed NAT44 Forward Ingress Packet size between 801 and 1550; ‘fnat44_fwd_ingress_pkt_size_range4’: Fixed NAT44 Forward Ingress Packet size between 1551 and 9000; ‘fnat44_fwd_egress_pkt_size_range1’: Fixed NAT44 Forward Egress Packet size between 0 and 200;
Type: string
Supported Values: nat44-udp-alg-fullcone-freed-shadow, nat64-tcp-fullcone-created-shadow, nat64-tcp-fullcone-freed-shadow, nat64-udp-fullcone-created-shadow, nat64-udp-fullcone-freed-shadow, nat64-udp-alg-fullcone-created-shadow, nat64-udp-alg-fullcone-freed-shadow, dslite-tcp-fullcone-created-shadow, dslite-tcp-fullcone-freed-shadow, dslite-udp-fullcone-created-shadow, dslite-udp-fullcone-freed-shadow, dslite-udp-alg-fullcone-created-shadow, dslite-udp-alg-fullcone-freed-shadow, h323-alg-reuse-fullcone, h323-alg-fullcone-mismatch, h323-alg-create-fullcone-failure, h323-alg-single-rtp-fullcone, h323-alg-rtcp-fullcone-mismatch, h323-alg-reuse-rtp-rtcp-fullcone, h323-alg-single-rtcp-fullcone, h323-alg-create-rtp-fullcone-failure, h323-alg-create-rtcp-fullcone-failure, mgcp-alg-reuse-fullcone, mgcp-alg-fullcone-mismatch, mgcp-alg-create-fullcone-failure, mgcp-alg-single-rtp-fullcone, mgcp-alg-rtcp-fullcone-mismatch, mgcp-alg-reuse-rtp-rtcp-fullcone, mgcp-alg-single-rtcp-fullcone, mgcp-alg-create-rtp-fullcone-failure, mgcp-alg-create-rtcp-fullcone-failure, user-unusable-drop, ipv4-user-unusable, ipv6-user-unusable, ipd-disabled, dslite_tunnel_frag, total-tcp-overload-acquired, total-udp-overload-acquired, total-tcp-overload-released, total-udp-overload-released, total-tcp-alloc-overload, total-udp-alloc-overload, total-tcp-free-overload, total-udp-free-overload, port-overload-smp-delete-scheduled, port-overload-smp-mem-allocated, port-overload-out-of-memory, port-overload-smp-free, port-overload-smp-free-no-lid, port-overload-free-smp-not-found, port-overload-failed, total-tcp-overload-acquired-shadow, total-udp-overload-acquired-shadow, total-tcp-overload-released-shadow, total-udp-overload-released-shadow, total-tcp-alloc-overload-shadow, total-udp-alloc-overload-shadow, total-tcp-free-overload-shadow, total-udp-free-overload-shadow, ha-session-user-quota-exceeded, tcp-user-quota-exceeded, udp-user-quota-exceeded, icmp-user-quota-exceeded, ha-tcp-user-quota-exceeded, ha-udp-user-quota-exceeded, ha-icmp-user-quota-exceeded, ha-nat-port-unavailable-tcp, ha-nat-port-unavailable-udp, ha-nat-port-unavailable-icmp, fnat44_fwd_ingress_packets_tcp, fnat44_fwd_egress_packets_tcp, fnat44_rev_ingress_packets_tcp, fnat44_rev_egress_packets_tcp, fnat44_fwd_ingress_bytes_tcp, fnat44_fwd_egress_bytes_tcp, fnat44_rev_ingress_bytes_tcp, fnat44_rev_egress_bytes_tcp, fnat44_fwd_ingress_packets_udp, fnat44_fwd_egress_packets_udp, fnat44_rev_ingress_packets_udp, fnat44_rev_egress_packets_udp, fnat44_fwd_ingress_bytes_udp, fnat44_fwd_egress_bytes_udp, fnat44_rev_ingress_bytes_udp, fnat44_rev_egress_bytes_udp, fnat44_fwd_ingress_packets_icmp, fnat44_fwd_egress_packets_icmp, fnat44_rev_ingress_packets_icmp, fnat44_rev_egress_packets_icmp, fnat44_fwd_ingress_bytes_icmp, fnat44_fwd_egress_bytes_icmp, fnat44_rev_ingress_bytes_icmp, fnat44_rev_egress_bytes_icmp, fnat44_fwd_ingress_packets_others, fnat44_fwd_egress_packets_others, fnat44_rev_ingress_packets_others, fnat44_rev_egress_packets_others, fnat44_fwd_ingress_bytes_others, fnat44_fwd_egress_bytes_others, fnat44_rev_ingress_bytes_others, fnat44_rev_egress_bytes_others, fnat44_fwd_ingress_pkt_size_range1, fnat44_fwd_ingress_pkt_size_range2, fnat44_fwd_ingress_pkt_size_range3, fnat44_fwd_ingress_pkt_size_range4, fnat44_fwd_egress_pkt_size_range1
counters3
Description ‘fnat44_fwd_egress_pkt_size_range2’: Fixed NAT44 Forward Egress Packet size between 201 and 800; ‘fnat44_fwd_egress_pkt_size_range3’: Fixed NAT44 Forward Egress Packet size between 801 and 1550; ‘fnat44_fwd_egress_pkt_size_range4’: Fixed NAT44 Forward Egress Packet size between 1551 and 9000; ‘fnat44_rev_ingress_pkt_size_range1’: Fixed NAT44 Reverse Ingress Packet size between 0 and 200; ‘fnat44_rev_ingress_pkt_size_range2’: Fixed NAT44 Reverse Ingress Packet size between 201 and 800; ‘fnat44_rev_ingress_pkt_size_range3’: Fixed NAT44 Reverse Ingress Packet size between 801 and 1550; ‘fnat44_rev_ingress_pkt_size_range4’: Fixed NAT44 Reverse Ingress Packet size between 1551 and 9000; ‘fnat44_rev_egress_pkt_size_range1’: Fixed NAT44 Reverse Egress Packet size between 0 and 200; ‘fnat44_rev_egress_pkt_size_range2’: Fixed NAT44 Reverse Egress Packet size between 201 and 800; ‘fnat44_rev_egress_pkt_size_range3’: Fixed NAT44 Reverse Egress Packet size between 801 and 1550; ‘fnat44_rev_egress_pkt_size_range4’: Fixed NAT44 Reverse Egress Packet size between 1551 and 9000; ‘fnat64_fwd_ingress_packets_tcp’: Fixed NAT64 Forward Ingress Packets TCP; ‘fnat64_fwd_egress_packets_tcp’: Fixed NAT64 Forward Egress Packets TCP; ‘fnat64_rev_ingress_packets_tcp’: Fixed NAT64 Reverse Ingress Packets TCP; ‘fnat64_rev_egress_packets_tcp’: Fixed NAT64 Reverse Egress Packets TCP; ‘fnat64_fwd_ingress_bytes_tcp’: Fixed NAT64 Forward Ingress Bytes TCP; ‘fnat64_fwd_egress_bytes_tcp’: Fixed NAT64 Forward Egress Bytes TCP; ‘fnat64_rev_ingress_bytes_tcp’: Fixed NAT64 Reverse Ingress Bytes TCP; ‘fnat64_rev_egress_bytes_tcp’: Fixed NAT64 Reverse Egress Bytes TCP; ‘fnat64_fwd_ingress_packets_udp’: Fixed NAT64 Forward Ingress Packets UDP; ‘fnat64_fwd_egress_packets_udp’: Fixed NAT64 Forward Egress Packets UDP; ‘fnat64_rev_ingress_packets_udp’: Fixed NAT64 Reverse Ingress Packets UDP; ‘fnat64_rev_egress_packets_udp’: Fixed NAT64 Reverse Egress Packets UDP; ‘fnat64_fwd_ingress_bytes_udp’: Fixed NAT64 Forward Ingress Bytes UDP; ‘fnat64_fwd_egress_bytes_udp’: Fixed NAT64 Forward Egress Bytes UDP; ‘fnat64_rev_ingress_bytes_udp’: Fixed NAT64 Reverse Ingress Bytes UDP; ‘fnat64_rev_egress_bytes_udp’: Fixed NAT64 Reverse Egress Bytes UDP; ‘fnat64_fwd_ingress_packets_icmp’: Fixed NAT64 Forward Ingress Packets ICMP; ‘fnat64_fwd_egress_packets_icmp’: Fixed NAT64 Forward Egress Packets ICMP; ‘fnat64_rev_ingress_packets_icmp’: Fixed NAT64 Reverse Ingress Packets ICMP; ‘fnat64_rev_egress_packets_icmp’: Fixed NAT64 Reverse Egress Packets ICMP; ‘fnat64_fwd_ingress_bytes_icmp’: Fixed NAT64 Forward Ingress Bytes ICMP; ‘fnat64_fwd_egress_bytes_icmp’: Fixed NAT64 Forward Egress Bytes ICMP; ‘fnat64_rev_ingress_bytes_icmp’: Fixed NAT64 Reverse Ingress Bytes ICMP; ‘fnat64_rev_egress_bytes_icmp’: Fixed NAT64 Reverse Egress Bytes ICMP; ‘fnat64_fwd_ingress_packets_others’: Fixed NAT64 Forward Ingress Packets OTHERS; ‘fnat64_fwd_egress_packets_others’: Fixed NAT64 Forward Egress Packets OTHERS; ‘fnat64_rev_ingress_packets_others’: Fixed NAT64 Reverse Ingress Packets OTHERS; ‘fnat64_rev_egress_packets_others’: Fixed NAT64 Reverse Egress Packets OTHERS; ‘fnat64_fwd_ingress_bytes_others’: Fixed NAT64 Forward Ingress Bytes OTHERS; ‘fnat64_fwd_egress_bytes_others’: Fixed NAT64 Forward Egress Bytes OTHERS; ‘fnat64_rev_ingress_bytes_others’: Fixed NAT64 Reverse Ingress Bytes OTHERS; ‘fnat64_rev_egress_bytes_others’: Fixed NAT64 Reverse Egress Bytes OTHERS; ‘fnat64_fwd_ingress_pkt_size_range1’: Fixed NAT64 Forward Ingress Packet size between 0 and 200; ‘fnat64_fwd_ingress_pkt_size_range2’: Fixed NAT64 Forward Ingress Packet size between 201 and 800; ‘fnat64_fwd_ingress_pkt_size_range3’: Fixed NAT64 Forward Ingress Packet size between 801 and 1550; ‘fnat64_fwd_ingress_pkt_size_range4’: Fixed NAT64 Forward Ingress Packet size between 1551 and 9000; ‘fnat64_fwd_egress_pkt_size_range1’: Fixed NAT64 Forward Egress Packet size between 0 and 200; ‘fnat64_fwd_egress_pkt_size_range2’: Fixed NAT64 Forward Egress Packet size between 201 and 800; ‘fnat64_fwd_egress_pkt_size_range3’: Fixed NAT64 Forward Egress Packet size between 801 and 1550; ‘fnat64_fwd_egress_pkt_size_range4’: Fixed NAT64 Forward Egress Packet size between 1551 and 9000; ‘fnat64_rev_ingress_pkt_size_range1’: Fixed NAT64 Reverse Ingress Packet size between 0 and 200; ‘fnat64_rev_ingress_pkt_size_range2’: Fixed NAT64 Reverse Ingress Packet size between 201 and 800; ‘fnat64_rev_ingress_pkt_size_range3’: Fixed NAT64 Reverse Ingress Packet size between 801 and 1550; ‘fnat64_rev_ingress_pkt_size_range4’: Fixed NAT64 Reverse Ingress Packet size between 1551 and 9000; ‘fnat64_rev_egress_pkt_size_range1’: Fixed NAT64 Reverse Egress Packet size between 0 and 200; ‘fnat64_rev_egress_pkt_size_range2’: Fixed NAT64 Reverse Egress Packet size between 201 and 800; ‘fnat64_rev_egress_pkt_size_range3’: Fixed NAT64 Reverse Egress Packet size between 801 and 1550; ‘fnat64_rev_egress_pkt_size_range4’: Fixed NAT64 Reverse Egress Packet size between 1551 and 9000; ‘fnatdslite_fwd_ingress_packets_tcp’: Fixed DS-Lite Forward Ingress Packets TCP; ‘fnatdslite_fwd_egress_packets_tcp’: Fixed DS-Lite Forward Egress Packets TCP; ‘fnatdslite_rev_ingress_packets_tcp’: Fixed DS-Lite Reverse Ingress Packets TCP; ‘fnatdslite_rev_egress_packets_tcp’: Fixed DS-Lite Reverse Egress Packets TCP; ‘fnatdslite_fwd_ingress_bytes_tcp’: Fixed DS-Lite Forward Ingress Bytes TCP; ‘fnatdslite_fwd_egress_bytes_tcp’: Fixed DS-Lite Forward Egress Bytes TCP; ‘fnatdslite_rev_ingress_bytes_tcp’: Fixed DS-Lite Reverse Ingress Bytes TCP; ‘fnatdslite_rev_egress_bytes_tcp’: Fixed DS-Lite Reverse Egress Bytes TCP; ‘fnatdslite_fwd_ingress_packets_udp’: Fixed DS-Lite Forward Ingress Packets UDP; ‘fnatdslite_fwd_egress_packets_udp’: Fixed DS-Lite Forward Egress Packets UDP; ‘fnatdslite_rev_ingress_packets_udp’: Fixed DS-Lite Reverse Ingress Packets UDP; ‘fnatdslite_rev_egress_packets_udp’: Fixed DS-Lite Reverse Egress Packets UDP; ‘fnatdslite_fwd_ingress_bytes_udp’: Fixed DS-Lite Forward Ingress Bytes UDP; ‘fnatdslite_fwd_egress_bytes_udp’: Fixed DS-Lite Forward Egress Bytes UDP; ‘fnatdslite_rev_ingress_bytes_udp’: Fixed DS-Lite Reverse Ingress Bytes UDP; ‘fnatdslite_rev_egress_bytes_udp’: Fixed DS-Lite Reverse Egress Bytes UDP; ‘fnatdslite_fwd_ingress_packets_icmp’: Fixed DS-Lite Forward Ingress Packets ICMP; ‘fnatdslite_fwd_egress_packets_icmp’: Fixed DS-Lite Forward Egress Packets ICMP; ‘fnatdslite_rev_ingress_packets_icmp’: Fixed DS-Lite Reverse Ingress Packets ICMP; ‘fnatdslite_rev_egress_packets_icmp’: Fixed DS-Lite Reverse Egress Packets ICMP; ‘fnatdslite_fwd_ingress_bytes_icmp’: Fixed DS-Lite Forward Ingress Bytes ICMP; ‘fnatdslite_fwd_egress_bytes_icmp’: Fixed DS-Lite Forward Egress Bytes ICMP; ‘fnatdslite_rev_ingress_bytes_icmp’: Fixed DS-Lite Reverse Ingress Bytes ICMP; ‘fnatdslite_rev_egress_bytes_icmp’: Fixed DS-Lite Reverse Egress Bytes ICMP; ‘fnatdslite_fwd_ingress_packets_others’: Fixed DS-Lite Forward Ingress Packets OTHERS; ‘fnatdslite_fwd_egress_packets_others’: Fixed DS-Lite Forward Egress Packets OTHERS; ‘fnatdslite_rev_ingress_packets_others’: Fixed DS-Lite Reverse Ingress Packets OTHERS; ‘fnatdslite_rev_egress_packets_others’: Fixed DS-Lite Reverse Egress Packets OTHERS; ‘fnatdslite_fwd_ingress_bytes_others’: Fixed DS-Lite Forward Ingress Bytes OTHERS; ‘fnatdslite_fwd_egress_bytes_others’: Fixed DS-Lite Forward Egress Bytes OTHERS; ‘fnatdslite_rev_ingress_bytes_others’: Fixed DS-Lite Reverse Ingress Bytes OTHERS; ‘fnatdslite_rev_egress_bytes_others’: Fixed DS-Lite Reverse Egress Bytes OTHERS; ‘fnatdslite_fwd_ingress_pkt_size_range1’: Fixed DS-Lite Forward Ingress Packet size between 0 and 200;
Type: string
Supported Values: fnat44_fwd_egress_pkt_size_range2, fnat44_fwd_egress_pkt_size_range3, fnat44_fwd_egress_pkt_size_range4, fnat44_rev_ingress_pkt_size_range1, fnat44_rev_ingress_pkt_size_range2, fnat44_rev_ingress_pkt_size_range3, fnat44_rev_ingress_pkt_size_range4, fnat44_rev_egress_pkt_size_range1, fnat44_rev_egress_pkt_size_range2, fnat44_rev_egress_pkt_size_range3, fnat44_rev_egress_pkt_size_range4, fnat64_fwd_ingress_packets_tcp, fnat64_fwd_egress_packets_tcp, fnat64_rev_ingress_packets_tcp, fnat64_rev_egress_packets_tcp, fnat64_fwd_ingress_bytes_tcp, fnat64_fwd_egress_bytes_tcp, fnat64_rev_ingress_bytes_tcp, fnat64_rev_egress_bytes_tcp, fnat64_fwd_ingress_packets_udp, fnat64_fwd_egress_packets_udp, fnat64_rev_ingress_packets_udp, fnat64_rev_egress_packets_udp, fnat64_fwd_ingress_bytes_udp, fnat64_fwd_egress_bytes_udp, fnat64_rev_ingress_bytes_udp, fnat64_rev_egress_bytes_udp, fnat64_fwd_ingress_packets_icmp, fnat64_fwd_egress_packets_icmp, fnat64_rev_ingress_packets_icmp, fnat64_rev_egress_packets_icmp, fnat64_fwd_ingress_bytes_icmp, fnat64_fwd_egress_bytes_icmp, fnat64_rev_ingress_bytes_icmp, fnat64_rev_egress_bytes_icmp, fnat64_fwd_ingress_packets_others, fnat64_fwd_egress_packets_others, fnat64_rev_ingress_packets_others, fnat64_rev_egress_packets_others, fnat64_fwd_ingress_bytes_others, fnat64_fwd_egress_bytes_others, fnat64_rev_ingress_bytes_others, fnat64_rev_egress_bytes_others, fnat64_fwd_ingress_pkt_size_range1, fnat64_fwd_ingress_pkt_size_range2, fnat64_fwd_ingress_pkt_size_range3, fnat64_fwd_ingress_pkt_size_range4, fnat64_fwd_egress_pkt_size_range1, fnat64_fwd_egress_pkt_size_range2, fnat64_fwd_egress_pkt_size_range3, fnat64_fwd_egress_pkt_size_range4, fnat64_rev_ingress_pkt_size_range1, fnat64_rev_ingress_pkt_size_range2, fnat64_rev_ingress_pkt_size_range3, fnat64_rev_ingress_pkt_size_range4, fnat64_rev_egress_pkt_size_range1, fnat64_rev_egress_pkt_size_range2, fnat64_rev_egress_pkt_size_range3, fnat64_rev_egress_pkt_size_range4, fnatdslite_fwd_ingress_packets_tcp, fnatdslite_fwd_egress_packets_tcp, fnatdslite_rev_ingress_packets_tcp, fnatdslite_rev_egress_packets_tcp, fnatdslite_fwd_ingress_bytes_tcp, fnatdslite_fwd_egress_bytes_tcp, fnatdslite_rev_ingress_bytes_tcp, fnatdslite_rev_egress_bytes_tcp, fnatdslite_fwd_ingress_packets_udp, fnatdslite_fwd_egress_packets_udp, fnatdslite_rev_ingress_packets_udp, fnatdslite_rev_egress_packets_udp, fnatdslite_fwd_ingress_bytes_udp, fnatdslite_fwd_egress_bytes_udp, fnatdslite_rev_ingress_bytes_udp, fnatdslite_rev_egress_bytes_udp, fnatdslite_fwd_ingress_packets_icmp, fnatdslite_fwd_egress_packets_icmp, fnatdslite_rev_ingress_packets_icmp, fnatdslite_rev_egress_packets_icmp, fnatdslite_fwd_ingress_bytes_icmp, fnatdslite_fwd_egress_bytes_icmp, fnatdslite_rev_ingress_bytes_icmp, fnatdslite_rev_egress_bytes_icmp, fnatdslite_fwd_ingress_packets_others, fnatdslite_fwd_egress_packets_others, fnatdslite_rev_ingress_packets_others, fnatdslite_rev_egress_packets_others, fnatdslite_fwd_ingress_bytes_others, fnatdslite_fwd_egress_bytes_others, fnatdslite_rev_ingress_bytes_others, fnatdslite_rev_egress_bytes_others, fnatdslite_fwd_ingress_pkt_size_range1
counters4
Description ‘fnatdslite_fwd_ingress_pkt_size_range2’: Fixed DS-Lite Forward Ingress Packet size between 201 and 800; ‘fnatdslite_fwd_ingress_pkt_size_range3’: Fixed DS-Lite Forward Ingress Packet size between 801 and 1550; ‘fnatdslite_fwd_ingress_pkt_size_range4’: Fixed DS-Lite Forward Ingress Packet size between 1551 and 9000; ‘fnatdslite_fwd_egress_pkt_size_range1’: Fixed DS-Lite Forward Egress Packet size between 0 and 200; ‘fnatdslite_fwd_egress_pkt_size_range2’: Fixed DS-Lite Forward Egress Packet size between 201 and 800; ‘fnatdslite_fwd_egress_pkt_size_range3’: Fixed DS-Lite Forward Egress Packet size between 801 and 1550; ‘fnatdslite_fwd_egress_pkt_size_range4’: Fixed DS-Lite Forward Egress Packet size between 1551 and 9000; ‘fnatdslite_rev_ingress_pkt_size_range1’: Fixed DS-Lite Reverse Ingress Packet size between 0 and 200; ‘fnatdslite_rev_ingress_pkt_size_range2’: Fixed DS-Lite Reverse Ingress Packet size between 201 and 800; ‘fnatdslite_rev_ingress_pkt_size_range3’: Fixed DS-Lite Reverse Ingress Packet size between 801 and 1550; ‘fnatdslite_rev_ingress_pkt_size_range4’: Fixed DS-Lite Reverse Ingress Packet size between 1551 and 9000; ‘fnatdslite_rev_egress_pkt_size_range1’: Fixed DS-Lite Reverse Egress Packet size between 0 and 200; ‘fnatdslite_rev_egress_pkt_size_range2’: Fixed DS-Lite Reverse Egress Packet size between 201 and 800; ‘fnatdslite_rev_egress_pkt_size_range3’: Fixed DS-Lite Reverse Egress Packet size between 801 and 1550; ‘fnatdslite_rev_egress_pkt_size_range4’: Fixed DS-Lite Reverse Egress Packet size between 1551 and 9000; ‘active-subscriber-added’: Active Subscriber Added; ‘active-subscriber-removed’: Active Subscriber Removed; ‘config-not-found-in-ctx’: Fixed NAT Config Pointer Not Found in MY_CTX;
Type: string
Supported Values: fnatdslite_fwd_ingress_pkt_size_range2, fnatdslite_fwd_ingress_pkt_size_range3, fnatdslite_fwd_ingress_pkt_size_range4, fnatdslite_fwd_egress_pkt_size_range1, fnatdslite_fwd_egress_pkt_size_range2, fnatdslite_fwd_egress_pkt_size_range3, fnatdslite_fwd_egress_pkt_size_range4, fnatdslite_rev_ingress_pkt_size_range1, fnatdslite_rev_ingress_pkt_size_range2, fnatdslite_rev_ingress_pkt_size_range3, fnatdslite_rev_ingress_pkt_size_range4, fnatdslite_rev_egress_pkt_size_range1, fnatdslite_rev_egress_pkt_size_range2, fnatdslite_rev_egress_pkt_size_range3, fnatdslite_rev_egress_pkt_size_range4, active-subscriber-added, active-subscriber-removed, config-not-found-in-ctx
fixed-nat_inside¶
Specification
Value
Type
object
iplist-list
Type: List
Reference Object: /axapi/v3/cgnv6/fixed-nat/inside/iplist/{inside-ip-list}+{partition}
ipv4address-list
ipv6address-list
fixed-nat_inside_ipv4address-list¶
Specification
Value
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 fixed-nat_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 fixed-nat_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
fixed-nat_inside_ipv4address-list_offset¶
Specification
Value
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
fixed-nat_inside_ipv4address-list_usable-nat-ports¶
Specification
Value
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
fixed-nat_inside_ipv6address-list¶
Specification
Value
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 fixed-nat_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 fixed-nat_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
fixed-nat_inside_ipv6address-list_offset¶
Specification
Value
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
fixed-nat_inside_ipv6address-list_usable-nat-ports¶
Specification
Value
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
fixed-nat_inside_iplist-list¶
Specification
Value
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 fixed-nat_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 fixed-nat_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
fixed-nat_inside_iplist-list_offset¶
Specification
Value
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
fixed-nat_inside_iplist-list_usable-nat-ports¶
Specification
Value
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
fixed-nat_alg¶
Specification
Value
Type
object
esp
Description: esp is a JSON Block. Please see below for fixed-nat_alg_esp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/esp
ftp
Description: ftp is a JSON Block. Please see below for fixed-nat_alg_ftp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/ftp
h323
Description: h323 is a JSON Block. Please see below for fixed-nat_alg_h323
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/h323
mgcp
Description: mgcp is a JSON Block. Please see below for fixed-nat_alg_mgcp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/mgcp
pptp
Description: pptp is a JSON Block. Please see below for fixed-nat_alg_pptp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/pptp
rtsp
Description: rtsp is a JSON Block. Please see below for fixed-nat_alg_rtsp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/rtsp
sip
Description: sip is a JSON Block. Please see below for fixed-nat_alg_sip
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/sip
tftp
Description: tftp is a JSON Block. Please see below for fixed-nat_alg_tftp
Type: Object
Reference Object: /axapi/v3/cgnv6/fixed-nat/alg/tftp
fixed-nat_alg_esp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_esp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: ESP Sessions Created; ‘placeholder-debug’: Placeholder Debug;
Type: string
Supported Values: all, session-created, placeholder-debug
fixed-nat_alg_ftp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_ftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘port-requests’: PORT Requests From Client; ‘eprt-requests’: EPRT Requests From Client; ‘lprt-requests’: LPRT Requests From Client; ‘pasv-replies’: PASV Replies From Server; ‘epsv-replies’: EPSV Replies From Server; ‘lpsv-replies’: LPSV Replies From Server; ‘port-retransmits’: Port Mode Request Retransmits; ‘pasv-retransmits’: Passive Mode Reply Retransmits; ‘port-helper-created’: Port Mode Helper Created; ‘pasv-helper-created’: Passive Mode Helper Created; ‘port-helper-freed’: Port Mode Helper Freed; ‘pasv-helper-freed’: Passive Mode Helper Freed; ‘port-helper-unused’: Port Mode Helper Unused; ‘pasv-helper-unused’: Passive Mode Helper Unused; ‘port-helper-creation-failure’: Port Helper Creation Failure; ‘pasv-helper-creation-failure’: Passive Helper Creation Failure; ‘get-conn-ext-failure’: Get Conn Extension Failure; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch;
Type: string
Supported Values: all, port-requests, eprt-requests, lprt-requests, pasv-replies, epsv-replies, lpsv-replies, port-retransmits, pasv-retransmits, port-helper-created, pasv-helper-created, port-helper-freed, pasv-helper-freed, port-helper-unused, pasv-helper-unused, port-helper-creation-failure, pasv-helper-creation-failure, get-conn-ext-failure, smp-app-type-mismatch
fixed-nat_alg_pptp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_pptp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘calls-established’: Calls Established; ‘mismatched-pns-call-id’: Mismatched PNS Call ID; ‘gre-sessions-created’: GRE Sessions Created; ‘gre-sessions-freed’: GRE Sessions Freed; ‘no-gre-session-match’: No Matching GRE Session; ‘smp-sessions-created’: SMP Sessions Created; ‘smp-sessions-freed’: SMP Sessions Freed; ‘smp-session-creation-failure’: SMP Session Creation Failures; ‘extension-creation-failure’: Extension Creation Failures; ‘ha-sent’: HA Info Sent; ‘ha-rcv’: HA Info Received; ‘ha-no-mem’: HA Memory Allocation Failure; ‘ha-conflict’: HA Call ID Conflicts; ‘ha-overwrite’: HA Call ID Overwrites; ‘ha-call-sent’: HA Call Sent; ‘ha-call-rcv’: HA Call Received; ‘ha-smp-conflict’: HA SMP Conflicts; ‘ha-smp-in-del-q’: HA SMP Deleted; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch; ‘call-req-pns-call-id-mismatch’: Call ID Mismatch on Call Request; ‘call-reply-pns-call-id-mismatch’: Call ID Mismatch on Call Reply; ‘call-req-retransmit’: Call Request Retransmit; ‘call-req-new’: Call Request New; ‘call-req-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘call-reply-call-id-unknown’: Call Reply Unknown Client Call ID; ‘call-reply-retransmit’: Call Reply Retransmit; ‘call-reply-retransmit-wrong-control’: Call Reply Retransmit Wrong Control; ‘call-reply-retransmit-acquired’: Call Reply Retransmit Acquired; ‘call-reply-ext-alloc-failure’: Call Request Ext Alloc Failure; ‘smp-client-call-id-mismatch’: SMP Client Call ID Mismatch; ‘smp-alloc-failure’: SMP Session Alloc Failure; ‘gre-conn-creation-failure’: GRE Conn Alloc Failure; ‘gre-conn-ext-creation-failure’: GRE Conn Ext Alloc Failure; ‘gre-no-fwd-route’: GRE No Fwd Route; ‘gre-no-rev-route’: GRE No Rev Route; ‘gre-no-control-conn’: GRE No Control Conn; ‘gre-conn-already-exists’: GRE Conn Already Exists; ‘gre-free-no-ext’: GRE Free No Ext; ‘gre-free-no-smp’: GRE Free No SMP; ‘gre-free-smp-app-type-mismatch’: GRE Free SMP App Type Mismatch; ‘control-freed’: Control Session Freed; ‘control-free-no-ext’: Control Free No Ext; ‘control-free-no-smp’: Control Free No SMP; ‘control-free-smp-app-type-mismatch’: Control Free SMP App Type Mismatch;
Type: string
Supported Values: all, calls-established, mismatched-pns-call-id, gre-sessions-created, gre-sessions-freed, no-gre-session-match, smp-sessions-created, smp-sessions-freed, smp-session-creation-failure, extension-creation-failure, ha-sent, ha-rcv, ha-no-mem, ha-conflict, ha-overwrite, ha-call-sent, ha-call-rcv, ha-smp-conflict, ha-smp-in-del-q, smp-app-type-mismatch, call-req-pns-call-id-mismatch, call-reply-pns-call-id-mismatch, call-req-retransmit, call-req-new, call-req-ext-alloc-failure, call-reply-call-id-unknown, call-reply-retransmit, call-reply-retransmit-wrong-control, call-reply-retransmit-acquired, call-reply-ext-alloc-failure, smp-client-call-id-mismatch, smp-alloc-failure, gre-conn-creation-failure, gre-conn-ext-creation-failure, gre-no-fwd-route, gre-no-rev-route, gre-no-control-conn, gre-conn-already-exists, gre-free-no-ext, gre-free-no-smp, gre-free-smp-app-type-mismatch, control-freed, control-free-no-ext, control-free-no-smp, control-free-smp-app-type-mismatch
fixed-nat_alg_rtsp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_rtsp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘streams-created’: Streams Created; ‘streams-freed’: Streams Freed; ‘stream-creation-failure’: Stream Creation Failures; ‘ports-allocated’: Stream Client Ports Allocated; ‘ports-freed’: Stream Client Ports Freed; ‘port-allocation-failure’: Stream Client Port Allocation Failures; ‘unknown-client-port-from-server’: Server Replies With Unknown Client Ports; ‘data-session-created’: Data Session Created; ‘data-session-freed’: Data Session Freed; ‘no-session-mem’: Data Session Creation Failures; ‘smp-inserted’: SMP Session Inserted; ‘smp-removed’: SMP Session Removed; ‘smp-reused’: SMP Session Reused; ‘fixed-nat-lid-standby’: New Session Fixed NAT LID Standby; ‘smp-deleted’: New Session SMP Already Deleted; ‘control-closed’: New Session Closed; ‘data-session-exists’: New Session Already Exists; ‘data-session-creation-failure’: New Data Session Creation Failure; ‘rtp-reversed’: RTP Reverse Creation; ‘rtcp-reversed’: RTCP Reverse Creation; ‘cross-cpu-sent’: Cross CPU Sent; ‘cross-cpu-rcv’: Cross CPU Received; ‘cross-cpu-no-session’: Cross CPU No Session Found; ‘cross-cpu-created’: Cross CPU Creation; ‘cross-cpu-rcv-failure’: Cross CPU Receive Failure; ‘data-free-smp-retry-lookup’: Data Session Free SMP Retry Lookup; ‘data-free-smp-not-found’: Data Session Free SMP Not Found; ‘ha-streams-sent’: HA Streams Sent; ‘ha-streams-rcv’: HA Streams Received; ‘ha-stream-incompatible’: HA Incompatible Streams Received; ‘ha-stream-exists’: HA Stream Already Exists; ‘ha-port-allocation-failure’: HA Stream Port Allocation Failure; ‘ha-data-session-sent’: HA Data Session Sent; ‘ha-data-session-rcv’: HA Data Session Received; ‘ha-data-no-smp’: HA Data Session SMP Not Found; ‘ha-control-closed’: HA New Data Control Session Closed; ‘ha-data-exists’: HA New Data Session Already Exists; ‘ha-extension-failure’: HA Conn Extension Failure; ‘ha-stream-smp-reused’: HA SMP Session Reused; ‘ha-stream-smp-acquire-failure’: HA SMP Session Acquire Failure; ‘smp-app-type-mismatch’: SMP ALG App Type Mismatch;
Type: string
Supported Values: all, streams-created, streams-freed, stream-creation-failure, ports-allocated, ports-freed, port-allocation-failure, unknown-client-port-from-server, data-session-created, data-session-freed, no-session-mem, smp-inserted, smp-removed, smp-reused, fixed-nat-lid-standby, smp-deleted, control-closed, data-session-exists, data-session-creation-failure, rtp-reversed, rtcp-reversed, cross-cpu-sent, cross-cpu-rcv, cross-cpu-no-session, cross-cpu-created, cross-cpu-rcv-failure, data-free-smp-retry-lookup, data-free-smp-not-found, ha-streams-sent, ha-streams-rcv, ha-stream-incompatible, ha-stream-exists, ha-port-allocation-failure, ha-data-session-sent, ha-data-session-rcv, ha-data-no-smp, ha-control-closed, ha-data-exists, ha-extension-failure, ha-stream-smp-reused, ha-stream-smp-acquire-failure, smp-app-type-mismatch
fixed-nat_alg_sip¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_sip_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘method-register’: SIP Method REGISTER; ‘method-invite’: SIP Method INVITE; ‘method-ack’: SIP Method ACK; ‘method-cancel’: SIP Method CANCEL; ‘method-bye’: SIP Method BYE; ‘method-options’: SIP Method OPTIONS; ‘method-prack’: SIP Method PRACK; ‘method-subscribe’: SIP Method SUBSCRIBE; ‘method-notify’: SIP Method NOTIFY; ‘method-publish’: SIP Method PUBLISH; ‘method-info’: SIP Method INFO; ‘method-refer’: SIP Method REFER; ‘method-message’: SIP Method MESSAGE; ‘method-update’: SIP Method UPDATE; ‘method-unknown’: SIP Method UNKNOWN; ‘parse-error’: SIP Message Parse Error; ‘req-uri-op-failrue’: SIP Operate Request Uri Failure; ‘via-hdr-op-failrue’: SIP Operate Via Header Failure; ‘contact-hdr-op-failrue’: SIP Operate Contact Header Failure; ‘from-hdr-op-failrue’: SIP Operate From Header Failure; ‘to-hdr-op-failrue’: SIP Operate To Header Failure; ‘route-hdr-op-failrue’: SIP Operate Route Header Failure; ‘record-route-hdr-op-failrue’: SIP Operate Record-Route Header Failure; ‘content-length-hdr-op-failrue’: SIP Operate Content-Length Failure; ‘third-party-registration’: SIP Third-Party Registration; ‘conn-ext-creation-failure’: SIP Create Connection Extension Failure; ‘alloc-contact-port-failure’: SIP Alloc Contact Port Failure; ‘outside-contact-port-mismatch’: SIP Outside Contact Port Mismatch NAT Port; ‘inside-contact-port-mismatch’: SIP Inside Contact Port Mismatch; ‘third-party-sdp’: SIP Third-Party SDP; ‘sdp-process-candidate-failure’: SIP Operate SDP Media Candidate Attribute Failure; ‘sdp-op-failure’: SIP Operate SDP Failure; ‘sdp-alloc-port-map-success’: SIP Alloc SDP Port Map Success; ‘sdp-alloc-port-map-failure’: SIP Alloc SDP Port Map Failure; ‘modify-failure’: SIP Message Modify Failure; ‘rewrite-failure’: SIP Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop; ‘smp-conn-alloc-failure’: SMP Helper Conn Alloc Failure; ‘helper-found’: SMP Helper Conn Found; ‘helper-created’: SMP Helper Conn Created; ‘helper-deleted’: SMP Helper Conn Already Deleted; ‘helper-freed’: SMP Helper Conn Freed; ‘helper-failure’: SMP Helper Failure;
Type: string
Supported Values: all, method-register, method-invite, method-ack, method-cancel, method-bye, method-options, method-prack, method-subscribe, method-notify, method-publish, method-info, method-refer, method-message, method-update, method-unknown, parse-error, req-uri-op-failrue, via-hdr-op-failrue, contact-hdr-op-failrue, from-hdr-op-failrue, to-hdr-op-failrue, route-hdr-op-failrue, record-route-hdr-op-failrue, content-length-hdr-op-failrue, third-party-registration, conn-ext-creation-failure, alloc-contact-port-failure, outside-contact-port-mismatch, inside-contact-port-mismatch, third-party-sdp, sdp-process-candidate-failure, sdp-op-failure, sdp-alloc-port-map-success, sdp-alloc-port-map-failure, modify-failure, rewrite-failure, tcp-out-of-order-drop, smp-conn-alloc-failure, helper-found, helper-created, helper-deleted, helper-freed, helper-failure
fixed-nat_alg_mgcp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_mgcp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘auep’: MGCP AUEP; ‘aucx’: MGCP AUCX; ‘crcx’: MGCP CRCX; ‘dlcx’: MGCP DLCX; ‘epcf’: MGCP EPCF; ‘mdcx’: MGCP MDCX; ‘ntfy’: MGCP NTFY; ‘rqnt’: MGCP RQNT; ‘rsip’: MGCP RSIP; ‘parse-error’: MGCP Message Parse Error; ‘conn-ext-creation-failure’: MGCP Create Connection Extension Failure; ‘third-party-sdp’: MGCP Third-Party SDP; ‘sdp-process-candidate-failure’: MGCP Operate SDP Media Candidate Attribute Failure; ‘sdp-op-failure’: MGCP Operate SDP Failure; ‘sdp-alloc-port-map-success’: MGCP Alloc SDP Port Map Success; ‘sdp-alloc-port-map-failure’: MGCP Alloc SDP Port Map Failure; ‘modify-failure’: MGCP Message Modify Failure; ‘rewrite-failure’: MGCP Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop;
Type: string
Supported Values: all, auep, aucx, crcx, dlcx, epcf, mdcx, ntfy, rqnt, rsip, parse-error, conn-ext-creation-failure, third-party-sdp, sdp-process-candidate-failure, sdp-op-failure, sdp-alloc-port-map-success, sdp-alloc-port-map-failure, modify-failure, rewrite-failure, tcp-out-of-order-drop
fixed-nat_alg_tftp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_tftp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘session-created’: TFTP Client Sessions Created; ‘helper-created’: TFTP Helper Sessions created; ‘helper-freed’: TFTP Helper Sessions freed; ‘helper-freed-used’: TFTP Helper Sessions freed used; ‘helper-freed-unused’: TFTP Helper Sessions freed unused; ‘helper-already-used’: TFTP Helper Session already used; ‘helper-in-rml’: TFTP Helper Session in Remove List;
Type: string
Supported Values: all, session-created, helper-created, helper-freed, helper-freed-used, helper-freed-unused, helper-already-used, helper-in-rml
fixed-nat_alg_h323¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_alg_h323_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘h225ras-message’: H323 H225 RAS Message; ‘h225cs-message’: H323 H225 Call Signaling Message; ‘h245ctl-message’: H323 H245 Media Control Message; ‘h245-tunneled’: H323 H245 Tunnelled Message; ‘fast-start’: H323 FastStart; ‘parse-error’: Message Parse Error; ‘message-cross-multi-packets’: H323 Message Cross Multiple Packets; ‘conn-ext-creation-failure’: H323 Packet Rewrite Failure; ‘rewrite-failure’: H323 Message Rewrite Failure; ‘tcp-out-of-order-drop’: TCP Out-of-Order Drop; ‘h245-dynamic-addr-exceed’: H323 H245 Dynamic Address Exceed;
Type: string
Supported Values: all, h225ras-message, h225cs-message, h245ctl-message, h245-tunneled, fast-start, parse-error, message-cross-multi-packets, conn-ext-creation-failure, rewrite-failure, tcp-out-of-order-drop, h245-dynamic-addr-exceed
fixed-nat_port-mapping¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_user-quota¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_port-mapping-files¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_disable¶
Specification
Value
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
fixed-nat_disabled-config¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_histogram¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fixed-nat_per-instance¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
pcp¶
Specification
Value
Type
object
default-template
Description Bind the default template for PCP (Bind a PCP template)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
pcp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘packets-rcv’: Packets Received; ‘lsn-map-process-success’: PCP MAP Request Processing Success (NAT44); ‘dslite-map-process-success’: PCP MAP Request Processing Success (DS-Lite); ‘nat64-map-process-success’: PCP MAP Request Processing Success (NAT64); ‘lsn-peer-process-success’: PCP PEER Request Processing Success (NAT44); ‘dslite-peer-process-success’: PCP PEER Request Processing Success (DS-Lite); ‘nat64-peer-process-success’: PCP PEER Request Processing Success (NAT64); ‘lsn-announce-process-success’: PCP ANNOUNCE Request Processing Success (NAT44); ‘dslite-announce-process-success’: PCP ANNOUNCE Request Processing Success (DS-Lite); ‘nat64-announce-process-success’: PCP ANNOUNCE Request Processing Success (NAT64); ‘pkt-not-request-drop’: Packet Not a PCP Request; ‘pkt-too-short-drop’: Packet Too Short; ‘noroute-drop’: Response No Route; ‘unsupported-version’: Unsupported PCP version; ‘not-authorized’: PCP Request Not Authorized; ‘malform-request’: PCP Request Malformed; ‘unsupp-opcode’: Unsupported PCP Opcode; ‘unsupp-option’: Unsupported PCP Option; ‘malform-option’: PCP Option Malformed; ‘no-resources’: No System or NAT Resources; ‘unsupp-protocol’: Unsupported Mapping Protocol; ‘user-quota-exceeded’: User Quota Exceeded; ‘cannot-provide-suggest’: Cannot Provide Suggested Port When PREFER_FAILURE; ‘address-mismatch’: PCP Client Address Mismatch; ‘excessive-remote-peers’: Excessive Remote Peers; ‘pkt-not-from-nat-inside’: Packet Dropped For Not Coming From NAT Inside; ‘l4-process-error’: L3/L4 Process Error; ‘internal-error-drop’: Internal Error; ‘unsol_ance_sent_succ’: Unsolicited Announce Sent; ‘unsol_ance_sent_fail’: Unsolicited Announce Send Failure; ‘ha_sync_epoch_sent’: HA Sync PCP Epoch Sent; ‘ha_sync_epoch_rcv’: HA Sync PCP Epoch Recv; ‘fullcone-ext-alloc’: PCP Fullcone Extension Alloc; ‘fullcone-ext-free’: PCP Fullcone Extension Free; ‘fullcone-ext-alloc-failure’: PCP Fullcone Extension Alloc Failure; ‘fullcone-ext-notfound’: PCP Fullcone Extension Not Found; ‘fullcone-ext-reuse’: PCP Fullcone Extension Reuse; ‘client-nonce-mismatch’: PCP Client Nonce Mismatch; ‘map-filter-set’: PCP MAP Filter Set; ‘map-filter-deny’: PCP MAP Filter Deny Inbound; ‘inter-board-pkts’: PCP Inter board packets;
Type: string
Supported Values: all, packets-rcv, lsn-map-process-success, dslite-map-process-success, nat64-map-process-success, lsn-peer-process-success, dslite-peer-process-success, nat64-peer-process-success, lsn-announce-process-success, dslite-announce-process-success, nat64-announce-process-success, pkt-not-request-drop, pkt-too-short-drop, noroute-drop, unsupported-version, not-authorized, malform-request, unsupp-opcode, unsupp-option, malform-option, no-resources, unsupp-protocol, user-quota-exceeded, cannot-provide-suggest, address-mismatch, excessive-remote-peers, pkt-not-from-nat-inside, l4-process-error, internal-error-drop, unsol_ance_sent_succ, unsol_ance_sent_fail, ha_sync_epoch_sent, ha_sync_epoch_rcv, fullcone-ext-alloc, fullcone-ext-free, fullcone-ext-alloc-failure, fullcone-ext-notfound, fullcone-ext-reuse, client-nonce-mismatch, map-filter-set, map-filter-deny, inter-board-pkts
nptv6¶
Specification
Value
Type
object
common
Description: common is a JSON Block. Please see below for nptv6_common
Type: Object
Reference Object: /axapi/v3/cgnv6/nptv6/common
domain-list
Type: List
Reference Object: /axapi/v3/cgnv6/nptv6/domain/{name}
nptv6_common¶
Specification
Value
Type
object
send-icmpv6-on-error
Description ‘disable’: Disable to send ICMPv6 when error discovered;
Type: string
Supported Values: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nptv6_domain-list¶
Specification
Value
Type
list
Block object keys
inside-prefix
Description Configure inside network prefix (Inside IPv6 network prefix)
Type: string
Format: ipv6-address-plen
name
Description Name of NPTv6 domain
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
outside-prefix
Description Configure outside network prefix (Outside IPv6 network prefix)
Type: string
Format: ipv6-address-plen
sampling-enable
Type: List
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
nptv6_domain-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘outbound-packets’: Outbound Packets; ‘inbound-packets’: Inbound Packets; ‘hairpin-packets’: Hairpin Packets; ‘address-not-valid-for-translation’: Address Not Valid For Translation; ‘inbound-packets-no-map’: Inbound Packets No Map; ‘packets-dest-unreachable’: Packets Destination Unreachable;
Type: string
Supported Values: all, outbound-packets, inbound-packets, hairpin-packets, address-not-valid-for-translation, inbound-packets-no-map, packets-dest-unreachable
logging¶
Specification
Value
Type
object
nat-quota-exceeded
Description: nat-quota-exceeded is a JSON Block. Please see below for logging_nat-quota-exceeded
Type: Object
Reference Object: /axapi/v3/cgnv6/logging/nat-quota-exceeded
nat-resource-exhausted
Description: nat-resource-exhausted is a JSON Block. Please see below for logging_nat-resource-exhausted
Type: Object
Reference Object: /axapi/v3/cgnv6/logging/nat-resource-exhausted
sampling-enable
Type: List
source-address
Description: source-address is a JSON Block. Please see below for logging_source-address
Type: Object
Reference Object: /axapi/v3/cgnv6/logging/source-address
tcp-svr-status
Description: tcp-svr-status is a JSON Block. Please see below for logging_tcp-svr-status
Type: Object
Reference Object: /axapi/v3/cgnv6/logging/tcp-svr-status
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
logging_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘tcp-session-created’: TCP Session Created; ‘tcp-session-deleted’: TCP Session Deleted; ‘tcp-port-allocated’: TCP Port Allocated; ‘tcp-port-freed’: TCP Port Freed; ‘tcp-port-batch-allocated’: TCP Port Batch Allocated; ‘tcp-port-batch-freed’: TCP Port Batch Freed; ‘udp-session-created’: UDP Session Created; ‘udp-session-deleted’: UDP Session Deleted; ‘udp-port-allocated’: UDP Port Allocated; ‘udp-port-freed’: UDP Port Freed; ‘udp-port-batch-allocated’: UDP Port Batch Allocated; ‘udp-port-batch-freed’: UDP Port Batch Freed; ‘icmp-session-created’: ICMP Session Created; ‘icmp-session-deleted’: ICMP Session Deleted; ‘icmp-resource-allocated’: ICMP Resource Allocated; ‘icmp-resource-freed’: ICMP Resource Freed; ‘icmpv6-session-created’: ICMPV6 Session Created; ‘icmpv6-session-deleted’: ICMPV6 Session Deleted; ‘icmpv6-resource-allocated’: ICMPV6 Resource Allocated; ‘icmpv6-resource-freed’: ICMPV6 Resource Freed; ‘gre-session-created’: GRE Session Created; ‘gre-session-deleted’: GRE Session Deleted; ‘gre-resource-allocated’: GRE Resource Allocated; ‘gre-resource-freed’: GRE Resource Freed; ‘esp-session-created’: ESP Session Created; ‘esp-session-deleted’: ESP Session Deleted; ‘esp-resource-allocated’: ESP Resource Allocated; ‘esp-resource-freed’: ESP Resource Freed; ‘fixed-nat-user-ports’: Fixed NAT Inside User Port Mapping; ‘fixed-nat-disable-config-logged’: Fixed NAT Periodic Configs Logged; ‘fixed-nat-disable-config-logs-sent’: Fixed NAT Periodic Config Logs Sent; ‘fixed-nat-periodic-config-logs-sent’: Fixed NAT Disabled Configs Logged; ‘fixed-nat-periodic-config-logged’: Fixed NAT Disabled Config Logs Sent; ‘fixed-nat-interim-updated’: Fixed NAT Interim Updated; ‘enhanced-user-log’: Enhanced User Log; ‘log-sent’: Log Packets Sent; ‘log-dropped’: Log Packets Dropped; ‘conn-tcp-established’: TCP Connection Established; ‘conn-tcp-dropped’: TCP Connection Lost; ‘tcp-port-overloading-allocated’: TCP Port Overloading Allocated; ‘tcp-port-overloading-freed’: TCP Port Overloading Freed; ‘udp-port-overloading-allocated’: UDP Port Overloading Allocated; ‘udp-port-overloading-freed’: UDP Port Overloading Freed; ‘http-request-logged’: HTTP Request Logged; ‘reduced-logs-by-destination’: Reduced Logs by Destination Protocol and Port; ‘out-of-buffers’: Out of Buffers; ‘add-msg-failed’: Add Message to Buffer Failed; ‘rtsp-port-allocated’: RTSP UDP Port Allocated; ‘rtsp-port-freed’: RTSP UDP Port Freed; ‘conn-tcp-create-failed’: TCP Connection Failed; ‘ipv4-frag-applied’: IPv4 Fragmentation Applied; ‘ipv4-frag-failed’: IPv4 Fragmentation Failed; ‘ipv6-frag-applied’: IPv6 Fragmentation Applied; ‘ipv6-frag-failed’: IPv6 Fragmentation Failed; ‘interim-update-scheduled’: Port Allocation Interim Update Scheduled; ‘interim-update-schedule-failed’: Port Allocation Interim Update Failed; ‘interim-update-terminated’: Port Allocation Interim Update Terminated; ‘interim-update-memory-freed’: Port Allocation Interim Update Memory Freed; ‘interim-update-no-buff-retried’: Port Allocation Interim Update Memory Freed; ‘tcp-port-batch-interim-updated’: TCP Port Batch Interim Updated; ‘udp-port-batch-interim-updated’: UDP Port Batch Interim Updated; ‘port-block-accounting-freed’: Port Allocation Accounting Freed; ‘port-block-accounting-allocated’: Port Allocation Accounting Allocated; ‘log-message-too-long’: Log message too long; ‘http-out-of-order-dropped’: HTTP out-of-order dropped; ‘http-alloc-failed’: HTTP Request Info Allocation Failed; ‘http-frag-merge-failed-dropped’: HTTP frag merge failed dropped; ‘http-malloc’: HTTP mem allocate; ‘http-mfree’: HTTP mem free; ‘http-spm-alloc-type0’: HTTP Conn SPM Type 0 allocate; ‘http-spm-alloc-type1’: HTTP Conn SPM Type 1 allocate; ‘http-spm-alloc-type2’: HTTP Conn SPM Type 2 allocate; ‘http-spm-alloc-type3’: HTTP Conn SPM Type 3 allocate; ‘http-spm-alloc-type4’: HTTP Conn SPM Type 4 allocate; ‘http-spm-free-type0’: HTTP Conn SPM Type 0 free; ‘http-spm-free-type1’: HTTP Conn SPM Type 1 free; ‘http-spm-free-type2’: HTTP Conn SPM Type 2 free; ‘http-spm-free-type3’: HTTP Conn SPM Type 3 free; ‘http-spm-free-type4’: HTTP Conn SPM Type 4 free; ‘iddos-l3-entry-create’: iDDoS L3 Entry Created; ‘iddos-l3-entry-delete’: iDDoS L3 Entry Deleted; ‘iddos-l4-entry-create’: iDDoS L4 Entry Created; ‘iddos-l4-entry-delete’: iDDoS L4 Entry Deleted;
Type: string
Supported Values: all, tcp-session-created, tcp-session-deleted, tcp-port-allocated, tcp-port-freed, tcp-port-batch-allocated, tcp-port-batch-freed, udp-session-created, udp-session-deleted, udp-port-allocated, udp-port-freed, udp-port-batch-allocated, udp-port-batch-freed, icmp-session-created, icmp-session-deleted, icmp-resource-allocated, icmp-resource-freed, icmpv6-session-created, icmpv6-session-deleted, icmpv6-resource-allocated, icmpv6-resource-freed, gre-session-created, gre-session-deleted, gre-resource-allocated, gre-resource-freed, esp-session-created, esp-session-deleted, esp-resource-allocated, esp-resource-freed, fixed-nat-user-ports, fixed-nat-disable-config-logged, fixed-nat-disable-config-logs-sent, fixed-nat-periodic-config-logs-sent, fixed-nat-periodic-config-logged, fixed-nat-interim-updated, enhanced-user-log, log-sent, log-dropped, conn-tcp-established, conn-tcp-dropped, tcp-port-overloading-allocated, tcp-port-overloading-freed, udp-port-overloading-allocated, udp-port-overloading-freed, http-request-logged, reduced-logs-by-destination, out-of-buffers, add-msg-failed, rtsp-port-allocated, rtsp-port-freed, conn-tcp-create-failed, ipv4-frag-applied, ipv4-frag-failed, ipv6-frag-applied, ipv6-frag-failed, interim-update-scheduled, interim-update-schedule-failed, interim-update-terminated, interim-update-memory-freed, interim-update-no-buff-retried, tcp-port-batch-interim-updated, udp-port-batch-interim-updated, port-block-accounting-freed, port-block-accounting-allocated, log-message-too-long, http-out-of-order-dropped, http-alloc-failed, http-frag-merge-failed-dropped, http-malloc, http-mfree, http-spm-alloc-type0, http-spm-alloc-type1, http-spm-alloc-type2, http-spm-alloc-type3, http-spm-alloc-type4, http-spm-free-type0, http-spm-free-type1, http-spm-free-type2, http-spm-free-type3, http-spm-free-type4, iddos-l3-entry-create, iddos-l3-entry-delete, iddos-l4-entry-create, iddos-l4-entry-delete
logging_source-address¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
logging_tcp-svr-status¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
logging_nat-resource-exhausted¶
Specification
Value
Type
object
level
Description ‘warning’: Log level Warning; ‘critical’: Log level Critical (Default); ‘notice’: Log level Notice;
Type: string
Supported Values: warning, critical, notice
Default: critical
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
logging_nat-quota-exceeded¶
Specification
Value
Type
object
level
Description ‘warning’: Log level Warning (Default); ‘critical’: Log level Critical; ‘notice’: Log level Notice;
Type: string
Supported Values: warning, critical, notice
Default: warning
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
l4¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
l4_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘no-fwd-route’: No Forward Route for Session; ‘no-rev-route’: No Reverse Route for Session; ‘out-of-session-memory’: Out of Session Memory; ‘tcp-rst-sent’: TCP RST Sent; ‘ipip-icmp-reply-sent’: IPIP ICMP Echo Reply Sent; ‘icmp-filtered-sent’: ICMP Administratively Filtered Sent; ‘icmp-host-unreachable-sent’: ICMP Host Unreachable Sent; ‘icmp-reply-no-session-drop’: ICMP Reply No Session Drop; ‘ipip-truncated’: IPIP Truncated Packet; ‘ip-src-invalid-unicast’: IPv4 Source Not Valid Unicast; ‘ip-dst-invalid-unicast’: IPv4 Destination Not Valid Unicast; ‘ipv6-src-invalid-unicast’: IPv6 Source Not Valid Unicast; ‘ipv6-dst-invalid-unicast’: IPv6 Destination Not Valid Unicast; ‘rate_drop_reset_unkn’: Rate Drop reset; ‘bad-l3-protocol’: Bad Layer 3 Protocol; ‘special-ipv4-no-route’: Stateless IPv4 No Forward Route; ‘special-ipv6-no-route’: Stateless IPv6 No Forward Route; ‘icmp-reply-sent’: ICMP Echo Reply Sent; ‘icmpv6-reply-sent’: ICMPv6 Echo Reply Sent; ‘out-of-state-dropped’: L4 Out of State packets; ‘ttl-exceeded-sent’: ICMP TTL Exceeded Sent; ‘cross-cpu-alg-gre-no-match’: ALG GRE Cross CPU No Matching Session; ‘cross-cpu-alg-gre-preprocess-err’: ALG GRE Cross CPU Preprocess Error; ‘lsn-fast-setup’: LSN Fast Setup Attempt; ‘lsn-fast-setup-err’: LSN Fast Setup Error; ‘nat64-fast-setup’: NAT64 Fast Setup Attempt; ‘nat64-fast-setup-err’: NAT64 Fast Setup Error; ‘dslite-fast-setup’: DS-Lite Fast Setup Attempt; ‘dslite-fast-setup-err’: DS-Lite Fast Setup Error; ‘fast-setup-delayed-err’: Fast Setup Delayed Error; ‘fast-setup-mtu-too-small’: Fast Setup MTU Too Small; ‘fixed-nat44-fast-setup’: Fixed NAT Fast Setup Attempt; ‘fixed-nat44-fast-setup-err’: Fixed NAT Fast Setup Error; ‘fixed-nat64-fast-setup’: Fixed NAT Fast Setup Attempt; ‘fixed-nat64-fast-setup-err’: Fixed NAT Fast Setup Error; ‘fixed-nat-dslite-fast-setup’: Fixed NAT Fast Setup Attempt; ‘fixed-nat-dslite-fast-setup-err’: Fixed NAT Fast Setup Error; ‘fixed-nat-fast-setup-delayed-err’: Fixed NAT Fast Setup Delayed Error; ‘fixed-nat-fast-setup-mtu-too-small’: Fixed NAT Fast Setup MTU Too Small; ‘static-nat-fast-setup’: Static NAT Fast Setup Attempt; ‘static-nat-fast-setup-err’: Static NAT Fast Setup Error; ‘dst-nat-needed-drop’: Destination NAT Needed Drop; ‘invalid-nat64-translated-addr’: Invalid NAT64 Translated IPv4 Address; ‘tcp-rst-loop-drop’: RST Loop Drop; ‘static-nat-alloc’: Static NAT Alloc; ‘static-nat-free’: Static NAT Free; ‘process-l4’: Process L4; ‘preprocess-error’: Preprocess Error; ‘process-special’: Process Special; ‘process-continue’: Process Continue; ‘process-error’: Process Error; ‘fw-match-no-rule-drop’: Firewall Matched No CGNv6 Rule Drop; ‘ip-unknown-process’: Process IP Unknown; ‘src-nat-pool-not-found’: Src NAT Pool Not Found; ‘dst-nat-pool-not-found’: Dst NAT Pool Not Found; ‘l3-ip-src-invalid-unicast’: IPv4 L3 Source Invalid Unicast; ‘l3-ip-dst-invalid-unicast’: IPv4 L3 Destination Invalid Unicast; ‘l3-ipv6-src-invalid-unicast’: IPv6 L3 Source Invalid Unicast; ‘l3-ipv6-dst-invalid-unicast’: IPv6 L3 Destination Invalid Unicast; ‘fw-zone-mismatch-rerouting-drop’: Rerouting Zone Mismatch Drop; ‘nat-range-list-acl-deny’: Nat range-list ACL deny; ‘nat-range-list-acl-permit’: Nat range-list ACL permit; ‘fw-next-action-incorrect-drop’: FW Next Action Incorrect Drop;
Type: string
Supported Values: all, no-fwd-route, no-rev-route, out-of-session-memory, tcp-rst-sent, ipip-icmp-reply-sent, icmp-filtered-sent, icmp-host-unreachable-sent, icmp-reply-no-session-drop, ipip-truncated, ip-src-invalid-unicast, ip-dst-invalid-unicast, ipv6-src-invalid-unicast, ipv6-dst-invalid-unicast, rate_drop_reset_unkn, bad-l3-protocol, special-ipv4-no-route, special-ipv6-no-route, icmp-reply-sent, icmpv6-reply-sent, out-of-state-dropped, ttl-exceeded-sent, cross-cpu-alg-gre-no-match, cross-cpu-alg-gre-preprocess-err, lsn-fast-setup, lsn-fast-setup-err, nat64-fast-setup, nat64-fast-setup-err, dslite-fast-setup, dslite-fast-setup-err, fast-setup-delayed-err, fast-setup-mtu-too-small, fixed-nat44-fast-setup, fixed-nat44-fast-setup-err, fixed-nat64-fast-setup, fixed-nat64-fast-setup-err, fixed-nat-dslite-fast-setup, fixed-nat-dslite-fast-setup-err, fixed-nat-fast-setup-delayed-err, fixed-nat-fast-setup-mtu-too-small, static-nat-fast-setup, static-nat-fast-setup-err, dst-nat-needed-drop, invalid-nat64-translated-addr, tcp-rst-loop-drop, static-nat-alloc, static-nat-free, process-l4, preprocess-error, process-special, process-continue, process-error, fw-match-no-rule-drop, ip-unknown-process, src-nat-pool-not-found, dst-nat-pool-not-found, l3-ip-src-invalid-unicast, l3-ip-dst-invalid-unicast, l3-ipv6-src-invalid-unicast, l3-ipv6-dst-invalid-unicast, fw-zone-mismatch-rerouting-drop, nat-range-list-acl-deny, nat-range-list-acl-permit, fw-next-action-incorrect-drop
icmp¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘icmp-unknown-type’: ICMP Unknown Type; ‘icmp-no-port-info’: ICMP Port Info Not Included; ‘icmp-no-session-drop’: ICMP No Matching Session Drop; ‘icmpv6-unknown-type’: ICMPv6 Unknown Type; ‘icmpv6-no-port-info’: ICMPv6 Port Info Not Included; ‘icmpv6-no-session-drop’: ICMPv6 No Matching Session Drop; ‘icmp-to-icmp’: ICMP to ICMP Conversion; ‘icmp-to-icmpv6’: ICMP to ICMPv6 Conversion; ‘icmpv6-to-icmp’: ICMPv6 to ICMP Conversion; ‘icmpv6-to-icmpv6’: ICMPv6 to ICMPv6 Conversion; ‘icmp-bad-type’: Bad Embedded ICMP Type; ‘icmpv6-bad-type’: Bad Embedded ICMPv6 Type; ‘64-known-drop’: NAT64 Forward Known ICMPv6 Drop; ‘64-unknown-drop’: NAT64 Forward Unknown ICMPv6 Drop; ‘64-midpoint-hop’: NAT64 Forward Unknown Source Drop; ‘46-known-drop’: NAT64 Reverse Known ICMP Drop; ‘46-unknown-drop’: NAT64 Reverse Known ICMPv6 Drop; ‘46-no-prefix-for-ipv4’: NAT64 Reverse No Prefix Match for IPv4; ‘46-bad-encap-ip-header-len’: 4to6 Bad Encapsulated IP Header Length; ‘icmp-to-icmp-err’: ICMP to ICMP Conversion Error; ‘icmp-to-icmpv6-err’: ICMP to ICMPv6 Conversion Error; ‘icmpv6-to-icmp-err’: ICMPv6 to ICMP Conversion Error; ‘icmpv6-to-icmpv6-err’: ICMPv6 to ICMPv6 Conversion Error; ‘encap-cross-cpu-no-match’: ICMP Embedded Cross CPU No Matching Session; ‘encap-cross-cpu-preprocess-err’: ICMP Embedded Cross CPU Preprocess Error; ‘icmp-to-icmp-unknown-l4’: ICMP Embedded Unknown L4 Protocol; ‘icmp-to-icmpv6-unknown-l4’: ICMP to ICMPv6 Embedded Unknown L4 Protocol; ‘icmpv6-to-icmp-unknown-l4’: ICMPv6 to ICMP Embedded Unknown L4 Protocol; ‘icmpv6-to-icmpv6-unknown-l4’: ICMPv6 to ICMPv6 Embedded Unknown L4 Protocol; ‘static-nat’: ICMP Static NAT; ‘echo-to-pool-reply’: Ping to Pool Reply; ‘echo-to-pool-drop’: Ping to Pool Drop; ‘error-to-pool-drop’: Error to Pool Drop; ‘echo-to-pool-reply-v6’: Ping6 to Pool Reply; ‘echo-to-pool-drop-v6’: Ping6 to Pool Drop; ‘error-to-pool-drop-v6’: Error to IPv6 Pool Drop; ‘error-ip-mismatch’: ICMP IP address mismatch;
Type: string
Supported Values: all, icmp-unknown-type, icmp-no-port-info, icmp-no-session-drop, icmpv6-unknown-type, icmpv6-no-port-info, icmpv6-no-session-drop, icmp-to-icmp, icmp-to-icmpv6, icmpv6-to-icmp, icmpv6-to-icmpv6, icmp-bad-type, icmpv6-bad-type, 64-known-drop, 64-unknown-drop, 64-midpoint-hop, 46-known-drop, 46-unknown-drop, 46-no-prefix-for-ipv4, 46-bad-encap-ip-header-len, icmp-to-icmp-err, icmp-to-icmpv6-err, icmpv6-to-icmp-err, icmpv6-to-icmpv6-err, encap-cross-cpu-no-match, encap-cross-cpu-preprocess-err, icmp-to-icmp-unknown-l4, icmp-to-icmpv6-unknown-l4, icmpv6-to-icmp-unknown-l4, icmpv6-to-icmpv6-unknown-l4, static-nat, echo-to-pool-reply, echo-to-pool-drop, error-to-pool-drop, echo-to-pool-reply-v6, echo-to-pool-drop-v6, error-to-pool-drop-v6, error-ip-mismatch
http-alg¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
http-alg_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘request-processed’: HTTP Request Processed; ‘request-insert-msisdn-performed’: HTTP MSISDN Insertion Performed; ‘request-insert-client-ip-performed’: HTTP Client IP Insertion Performed; ‘request-insert-msisdn-unavailable’: Inserted MSISDN is 0000 (MSISDN Unavailable); ‘queued-session-too-many’: Queued Session Exceed Drop; ‘radius-query-succeed’: MSISDN Query Succeed; ‘radius-query-failed’: MSISDN Query Failed; ‘radius-requst-sent’: Query Request Sent; ‘radius-requst-dropped’: Query Request Dropped; ‘radius-response-received’: Query Response Received; ‘radius-response-dropped’: Query Response Dropped; ‘out-of-memory-dropped’: Out-of-Memory Dropped; ‘queue-len-exceed-dropped’: Queue Length Exceed Dropped; ‘out-of-order-dropped’: Packet Out-of-Order Dropped; ‘buff-resent’: Packet Resent from Queue; ‘buff-spilt-failed’: Buff Split Failed; ‘header-insertion-failed’: Buff Insertion Failed; ‘header-removal-failed’: Buff Removal Failed; ‘no-queue’: No Queue;
Type: string
Supported Values: all, request-processed, request-insert-msisdn-performed, request-insert-client-ip-performed, request-insert-msisdn-unavailable, queued-session-too-many, radius-query-succeed, radius-query-failed, radius-requst-sent, radius-requst-dropped, radius-response-received, radius-response-dropped, out-of-memory-dropped, queue-len-exceed-dropped, out-of-order-dropped, buff-resent, buff-spilt-failed, header-insertion-failed, header-removal-failed, no-queue
dns64¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns64_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘query’: Query; ‘query-bad-pkt’: Query Bad Packet; ‘query-chg’: Query Changed; ‘query-parallel’: Query Parallel; ‘query-passive’: Query Passive; ‘resp’: Response; ‘resp-bad-pkt’: Response Bad Packet; ‘resp-bad-qr’: Response Bad Query; ‘resp-chg’: Response Changed; ‘resp-err’: Response Error; ‘resp-empty’: Response Empty; ‘resp-local’: Response Local; ‘adjust’: Translated; ‘cache’: Cache; ‘drop’: Dropped;
Type: string
Supported Values: all, query, query-bad-pkt, query-chg, query-parallel, query-passive, resp, resp-bad-pkt, resp-bad-qr, resp-chg, resp-err, resp-empty, resp-local, adjust, cache, drop
map¶
Specification
Value
Type
object
encapsulation
Description: encapsulation is a JSON Block. Please see below for map_encapsulation
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation
translation
Description: translation is a JSON Block. Please see below for map_translation
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation
map_translation¶
Specification
Value
Type
object
default-domain
Description: default-domain is a JSON Block. Please see below for map_translation_default-domain
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/default-domain
domain-list
Type: List
Reference Object: /axapi/v3/cgnv6/map/translation/domain/{name}
fragmentation
Description: fragmentation is a JSON Block. Please see below for map_translation_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/fragmentation
map_translation_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for map_translation_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for map_translation_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/fragmentation/outbound
map_translation_fragmentation_inbound¶
Specification
Value
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_translation_fragmentation_outbound¶
Specification
Value
Type
object
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_translation_domain-list¶
Specification
Value
Type
list
Block object keys
basic-mapping-rule
Description: basic-mapping-rule is a JSON Block. Please see below for map_translation_domain-list_basic-mapping-rule
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule
default-mapping-rule
Description: default-mapping-rule is a JSON Block. Please see below for map_translation_domain-list_default-mapping-rule
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/domain/{name}/default-mapping-rule
description
Description MAP-T domain description
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
health-check-gateway
Description: health-check-gateway is a JSON Block. Please see below for map_translation_domain-list_health-check-gateway
Type: Object
Reference Object: /axapi/v3/cgnv6/map/translation/domain/{name}/health-check-gateway
mtu
Description Domain MTU
Type: number
name
Description MAP-T domain name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/cgnv6-map-trans-domain-tmpl
sampling-enable
Type: List
tcp
Description: tcp is a JSON Block. Please see below for map_translation_domain-list_tcp
Type: Object
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
map_translation_domain-list_tcp¶
Specification
Value
Type
object
mss-clamp
Description: mss-clamp is a JSON Block. Please see below for map_translation_domain-list_tcp_mss-clamp
Type: Object
map_translation_domain-list_tcp_mss-clamp¶
Specification
Value
Type
object
min
Description Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 516))
Type: number
Range: 0-1440
Default: 516
mss-clamp-type
Description ‘fixed’: Specify a fixed max value for the TCP MSS; ‘none’: No TCP MSS clamping(default); ‘subtract’: Specify the value to subtract from the TCP MSS;
Type: string
Supported Values: fixed, none, subtract
Default: none
mss-subtract
Description Specify the value to subtract from the TCP MSS
Type: number
Range: 0-1440
mss-value
Description The max value allowed for the TCP MSS
Type: number
Range: 0-1440
map_translation_domain-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘inbound_packet_received’: Inbound IPv4 Packets Received; ‘inbound_frag_packet_received’: Inbound IPv4 Fragment Packets Received; ‘inbound_addr_port_validation_failed’: Inbound IPv4 Destination Address Port Validation Failed; ‘inbound_rev_lookup_failed’: Inbound IPv4 Reverse Route Lookup Failed; ‘inbound_dest_unreachable’: Inbound IPv6 Destination Address Unreachable; ‘outbound_packet_received’: Outbound IPv6 Packets Received; ‘outbound_frag_packet_received’: Outbound IPv6 Fragment Packets Received; ‘outbound_addr_validation_failed’: Outbound IPv6 Source Address Validation Failed; ‘outbound_rev_lookup_failed’: Outbound IPv6 Reverse Route Lookup Failed; ‘outbound_dest_unreachable’: Outbound IPv4 Destination Address Unreachable; ‘packet_mtu_exceeded’: Packet Exceeded MTU; ‘frag_icmp_sent’: ICMP Packet Too Big Sent; ‘interface_not_configured’: Interfaces not Configured Dropped; ‘bmr_prefixrules_configured’: BMR prefix rules configured; ‘helper_count’: Helper Count; ‘active_dhcpv6_leases’: Active DHCPv6 leases;
Type: string
Supported Values: all, inbound_packet_received, inbound_frag_packet_received, inbound_addr_port_validation_failed, inbound_rev_lookup_failed, inbound_dest_unreachable, outbound_packet_received, outbound_frag_packet_received, outbound_addr_validation_failed, outbound_rev_lookup_failed, outbound_dest_unreachable, packet_mtu_exceeded, frag_icmp_sent, interface_not_configured, bmr_prefixrules_configured, helper_count, active_dhcpv6_leases
map_translation_domain-list_health-check-gateway¶
Specification
Value
Type
object
address-list
Type: List
ipv6-address-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
withdraw-route
Description ‘all-link-failure’: Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; ‘any-link-failure’: Withdraw routes on health-check failure of any gateway (default);
Type: string
Supported Values: all-link-failure, any-link-failure
Default: any-link-failure
map_translation_domain-list_health-check-gateway_address-list¶
Specification
Value
Type
list
Block object keys
ipv4-gateway
Description IPv4 Gateway
Type: string
Format: ipv4-address
map_translation_domain-list_health-check-gateway_ipv6-address-list¶
Specification
Value
Type
list
Block object keys
ipv6-gateway
Description IPv6 Gateway
Type: string
Format: ipv6-address
map_translation_domain-list_default-mapping-rule¶
Specification
Value
Type
object
rule-ipv6-prefix
Description Rule IPv6 prefix
Type: string
Format: ipv6-address-plen
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_translation_domain-list_basic-mapping-rule¶
Specification
Value
Type
object
ea-length
Description Length of Embedded Address (EA) bits
Type: number
Range: 0-23
port-start
Description Starting Port, Must be Power of 2 value or zero
Type: number
Range: 0-32768
prefix-rule-list
Type: List
Reference Object: /axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule/prefix-rule/{name}
rule-ipv4-address-port-settings
Description ‘prefix-addr’: Each CE is assigned an IPv4 prefix; ‘single-addr’: Each CE is assigned an IPv4 address; ‘shared-addr’: Each CE is assigned a shared IPv4 address;
Type: string
Supported Values: prefix-addr, single-addr, shared-addr
share-ratio
Description Port sharing ratio for each NAT IP. Must be Power of 2 value
Type: number
Range: 1-65536
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_translation_domain-list_basic-mapping-rule_prefix-rule-list¶
Specification
Value
Type
list
Block object keys
ipv4-netmask
Description Subnet mask (subnet bigger than /8 is not allowed)
Type: string
Format: ipv4-netmask-brief
name
Description MAP BMR prefix rule name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
rule-ipv4-prefix
Description IPv4 prefix of BMR
Type: string
Format: ipv4-address
rule-ipv6-prefix
Description IPv6 prefix of BMR
Type: string
Format: ipv6-address-plen
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
map_translation_default-domain¶
Specification
Value
Type
object
name
Description MAP-T domain name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/cgnv6/map/translation/domain
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_encapsulation¶
Specification
Value
Type
object
domain-list
Type: List
Reference Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}
fragmentation
Description: fragmentation is a JSON Block. Please see below for map_encapsulation_fragmentation
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation
map_encapsulation_fragmentation¶
Specification
Value
Type
object
inbound
Description: inbound is a JSON Block. Please see below for map_encapsulation_fragmentation_inbound
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation/inbound
outbound
Description: outbound is a JSON Block. Please see below for map_encapsulation_fragmentation_outbound
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation/fragmentation/outbound
map_encapsulation_fragmentation_inbound¶
Specification
Value
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default);
Type: string
Supported Values: drop, ipv4, ipv6, send-icmp
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘ipv6’: Use IPv6 fragmentation for oversize packets (default);
Type: string
Supported Values: drop, ipv4, ipv6
Default: ipv6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_encapsulation_fragmentation_outbound¶
Specification
Value
Type
object
df-set
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets; ‘send-icmp’: Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set)(default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmp, send-icmpv6
Default: send-icmp
frag-action
Description ‘drop’: Drop Silently; ‘ipv4’: Use IPv4 fragmentation for oversize packets (default); ‘send-icmpv6’: Send ICMP Type 2 Code 0 (Packet Too Big);
Type: string
Supported Values: drop, ipv4, send-icmpv6
Default: ipv4
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_encapsulation_domain-list¶
Specification
Value
Type
list
Block object keys
basic-mapping-rule
Description: basic-mapping-rule is a JSON Block. Please see below for map_encapsulation_domain-list_basic-mapping-rule
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule
description
Description MAP-E domain description
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
format
Description ‘draft-03’: Construct IPv6 Interface Identifier according to draft-03;
Type: string
Supported Values: draft-03
health-check-gateway
Description: health-check-gateway is a JSON Block. Please see below for map_encapsulation_domain-list_health-check-gateway
Type: Object
Reference Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/health-check-gateway
name
Description MAP-E domain name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/cgnv6-encap-domain-tmpl
sampling-enable
Type: List
tunnel-endpoint-address
Description Tunnel Endpoint Address for MAP-E domain
Type: string
Format: ipv6-address
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
map_encapsulation_domain-list_sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘inbound_packet_received’: Inbound IPv4 Packets Received; ‘inbound_frag_packet_received’: Inbound IPv4 Fragment Packets Received; ‘inbound_addr_port_validation_failed’: Inbound IPv4 Destination Address Port Validation Failed; ‘inbound_rev_lookup_failed’: Inbound IPv4 Reverse Route Lookup Failed; ‘inbound_dest_unreachable’: Inbound IPv6 Destination Address Unreachable; ‘outbound_packet_received’: Outbound IPv6 Packets Received; ‘outbound_frag_packet_received’: Outbound IPv6 Fragment Packets Received; ‘outbound_addr_validation_failed’: Outbound IPv6 Source Address Validation Failed; ‘outbound_rev_lookup_failed’: Outbound IPv6 Reverse Route Lookup Failed; ‘outbound_dest_unreachable’: Outbound IPv4 Destination Address Unreachable; ‘packet_mtu_exceeded’: Packet Exceeded MTU; ‘frag_icmp_sent’: ICMP Packet Too Big Sent; ‘interface_not_configured’: Interfaces not Configured Dropped; ‘bmr_prefixrules_configured’: BMR prefix rules configured; ‘helper_count’: Helper Count; ‘active_dhcpv6_leases’: Active DHCPv6 leases;
Type: string
Supported Values: all, inbound_packet_received, inbound_frag_packet_received, inbound_addr_port_validation_failed, inbound_rev_lookup_failed, inbound_dest_unreachable, outbound_packet_received, outbound_frag_packet_received, outbound_addr_validation_failed, outbound_rev_lookup_failed, outbound_dest_unreachable, packet_mtu_exceeded, frag_icmp_sent, interface_not_configured, bmr_prefixrules_configured, helper_count, active_dhcpv6_leases
map_encapsulation_domain-list_health-check-gateway¶
Specification
Value
Type
object
address-list
Type: List
ipv6-address-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
withdraw-route
Description ‘all-link-failure’: Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; ‘any-link-failure’: Withdraw routes on health-check failure of any gateway (default);
Type: string
Supported Values: all-link-failure, any-link-failure
Default: any-link-failure
map_encapsulation_domain-list_health-check-gateway_address-list¶
Specification
Value
Type
list
Block object keys
ipv4-gateway
Description IPv4 Gateway
Type: string
Format: ipv4-address
map_encapsulation_domain-list_health-check-gateway_ipv6-address-list¶
Specification
Value
Type
list
Block object keys
ipv6-gateway
Description IPv6 Gateway
Type: string
Format: ipv6-address
map_encapsulation_domain-list_basic-mapping-rule¶
Specification
Value
Type
object
ea-length
Description Length of Embedded Address (EA) bits
Type: number
Range: 0-23
port-start
Description Starting Port, Must be Power of 2 value or zero
Type: number
Range: 0-32768
prefix-rule-list
Type: List
Reference Object: /axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}
rule-ipv4-address-port-settings
Description ‘prefix-addr’: Each CE is assigned an IPv4 prefix; ‘single-addr’: Each CE is assigned an IPv4 address; ‘shared-addr’: Each CE is assigned a shared IPv4 address;
Type: string
Supported Values: prefix-addr, single-addr, shared-addr
share-ratio
Description Port sharing ratio for each NAT IP. Must be Power of 2 value
Type: number
Range: 1-65536
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
map_encapsulation_domain-list_basic-mapping-rule_prefix-rule-list¶
Specification
Value
Type
list
Block object keys
ea-length
Description Length of Embedded Address (EA) bits
Type: number
Range: 0-23
ipv4-address-port-settings
Description ‘prefix-addr’: Each CE is assigned an IPv4 prefix; ‘single-addr’: Each CE is assigned an IPv4 address; ‘shared-addr’: Each CE is assigned a shared IPv4 address;
Type: string
Supported Values: prefix-addr, single-addr, shared-addr
ipv4-netmask
Description Subnet mask (subnet bigger than /8 is not allowed)
Type: string
Format: ipv4-netmask-brief
name
Description MAP BMR prefix rule name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-start
Description Starting Port, Must be Power of 2 value or zero
Type: number
Range: 0-32768
rule-ipv4-prefix
Description IPv4 prefix of BMR
Type: string
Format: ipv4-address
rule-ipv6-prefix
Description IPv6 prefix of BMR
Type: string
Format: ipv6-address-plen
share-ratio
Description Port sharing ratio for each NAT IP. Must be Power of 2 value
Type: number
Range: 1-65536
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