.. _health_source_nat:

health source-nat
=================

Define Source NAT for health monitor


source-nat Specification
------------------------

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

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

	 **Element Name**                      source-nat

	 **Element URI**                       /axapi/v3/health/source-nat

	 **Element Attributes**                source-nat_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/health/source-nat/stats

	 **Schema**                             :download:`source-nat schema <health-source-nat/health-source-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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/health/source-nat



.. raw:: html

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


:ref:`1967_source-nat_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/health_source_nat_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/health/source-nat



.. raw:: html

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


:ref:`1967_source-nat_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/health_source_nat_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/health/source-nat



.. raw:: html

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


:ref:`1967_source-nat_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/health/source-nat



.. raw:: html

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


:ref:`1967_source-nat_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/health_source_nat_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/health/source-nat



.. raw:: html

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


:ref:`1967_source-nat_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/health_source_nat_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1967_source-nat_attributes:

source-nat attributes
---------------------

    **enable-vrrp-a-mode**

        **Description** Forward health check by active device only

        **Type:** boolean

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

        **Default:** 0

    **ethernet**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

    **interface**

        **Description** 'ethernet': ethernet; 'trunk': trunk; 've': ve; 

        **Type:** string

        **Supported Values:** ethernet, trunk, ve

    **sampling-enable**

        **Type:** List

    **smart-nat-precedence**

        **Description** Use smart nat when resourece is presented in virtual port

        **Type:** boolean

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

        **Default:** 0

    **smart-nat-vrid**

        **Description** Smart nat VRID

        **Type:** number

        **Range:** 1-31

    **source-nat-pool**

        **Description** Use source nat for all health check (nat pool)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

    **source-nat-pool-v6**

        **Description** Use ipv6 source nat for all health check (nat pool)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool <ipv6_nat_pool>`

    **trunk**

        **Description** Trunk interface number

        **Type:** number

        **Range:** 1-4096

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve**

        **Description** Virtual ethernet interface number

        **Type:** number

        **Range:** 2-4094

.. _1967_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'act_recv_from_sby': Packets received from standby; 'act_send_to_sby': Packets sent to standby; 'sby_recv_from_act': Packets received from active; 'sby_send_to_act': Packets sent to active; 'sby_recv_from_act_err': Packets received from active error; 'recv_from_kernel': Packets received from kernel; 'send_to_kernel': Packets sent to kernel; 'send_to_kernel_err': Packets sent to kernel error; 'sby_no_peer': Peer not found on standby; 'dcmsg_err': DCMSG error; 'no_slb_object': SLB object not found; 'smart_nat_init_port_err': Smart NAT port initialization error; 'smart_nat_init_inst_err': Smart NAT instance initialization error; 'smart_nat_rserver_route_err': Smart NAT rserver route update error; 'smart_nat_rserver_ip_err': Smart NAT rserver ip update error; 'nat_resource_err': NAT resource error; 

        **Type:** string

        **Supported Values:** all, act_recv_from_sby, act_send_to_sby, sby_recv_from_act, sby_send_to_act, sby_recv_from_act_err, recv_from_kernel, send_to_kernel, send_to_kernel_err, sby_no_peer, dcmsg_err, no_slb_object, smart_nat_init_port_err, smart_nat_init_inst_err, smart_nat_rserver_route_err, smart_nat_rserver_ip_err, nat_resource_err, frag_err