.. _cgnv6_scaleout:

cgnv6 scaleout
==============

CGN Scaleout configuration


scaleout Specification
----------------------

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

	===================================== =======================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      scaleout

	 **Element URI**                       /axapi/v3/cgnv6/scaleout

	 **Element Attributes**                scaleout_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/cgnv6/scaleout



.. raw:: html

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


scaleout_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _552_scaleout_attributes:

scaleout attributes
-------------------

    **address-mapping**

        **Description:** address-mapping is a **JSON Block**.  Please see below for :ref:`552_address-mapping` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/scaleout/address-mapping <cgnv6_scaleout_address_mapping>`

    **nat-ip-hashing-scheme**

        **Description:** nat-ip-hashing-scheme is a **JSON Block**.  Please see below for :ref:`552_nat-ip-hashing-scheme` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/scaleout/nat-ip-hashing-scheme <cgnv6_scaleout_nat_ip_hashing_scheme>`

.. _552_address-mapping:

address-mapping
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **inside-user-or-nat-ip**

        **Description:** inside-user-or-nat-ip is a **JSON Block**.  Please see below for :ref:`552_address-mapping_inside-user-or-nat-ip` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/scaleout/address-mapping/inside-user-or-nat-ip <cgnv6_scaleout_address_mapping_inside_user_or_nat_ip>`

    **nat-pool-or-fixed-nat**

        **Description:** nat-pool-or-fixed-nat is a **JSON Block**.  Please see below for :ref:`552_address-mapping_nat-pool-or-fixed-nat` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/scaleout/address-mapping/nat-pool-or-fixed-nat <cgnv6_scaleout_address_mapping_nat_pool_or_fixed_nat>`

.. _552_address-mapping_nat-pool-or-fixed-nat:

address-mapping_nat-pool-or-fixed-nat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _552_address-mapping_inside-user-or-nat-ip:

address-mapping_inside-user-or-nat-ip
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _552_nat-ip-hashing-scheme:

nat-ip-hashing-scheme
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **hashing-type**

        **Description** 'route-aggregation': Chunk contiguous NAT IPs for route aggregation(default); 'mod-user-groups': Hash NAT IPs by taking mod of user-groups; 

        **Type:** string

        **Supported Values:** route-aggregation, mod-user-groups

        **Default:** route-aggregation

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters