.. _cgnv6_global:

cgnv6 global
============

CGN global paramters


global Specification
--------------------

	===================================== =====================================================
	===================================== =====================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/cgnv6/global

	 **Element Attributes**                global_attributes

	 **Statistics Data URI**               /axapi/v3/cgnv6/global/stats

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



.. raw:: html

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


:ref:`252_global_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/global



.. raw:: html

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


:ref:`252_global_attributes`



.. 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/global



.. raw:: html

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


:ref:`252_global_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/global



.. raw:: html

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


:ref:`252_global_attributes`



.. 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/global



.. raw:: html

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


:ref:`252_global_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _252_global_attributes:

global attributes
-----------------

    **ping-sweep-detection**

        **Description** 'enable': Enable ping sweep detection; 'disable': Disable ping sweep detection(default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **port-scan-detection**

        **Description** 'enable': Enable port scan detection; 'disable': Disable port scan detection(default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _252_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'tcp-total-ports-allocated': Total TCP ports allocated; 'udp-total-ports-allocated': Total UDP ports allocated; 'icmp-total-ports-allocated': Total ICMP ports allocated; 

        **Type:** string

        **Supported Values:** all, tcp-total-ports-allocated, udp-total-ports-allocated, icmp-total-ports-allocated

.. _252_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - udp-total-ports-allocated
      - 8
      - Total UDP ports allocated

   *  - 
      - icmp-total-ports-allocated
      - 8
      - Total ICMP ports allocated

   *  - 
      - tcp-total-ports-allocated
      - 8
      - Total TCP ports allocated