.. _network_twamp_responder:

network twamp responder
=======================

Configure TWAMP responder


responder Specification
-----------------------

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

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

	 **Element Name**                      responder

	 **Element URI**                       /axapi/v3/network/twamp/responder

	 **Element Attributes**                responder_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`responder schema <network-twamp-responder/network-twamp-responder.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/network/twamp/responder



.. raw:: html

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


:ref:`2354_responder_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/network_twamp_responder_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/network/twamp/responder



.. raw:: html

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


:ref:`2354_responder_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/network_twamp_responder_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/network/twamp/responder



.. raw:: html

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


:ref:`2354_responder_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/network/twamp/responder



.. raw:: html

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


:ref:`2354_responder_attributes`



.. 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/network/twamp/responder



.. raw:: html

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


:ref:`2354_responder_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2354_responder_attributes:

responder attributes
--------------------

    **enable-both-ip-ipv6**

        **Description** Enable both IP and IPv6 TWAMP packets

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** enable-both-ip-ipv6, enable-ip, and enable-ipv6 are mutually exclusive

    **enable-ip**

        **Description** Enable IP TWAMP packets

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** enable-ip, enable-ipv6, and enable-both-ip-ipv6 are mutually exclusive

    **enable-ipv6**

        **Description** Enable IPv6 TWAMP packets

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** enable-ipv6, enable-ip, and enable-both-ip-ipv6 are mutually exclusive

    **ip**

        **Description:** ip is a **JSON Block**.  Please see below for :ref:`2354_ip` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/twamp/responder/ip <network_twamp_responder_ip>`

    **ipv6**

        **Description:** ipv6 is a **JSON Block**.  Please see below for :ref:`2354_ipv6` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/twamp/responder/ipv6 <network_twamp_responder_ipv6>`

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 1024-65535

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2354_ip:

ip
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acl-id**

        **Description** ACL id

        **Type:** number

        **Range:** 1-199

        **Mutual Exclusion:** acl-id and acl-name are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/access-list/standard <access_list_standard>`

    **acl-name**

        **Description** Apply a named access list (Access List name)

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** acl-name and acl-id are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ip/access-list <ip_access_list>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2354_ipv6:

ipv6
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v6-acl-name**

        **Description** Apply an access list (Named Access List)

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ipv6/access-list <ipv6_access_list>`