.. _cgnv6_nat:

cgnv6 nat
=========

Configure CGNv6 NAT


nat Specification
-----------------

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

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

	 **Element Name**                      nat

	 **Element URI**                       /axapi/v3/cgnv6/nat

	 **Element Attributes**                nat_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


nat_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _481_nat_attributes:

nat attributes
--------------

    **exclude-port**

        **Description:** exclude-port is a **JSON Block**.  Please see below for :ref:`481_exclude-port` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port <cgnv6_nat_exclude_port>`

    **histogram**

        **Description:** histogram is a **JSON Block**.  Please see below for :ref:`481_histogram` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/histogram <cgnv6_nat_histogram>`

    **icmp**

        **Description:** icmp is a **JSON Block**.  Please see below for :ref:`481_icmp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/icmp <cgnv6_nat_icmp>`

    **icmpv6**

        **Description:** icmpv6 is a **JSON Block**.  Please see below for :ref:`481_icmpv6` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/icmpv6 <cgnv6_nat_icmpv6>`

    **inside**

        **Description:** inside is a **JSON Block**.  Please see below for :ref:`481_inside` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/inside <cgnv6_nat_inside>`

    **pool-group-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/pool-group/{pool-group-name} <cgnv6_nat_pool_group>`

    **pool-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/pool/{pool-name} <cgnv6_nat_pool>`

    **range-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/range-list/{name}+{partition} <cgnv6_nat_range_list>`

    **shared-pool**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool <cgnv6_nat_shared_pool>`

    **shared-pool-group**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool-group <cgnv6_nat_shared_pool_group>`

.. _481_shared-pool:

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

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_shared-pool-group:

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

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

    **members**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool-group/members <cgnv6_nat_shared_pool_group_members>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_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

.. _481_pool-group-list:

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

	 **Block object keys**             

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

    **member-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/pool-group/{pool-group-name}/member/{pool-name} <cgnv6_nat_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

.. _481_pool-group-list_member-list:

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

	 **Block object keys**             

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

    **pool-name**

        **Description** Specify CGNv6 NAT 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

.. _481_histogram:

histogram
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bin-count**

        **Description** Number of bins in the histogram (default: 50)

        **Type:** number

        **Range:** 10-100

        **Default:** 50

    **bin-skew**

        **Description** Percentage of bins that represent the upper bound (default: 75)

        **Type:** number

        **Range:** 50-80

        **Default:** 75

    **data-skew**

        **Description** Percentage of data that represents the upper bound (default: 25)

        **Type:** number

        **Range:** 5-50

        **Default:** 25

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_icmpv6:

icmpv6
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **respond-to-ping**

        **Description** Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled)

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_range-list-list:

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

	 **Block object keys**             

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

    **global-netmaskv4**

        **Description** Mask for this Address range

        **Type:** string

        **Format:** ipv4-netmask

    **global-start-ipv4-addr**

        **Description** Global Start IPv4 Address of this list

        **Type:** string

        **Format:** ipv4-address

    **local-netmaskv4**

        **Description** Mask for this Address range

        **Type:** string

        **Format:** ipv4-netmask

    **local-start-ipv4-addr**

        **Description** Local Start IPv4 Address of this list

        **Type:** string

        **Format:** ipv4-address

    **name**

        **Description** Name for this Static List

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **partition**

        **Description** Inside User Partition (Partition Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v4-count**

        **Description** Number of addresses to be translated in this range

        **Type:** number

        **Range:** 1-200000

    **v4-vrid**

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

        **Type:** number

        **Range:** 1-31

.. _481_exclude-port:

exclude-port
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tcp**

        **Description:** tcp is a **JSON Block**.  Please see below for :ref:`481_exclude-port_tcp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port/tcp <cgnv6_nat_exclude_port_tcp>`

    **udp**

        **Description:** udp is a **JSON Block**.  Please see below for :ref:`481_exclude-port_udp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port/udp <cgnv6_nat_exclude_port_udp>`

.. _481_exclude-port_udp:

exclude-port_udp
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_exclude-port_udp_port-list:

exclude-port_udp_port-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port**

        **Description** Single Port or Port Range Start

        **Type:** number

    **port-end**

        **Description** Port Range End

        **Type:** number

.. _481_exclude-port_tcp:

exclude-port_tcp
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_exclude-port_tcp_port-list:

exclude-port_tcp_port-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port**

        **Description** Single Port or Port Range Start

        **Type:** number

    **port-end**

        **Description** Port Range End

        **Type:** number

.. _481_icmp:

icmp
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **always-source-nat-errors**

        **Description** Source NAT intermediate routers' IPs for ICMP errors (default: disabled)

        **Type:** boolean

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

        **Default:** 0

    **respond-to-ping**

        **Description** Respond to ICMP echo requests to NAT pool IPs (default: disabled)

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_inside:

inside
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **source**

        **Description:** source is a **JSON Block**.  Please see below for :ref:`481_inside_source` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source <cgnv6_nat_inside_source>`

