.. _cgnv6_dns64_virtualserver_port:

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

Virtual Port


port Specification
------------------

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

	 **Object Key(s)**                     *port-number, protocol*

	 **Collection Name**                   :ref:`407_port_list`

	 **Collection URI**                    /axapi/v3/cgnv6/dns64-virtualserver/{name}/port

	                                       

	 **Element Name**                      port

	 **Element URI**                       /axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol}

	 **Element Attributes**                port_attributes

	 **Statistics Data URI**               /axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol}/stats

	 **Operational Data URI**              /axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol}/oper

	 **Schema**                             :download:`port schema <cgnv6-dns64-virtualserver-port/cgnv6-dns64-virtualserver-port.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/{name}/port



.. raw:: html

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


:ref:`407_port_attributes`



.. raw:: html

   </td><td></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/{name}/port



.. raw:: html

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


:ref:`407_port_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}/port/{port-number}+{protocol}



.. raw:: html

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


:ref:`407_port_attributes`



.. raw:: html

   </td><td></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/{name}/port



.. raw:: html

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


:ref:`407_port_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}/port/{port-number}+{protocol}



.. raw:: html

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


:ref:`407_port_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}/port/{port-number}+{protocol}



.. raw:: html

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


:ref:`407_port_attributes`



.. raw:: html

   </td><td></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/{name}/port



.. raw:: html

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


:ref:`407_port_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}/port/{port-number}+{protocol}



.. raw:: html

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


:ref:`407_port_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _407_port_list:

port-list
---------


    port-list is **JSON List** of :ref:`407_port_attributes` 

        port-list : [

             { :ref:`407_port_attributes` },

             { :ref:`407_port_attributes` },

             ...

         ]

.. _407_port_attributes:

port attributes
---------------

    **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

    **pool**

        **Description** Specify NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Refernce 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

        **Refernce 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

        **Refernce 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

        **Refernce 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

.. _407_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _407_acl-name-list:

acl-name-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

        **Refernce 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

        **Refernce Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

.. _407_acl-id-list:

acl-id-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **acl-id**

        **Description** ACL id VPORT

        **Type:** number

        **Range:** 1-199

        **Refernce 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

        **Refernce Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

.. _407_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - curr_req
      - 8
      - Current requests

   *  - 
      - total_fwd_bytes
      - 8
      - Total forward bytes

   *  - 
      - compression_miss
      - 2
      - Number of requests NOT compressed

   *  - 
      - fastest_rsp_time
      - 8
      - Fastest response time

   *  - 
      - total_fwd_pkts
      - 8
      - Total forward packets

   *  - 
      - total_mf_dns_pkts
      - 2
      - Total MF DNS packets

   *  - 
      - compression_miss_template_exclusion
      - 2
      - Compression miss template exclusion

   *  - 
      - total_dns_pkts
      - 2
      - Total DNS packets

   *  - 
      - peak_conn
      - 8
      - Peak connections

   *  - 
      - compression_bytes_after
      - 2
      - Data out of compression engine

   *  - 
      - toatal_tcp_conn
      - 8
      - Total TCP connections

   *  - 
      - total_req
      - 8
      - Total requests

   *  - 
      - compression_bytes_before
      - 2
      - Data into compression engine

   *  - 
      - last_rsp_time
      - 8
      - Last response time

   *  - 
      - curr_conn
      - 8
      - Current connection

   *  - 
      - total_rev_bytes
      - 8
      - Total reverse bytes

   *  - 
      - curr_conn_rate
      - 8
      - Current connection rate

   *  - 
      - compression_miss_no_client
      - 2
      - Compression miss no client

   *  - 
      - es_total_failure_actions
      - 2
      - Total failure actions

   *  - 
      - total_conn
      - 8
      - Total connections

   *  - 
      - total_rev_pkts
      - 8
      - Total reverse packets

   *  - 
      - total_l7_conn
      - 8
      - Total L7 connections

   *  - 
      - total_req_succ
      - 8
      - Total successful requests

   *  - 
      - total_l4_conn
      - 8
      - Total L4 connections

   *  - 
      - slowest_rsp_time
      - 8
      - Slowest response time

   *  - 
      - compression_hit
      - 2
      - Number of requests compressed

.. _407_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - http_host_hits
      - flag
      - http_host_hits

   *  - 
      - cpu-count
      - number
      - cpu-count

   *  - 
      - loc_last
      - string
      - loc_last

   *  - 
      - loc_list
      - string
      - loc_list

   *  - 
      - http-hits-list
      - 
      - http-hits-list

   *  - 
      - http_vport
      - flag
      - http_vport

   *  - 
      - http_url_hits
      - flag
      - http_url_hits

   *  - 
      - loc_max_depth
      - number
      - loc_max_depth

   *  - 
      - level_str
      - string
      - level_str

   *  - 
      - loc_error
      - number
      - loc_error

   *  - 
      - state
      - enum
      -  Output contains one of the following values: - All Up, Functional Up, Down, Disb, Unkn

   *  - 
      - geo_location
      - string
      - geo_location

   *  - 
      - http-vport-cpu-list
      - 
      - http-vport-cpu-list

   *  - 
      - real_curr_conn
      - number
      - real_curr_conn

   *  - 
      - loc_success
      - number
      - loc_success

   *  - 
      - curr_conn_overflow
      - number
      - curr_conn_overflow

   *  - 
      - group_id
      - number
      - group_id

   *  - 
      - loc_override
      - number
      - loc_override