cgnv6 ds-lite

Configure Dual-Stack Lite (DS-Lite)

ds-lite Specification

Type	Intermediate Resource
Element Name	ds-lite
Element URI	/axapi/v3/cgnv6/ds-lite
Element Attributes	ds-lite_attributes
Schema	ds-lite schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/cgnv6/ds-lite	ds-lite_attributes

ds-lite attributes

alg

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

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg

fragmentation

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

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/fragmentation

full-cone-session

Description: full-cone-session is a JSON Block. Please see below for full-cone-session

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/full-cone-session

global

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

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/global

port-reservation-entries

Description: port-reservation-entries is a JSON Block. Please see below for port-reservation-entries

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/port-reservation-entries

port-reservation-list

Type: List

Refernce Object: /axapi/v3/cgnv6/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port}

user-quota-session

Description: user-quota-session is a JSON Block. Please see below for user-quota-session

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/user-quota-session

fragmentation

Specification
Type	object

inbound

Description: inbound is a JSON Block. Please see below for fragmentation_inbound

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/fragmentation/inbound

outbound

Description: outbound is a JSON Block. Please see below for fragmentation_outbound

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/fragmentation/outbound

fragmentation_inbound

Specification
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

fragmentation_outbound

Specification
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

full-cone-session

Specification
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

alg

Specification
Type	object

ftp

Description: ftp is a JSON Block. Please see below for alg_ftp

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/ftp

h323

Description: h323 is a JSON Block. Please see below for alg_h323

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/h323

mgcp

Description: mgcp is a JSON Block. Please see below for alg_mgcp

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/mgcp

pptp

Description: pptp is a JSON Block. Please see below for alg_pptp

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/pptp

rtsp

Description: rtsp is a JSON Block. Please see below for alg_rtsp

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/rtsp

sip

Description: sip is a JSON Block. Please see below for alg_sip

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/sip

tftp

Description: tftp is a JSON Block. Please see below for alg_tftp

Type: Object

Refernce Object: /axapi/v3/cgnv6/ds-lite/alg/tftp

alg_ftp

Specification
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

alg_sip

Specification
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

alg_pptp

Specification
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

alg_rtsp

Specification
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

alg_h323

Specification
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

alg_tftp

Specification
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

alg_mgcp

Specification
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

global

Specification
Type	object

icmp

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

Type: Object

inside

Description: inside is a JSON Block. Please see below for 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

tcp

Description: tcp is a JSON Block. Please see below for 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

global_inside

Specification
Type	object

source

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

Type: Object

global_inside_source

Specification
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

global_tcp

Specification
Type	object

mss-clamp

Description: mss-clamp is a JSON Block. Please see below for global_tcp_mss-clamp

Type: Object

reset-on-error

Description: reset-on-error is a JSON Block. Please see below for global_tcp_reset-on-error

Type: Object

global_tcp_mss-clamp

Specification
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

global_tcp_reset-on-error

Specification
Type	object

outbound

Description ‘disable’: Disable send TCP reset on error;

Type: string

Supported Values: disable

global_icmp

Specification
Type	object

send-on-port-unavailable

Description ‘host-unreachable’: Send ICMP destination host unreachable; ‘admin-filtered’: Send ICMP admin filtered; ‘disable’: Disable ICMP port unavailable message (default);

Type: string

Supported Values: host-unreachable, admin-filtered, disable

Default: disable

send-on-user-quota-exceeded

Description ‘host-unreachable’: Send ICMP destination host unreachable; ‘admin-filtered’: Send ICMP admin filtered (default); ‘disable’: Disable ICMP quota exceeded message;

Type: string

Supported Values: host-unreachable, admin-filtered, disable

Default: admin-filtered

port-reservation-list

Specification
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

user-quota-session

Specification
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-reservation-entries

Specification
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters