.. _cgnv6_dns64_virtualserver:

cgnv6 dns64-virtualserver
=========================

Create a DNS64 Virtual Server


dns64-virtualserver Specification
---------------------------------

	===================================== =========================================================================
	 **Parameter**                         **Value** 

	===================================== =========================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`248_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**                             :download:`dns64-virtualserver schema <cgnv6-dns64-virtualserver/cgnv6-dns64-virtualserver.txt>`
	===================================== =========================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/dns64-virtualserver



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/cgnv6_dns64_virtualserver_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/dns64-virtualserver



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/cgnv6_dns64_virtualserver_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/dns64-virtualserver



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/cgnv6_dns64_virtualserver_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/dns64-virtualserver



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`248_dns64-virtualserver_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/cgnv6_dns64_virtualserver_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _248_dns64-virtualserver_list:

dns64-virtualserver-list
------------------------


    dns64-virtualserver-list is **JSON List** of :ref:`248_dns64-virtualserver_attributes` 

        dns64-virtualserver-list : [

             { :ref:`248_dns64-virtualserver_attributes` },

             { :ref:`248_dns64-virtualserver_attributes` },

             ...

         ]

.. _248_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:** :doc:`/axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol} <cgnv6_dns64_virtualserver>`

    **template-policy**

        **Description** Policy template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/cgnv6/template/policy <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

.. _248_port-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:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/cgnv6-dns64-vs-port-tmpl <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:** :doc:`/axapi/v3/ip/nat/pool <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:** :doc:`/axapi/v3/cgnv6/service-group <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:** :doc:`/axapi/v3/cgnv6/template/dns <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:** :doc:`/axapi/v3/cgnv6/template/policy <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

.. _248_port-list_sampling-enable:

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

.. _248_port-list_acl-name-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

        **Reference Object:** :doc:`/axapi/v3/ip/access-list <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:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

.. _248_port-list_acl-id-list:

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:** :doc:`/axapi/v3/access-list/standard <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:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`