.. _cgnv6_one_to_one:

cgnv6 one-to-one
================

Set one-to-one NAT parameters


one-to-one Specification
------------------------

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

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

	 **Element Name**                      one-to-one

	 **Element URI**                       /axapi/v3/cgnv6/one-to-one

	 **Element Attributes**                one-to-one_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


one-to-one_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _535_one-to-one_attributes:

one-to-one attributes
---------------------

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`535_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/global <cgnv6_one_to_one_global>`

    **mapping**

        **Description:** mapping is a **JSON Block**.  Please see below for :ref:`535_mapping` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/mapping <cgnv6_one_to_one_mapping>`

    **pool-group-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name} <cgnv6_one_to_one_pool_group>`

    **pool-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool/{pool-name} <cgnv6_one_to_one_pool>`

    **shared-pool**

        **Description:** shared-pool is a **JSON Block**.  Please see below for :ref:`535_shared-pool` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool <cgnv6_one_to_one_shared_pool>`

    **shared-pool-group**

        **Description:** shared-pool-group is a **JSON Block**.  Please see below for :ref:`535_shared-pool-group` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool-group <cgnv6_one_to_one_shared_pool_group>`

.. _535_shared-pool:

shared-pool
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_pool-group-list:

pool-group-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **member-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}/member/{pool-name} <cgnv6_one_to_one_pool_group>`

    **pool-group-name**

        **Description** Specify pool group name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **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** Specify VRRP-A vrid

        **Type:** number

        **Range:** 1-31

.. _535_pool-group-list_member-list:

pool-group-list_member-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pool-name**

        **Description** Specify CGNv6 one-to-one pool name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mapping-timeout**

        **Description** Configure timeout for the one-to-one NAT mapping (Timeout in minutes (default: 10 minutes))

        **Type:** number

        **Range:** 0-180

        **Default:** 10

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_global_sampling-enable:

global_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-map-allocated': Total One-to-One Address Mapping Allocated; 'total-map-freed': Total One-to-One Address Mapping Freed; 'map-alloc-failure': One-to-One Address Mapping Allocation Failure; 'map-dbl-free': Address Mapping Double Free; 'alloc-map-race': Mapping Exists When Allocating Address Mapping; 'map-not-found': Mapping to be Released Not Found; 'ha-map-mismatch': HA Standby Mapping Mismatch; 'ha-select-addr-failure': HA Standby Allocate Address Failure; 'ha-alloc-map-conflicts': HA Standby Allocate Mapping Conflicts; 

        **Type:** string

        **Supported Values:** all, total-map-allocated, total-map-freed, map-alloc-failure, map-dbl-free, alloc-map-race, map-not-found, ha-map-mismatch, ha-select-addr-failure, ha-alloc-map-conflicts

.. _535_mapping:

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

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_shared-pool-group:

shared-pool-group
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **members**

        **Description:** members is a **JSON Block**.  Please see below for :ref:`535_shared-pool-group_members` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool-group/members <cgnv6_one_to_one_shared_pool_group_members>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_shared-pool-group_members:

shared-pool-group_members
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _535_pool-list:

pool-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **end-address**

        **Description** Configure end IP address of NAT pool

        **Type:** string

        **Format:** ipv4-address

    **group**

        **Description** Share with a partition group (Partition Group Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **netmask**

        **Description** Configure mask for pool

        **Type:** string

        **Format:** ipv4-netmask-brief

    **partition**

        **Description** Share with a single partition (Partition Name)

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **pool-name**

        **Description** Specify pool name or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **shared**

        **Description** Share this pool with other partitions (default: not shared)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **start-address**

        **Description** Configure start IP address of NAT pool

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

        **Description** Configure VRRP-A vrid (Specify ha VRRP-A vrid)

        **Type:** number

        **Range:** 1-31