cgnv6 dns64-virtualserver¶

Create a DNS64 Virtual Server

dns64-virtualserver Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name dns64-virtualserver-list

Collection URI /axapi/v3/cgnv6/dns64-virtualserver

Element Name dns64-virtualserver

Element URI /axapi/v3/cgnv6/dns64-virtualserver/{name}

Element Attributes dns64-virtualserver_attributes

Partition Visibility shared

Operational Data URI /axapi/v3/cgnv6/dns64-virtualserver/{name}/oper

Schema dns64-virtualserver schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cgnv6/dns64-virtualserver	dns64-virtualserver attributes
POST /axapi/v3/cgnv6/dns64-virtualserver/ Payload: { "dns64-virtualserver": { "name": "a", "ipv6-address": "2003::1" } }
Create List	POST	/axapi/v3/cgnv6/dns64-virtualserver	dns64-virtualserver attributes
Get Object	GET	/axapi/v3/cgnv6/dns64-virtualserver/{name}	dns64-virtualserver attributes
GET /axapi/v3/cgnv6/dns64-virtualserver/a Reponse: { "dns64-virtualserver": { "name": "a", "ipv6-address": "2003::1", "enable-disable-action": "enable", "policy": 0, "uuid": "a69fca90-4f6a-11ee-9e04-5d5bbc5e5064", "a10-url": "/axapi/v3/cgnv6/dns64-virtualserver/a" } }
Get List	GET	/axapi/v3/cgnv6/dns64-virtualserver	dns64-virtualserver-list
Modify Object	POST	/axapi/v3/cgnv6/dns64-virtualserver/{name}	dns64-virtualserver attributes
Replace Object	PUT	/axapi/v3/cgnv6/dns64-virtualserver/{name}	dns64-virtualserver attributes
PUT /axapi/v3/cgnv6/dns64-virtualserver/a Payload: { "dns64-virtualserver": { "name": "a", "ipv6-address": "2003::1" } }
Replace List	PUT	/axapi/v3/cgnv6/dns64-virtualserver	dns64-virtualserver-list
Delete Object	DELETE	/axapi/v3/cgnv6/dns64-virtualserver/{name}	dns64-virtualserver attributes
DELETE /axapi/v3/cgnv6/dns64-virtualserver/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

dns64-virtualserver-list¶

dns64-virtualserver-list is JSON List of dns64-virtualserver attributes

dns64-virtualserver-list : [

{ dns64-virtualserver attributes },

{ dns64-virtualserver attributes },

…

]

dns64-virtualserver attributes¶

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

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

Reference Object: /axapi/v3/ip/nat/pool

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

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

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

Reference Object: /axapi/v3/ip/access-list

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

Reference Object: /axapi/v3/ip/nat/pool

port-list_acl-id-list¶

Specification Value

Type list

Block object keys

acl-id

Description ACL id VPORT

Type: number

Range: 1-199

Reference Object: /axapi/v3/access-list/standard

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

Reference Object: /axapi/v3/ip/nat/pool