.. _cgnv6_map_encapsulation_domain:

cgnv6 map encapsulation domain
==============================

MAP Encapsulation domain


domain Specification
--------------------

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

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

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

	 **Collection Name**                   :ref:`441_domain_list`

	 **Collection URI**                    /axapi/v3/cgnv6/map/encapsulation/domain

	                                       

	 **Element Name**                      domain

	 **Element URI**                       /axapi/v3/cgnv6/map/encapsulation/domain/{name}

	 **Element Attributes**                domain_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/cgnv6/map/encapsulation/domain/{name}/stats

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



.. raw:: html

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


:ref:`441_domain_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_encapsulation_domain_POST.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`441_domain_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}



.. raw:: html

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


:ref:`441_domain_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_encapsulation_domain_GET.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`441_domain_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}



.. raw:: html

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


:ref:`441_domain_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}



.. raw:: html

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


:ref:`441_domain_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_encapsulation_domain_PUT.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`441_domain_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}



.. raw:: html

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


:ref:`441_domain_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_encapsulation_domain_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _441_domain_list:

domain-list
-----------


    domain-list is **JSON List** of :ref:`441_domain_attributes` 

        domain-list : [

             { :ref:`441_domain_attributes` },

             { :ref:`441_domain_attributes` },

             ...

         ]

.. _441_domain_attributes:

domain attributes
-----------------

    **basic-mapping-rule**

        **Description:** basic-mapping-rule is a **JSON Block**.  Please see below for :ref:`441_basic-mapping-rule` 

        **Type:** Object

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

    **description**

        **Description** MAP-E domain description

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **format**

        **Description** 'draft-03': Construct IPv6 Interface Identifier according to draft-03; 

        **Type:** string

        **Supported Values:** draft-03

    **health-check-gateway**

        **Description:** health-check-gateway is a **JSON Block**.  Please see below for :ref:`441_health-check-gateway` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/domain/{name}/health-check-gateway <cgnv6_map_encapsulation_domain>`

    **name**

        **Description** MAP-E domain name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/cgnv6-encap-domain-tmpl <visibility_packet_capture_object_templates_cgnv6_encap_domain_tmpl>`

    **sampling-enable**

        **Type:** List

    **tunnel-endpoint-address**

        **Description** Tunnel Endpoint Address for MAP-E domain

        **Type:** string

        **Format:** ipv6-address

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

.. _441_basic-mapping-rule:

basic-mapping-rule
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

.. _441_basic-mapping-rule_prefix-rule-list:

basic-mapping-rule_prefix-rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

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

.. _441_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'inbound_packet_received': Inbound IPv4 Packets Received; 'inbound_frag_packet_received': Inbound IPv4 Fragment Packets Received; 'inbound_addr_port_validation_failed': Inbound IPv4 Destination Address Port Validation Failed; 'inbound_rev_lookup_failed': Inbound IPv4 Reverse Route Lookup Failed; 'inbound_dest_unreachable': Inbound IPv6 Destination Address Unreachable; 'outbound_packet_received': Outbound IPv6 Packets Received; 'outbound_frag_packet_received': Outbound IPv6 Fragment Packets Received; 'outbound_addr_validation_failed': Outbound IPv6 Source Address Validation Failed; 'outbound_rev_lookup_failed': Outbound IPv6 Reverse Route Lookup Failed; 'outbound_dest_unreachable': Outbound IPv4 Destination Address Unreachable; 'packet_mtu_exceeded': Packet Exceeded MTU; 'frag_icmp_sent': ICMP Packet Too Big Sent; 'interface_not_configured': Interfaces not Configured Dropped; 'bmr_prefixrules_configured': BMR prefix rules configured; 'helper_count': Helper Count; 'active_dhcpv6_leases': Active DHCPv6 leases; 

        **Type:** string

        **Supported Values:** all, inbound_packet_received, inbound_frag_packet_received, inbound_addr_port_validation_failed, inbound_rev_lookup_failed, inbound_dest_unreachable, outbound_packet_received, outbound_frag_packet_received, outbound_addr_validation_failed, outbound_rev_lookup_failed, outbound_dest_unreachable, packet_mtu_exceeded, frag_icmp_sent, interface_not_configured, bmr_prefixrules_configured, helper_count, active_dhcpv6_leases

.. _441_health-check-gateway:

health-check-gateway
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address-list**

        **Type:** List

    **ipv6-address-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **withdraw-route**

        **Description** 'all-link-failure': Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; 'any-link-failure': Withdraw routes on health-check failure of any gateway (default); 

        **Type:** string

        **Supported Values:** all-link-failure, any-link-failure

        **Default:** any-link-failure

.. _441_health-check-gateway_ipv6-address-list:

health-check-gateway_ipv6-address-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-gateway**

        **Description** IPv6 Gateway

        **Type:** string

        **Format:** ipv6-address

.. _441_health-check-gateway_address-list:

health-check-gateway_address-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-gateway**

        **Description** IPv4 Gateway

        **Type:** string

        **Format:** ipv4-address