.. _cgnv6_map_translation_domain_basic_mapping_rule:

cgnv6 map translation domain basic-mapping-rule
===============================================

Basic mapping rule (BMR)


basic-mapping-rule Specification
--------------------------------

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

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

	 **Element Name**                      basic-mapping-rule

	 **Element URI**                       /axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule

	 **Element Attributes**                basic-mapping-rule_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`basic-mapping-rule schema <cgnv6-map-translation-domain-basic-mapping-rule/cgnv6-map-translation-domain-basic-mapping-rule.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/map/translation/domain/{name}/basic-mapping-rule



.. raw:: html

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


:ref:`448_basic-mapping-rule_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_map_translation_domain_basic_mapping_rule_POST.txt
   :literal:




.. raw:: html

   </div></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/map/translation/domain/{name}/basic-mapping-rule



.. raw:: html

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


:ref:`448_basic-mapping-rule_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_map_translation_domain_basic_mapping_rule_GET.txt
   :literal:




.. raw:: html

   </div></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/map/translation/domain/{name}/basic-mapping-rule



.. raw:: html

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


:ref:`448_basic-mapping-rule_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/map/translation/domain/{name}/basic-mapping-rule



.. raw:: html

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


:ref:`448_basic-mapping-rule_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_map_translation_domain_basic_mapping_rule_PUT.txt
   :literal:




.. raw:: html

   </div></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/map/translation/domain/{name}/basic-mapping-rule



.. raw:: html

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


:ref:`448_basic-mapping-rule_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_map_translation_domain_basic_mapping_rule_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _448_basic-mapping-rule_attributes:

basic-mapping-rule attributes
-----------------------------

    **ea-length**

        **Description** Length of Embedded Address (EA) bits

        **Type:** number

        **Range:** 0-23

    **port-start**

        **Description** Starting Port, Must be Power of 2 value or zero

        **Type:** number

        **Range:** 0-32768

    **prefix-rule-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule/prefix-rule/{name} <cgnv6_map_translation_domain>`

    **rule-ipv4-address-port-settings**

        **Description** 'prefix-addr': Each CE is assigned an IPv4 prefix; 'single-addr': Each CE is assigned an IPv4 address; 'shared-addr': Each CE is assigned a shared IPv4 address; 

        **Type:** string

        **Supported Values:** prefix-addr, single-addr, shared-addr

    **share-ratio**

        **Description** Port sharing ratio for each NAT IP. Must be Power of 2 value

        **Type:** number

        **Range:** 1-65536

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _448_prefix-rule-list:

prefix-rule-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-netmask**

        **Description** Subnet mask (subnet bigger than /8 is not allowed)

        **Type:** string

        **Format:** ipv4-netmask-brief

    **name**

        **Description** MAP BMR prefix rule name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **rule-ipv4-prefix**

        **Description** IPv4 prefix of BMR

        **Type:** string

        **Format:** ipv4-address

    **rule-ipv6-prefix**

        **Description** IPv6 prefix of BMR

        **Type:** string

        **Format:** ipv6-address-plen

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