.. _cgnv6_server:

cgnv6 server
============

CGNV6 logging Server


server Specification
--------------------

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

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

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

	 **Collection Name**                   :ref:`562_server_list`

	 **Collection URI**                    /axapi/v3/cgnv6/server

	                                       

	 **Element Name**                      server

	 **Element URI**                       /axapi/v3/cgnv6/server/{name}

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/cgnv6/server/{name}/stats

	 **Operational Data URI**              /axapi/v3/cgnv6/server/{name}/oper

	 **Schema**                             :download:`server schema <cgnv6-server/cgnv6-server.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/server



.. raw:: html

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


:ref:`562_server_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_server_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/server



.. raw:: html

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


:ref:`562_server_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/server/{name}



.. raw:: html

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


:ref:`562_server_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_server_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/server



.. raw:: html

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


:ref:`562_server_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/server/{name}



.. raw:: html

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


:ref:`562_server_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/server/{name}



.. raw:: html

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


:ref:`562_server_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_server_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/server



.. raw:: html

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


:ref:`562_server_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/server/{name}



.. raw:: html

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


:ref:`562_server_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_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _562_server_list:

server-list
-----------


    server-list is **JSON List** of :ref:`562_server_attributes` 

        server-list : [

             { :ref:`562_server_attributes` },

             { :ref:`562_server_attributes` },

             ...

         ]

.. _562_server_attributes:

server attributes
-----------------

    **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:** :doc:`/axapi/v3/health/monitor <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:** :doc:`/axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} <cgnv6_server>`

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

.. _562_port-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:** :doc:`/axapi/v3/health/monitor <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

.. _562_port-list_sampling-enable:

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

.. _562_sampling-enable:

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