.. _481_inside_source:

inside_source
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **static-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source/static/{src-address}+{partition} <cgnv6_nat_inside_source_static>`

    **statistics**

        **Description:** statistics is a **JSON Block**.  Please see below for :ref:`481_inside_source_statistics` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source/statistics <cgnv6_nat_inside_source_statistics>`

.. _481_inside_source_statistics:

inside_source_statistics
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _481_inside_source_static-list:

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

	 **Block object keys**             

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

    **nat-address**

        **Description** NAT Address

        **Type:** string

        **Format:** ipv4-address

    **partition**

        **Description** Inside User Partition (Partition Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **src-address**

        **Description** Original Source Address

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

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

        **Type:** number

        **Range:** 1-31

.. _481_pool-list:

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

	 **Block object keys**             

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

    **all**

        **Description** Share with all partitions

        **Type:** boolean

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

        **Default:** 0

    **end-address**

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

        **Type:** string

        **Format:** ipv4-address

    **exclude-ip**

        **Type:** List

    **group**

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

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **max-users-per-ip**

        **Description** Number of users that can be assigned to a NAT IP

        **Type:** number

        **Range:** 1-64512

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

    **per-batch-port-usage-warning-threshold**

        **Description** Configure warning log threshold for per batch port usage (default: disabled) (Number of ports)

        **Type:** number

        **Range:** 32-4096

    **pool-name**

        **Description** Specify pool name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port-batch-v2-size**

        **Description** '64': Allocate 64 ports at a time; '128': Allocate 128 ports at a time; '256': Allocate 256 ports at a time; '512': Allocate 512 ports at a time; '1024': Allocate 1024 ports at a time; '2048': Allocate 2048 ports at a time; '4096': Allocate 4096 ports at a time; 

        **Type:** string

        **Supported Values:** 64, 128, 256, 512, 1024, 2048, 4096

    **shared**

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

        **Type:** boolean

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

        **Default:** 0

    **simultaneous-batch-allocation**

        **Description** Allocate same TCP and UDP batches at once

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

    **tcp-time-wait-interval**

        **Description** Minutes before TCP NAT ports can be reused

        **Type:** number

        **Range:** 0-10

    **usable-nat-ports**

        **Description** Configure usable NAT ports

        **Type:** boolean

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

        **Default:** 0

    **usable-nat-ports-end**

        **Description** End Port of Usable NAT Ports

        **Type:** number

        **Range:** 1024-65535

    **usable-nat-ports-start**

        **Description** Start Port of Usable NAT Ports (needs to be even)

        **Type:** number

        **Range:** 1024-65535

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

.. _481_pool-list_exclude-ip:

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

	 **Block object keys**             

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

    **exclude-ip-end**

        **Description** Address range end

        **Type:** string

        **Format:** ipv4-address

    **exclude-ip-start**

        **Description** Single IP address or IP address range start

        **Type:** string

        **Format:** ipv4-address