.. _cgnv6_map_encapsulation_domain_basic_mapping_rule_prefix_rule:

cgnv6 map encapsulation domain basic-mapping-rule prefix-rule
=============================================================

IPv6 and IPv4 prefix rules


prefix-rule Specification
-------------------------

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

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

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

	 **Collection Name**                   :ref:`437_prefix-rule_list`

	 **Collection URI**                    /axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule

	                                       

	 **Element Name**                      prefix-rule

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

	 **Element Attributes**                prefix-rule_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`437_prefix-rule_attributes`



.. raw:: html

   </td><td></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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule



.. raw:: html

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


:ref:`437_prefix-rule_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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}



.. raw:: html

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


:ref:`437_prefix-rule_attributes`



.. raw:: html

   </td><td></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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule



.. raw:: html

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


:ref:`437_prefix-rule_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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}



.. raw:: html

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


:ref:`437_prefix-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/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}



.. raw:: html

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


:ref:`437_prefix-rule_attributes`



.. raw:: html

   </td><td></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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule



.. raw:: html

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


:ref:`437_prefix-rule_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/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name}



.. raw:: html

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


:ref:`437_prefix-rule_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _437_prefix-rule_list:

prefix-rule-list
----------------


    prefix-rule-list is **JSON List** of :ref:`437_prefix-rule_attributes` 

        prefix-rule-list : [

             { :ref:`437_prefix-rule_attributes` },

             { :ref:`437_prefix-rule_attributes` },

             ...

         ]

.. _437_prefix-rule_attributes:

prefix-rule attributes
----------------------

    **ea-length**

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

        **Type:** number

        **Range:** 0-23

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

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

    **port-start**

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

        **Type:** number

        **Range:** 0-32768

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

    **share-ratio**

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

        **Type:** number

        **Range:** 1-65536

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