.. _visibility_monitor_secondary_monitor:

visibility monitor secondary-monitor
====================================

Configure secondary monitoring key


secondary-monitor Specification
-------------------------------

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

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

	 **Element Name**                      secondary-monitor

	 **Element URI**                       /axapi/v3/visibility/monitor/secondary-monitor

	 **Element Attributes**                secondary-monitor_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`secondary-monitor schema <visibility-monitor-secondary-monitor/visibility-monitor-secondary-monitor.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/visibility/monitor/secondary-monitor



.. raw:: html

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


:ref:`3584_secondary-monitor_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/visibility_monitor_secondary_monitor_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/visibility/monitor/secondary-monitor



.. raw:: html

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


:ref:`3584_secondary-monitor_attributes`



.. 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/visibility/monitor/secondary-monitor



.. raw:: html

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


:ref:`3584_secondary-monitor_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/visibility/monitor/secondary-monitor



.. raw:: html

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


:ref:`3584_secondary-monitor_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/visibility/monitor/secondary-monitor



.. raw:: html

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


:ref:`3584_secondary-monitor_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3584_secondary-monitor_attributes:

secondary-monitor attributes
----------------------------

    **debug-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol} <visibility_monitor_secondary_monitor_debug>`

    **delete-debug-file**

        **Description:** delete-debug-file is a **JSON Block**.  Please see below for :ref:`3584_delete-debug-file` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file <visibility_monitor_secondary_monitor_delete_debug_file>`

    **mon-entity-topk**

        **Description** Enable topk for secondary entities

        **Type:** boolean

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

        **Default:** 0

    **replay-debug-file**

        **Description:** replay-debug-file is a **JSON Block**.  Please see below for :ref:`3584_replay-debug-file` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file <visibility_monitor_secondary_monitor_replay_debug_file>`

    **secondary-monitoring-key**

        **Description** 'service': Monitor traffic to any service; 

        **Type:** string

        **Supported Values:** service

    **source-entity-topk**

        **Description** Enable topk for sources to secondary-entities

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

.. _3584_debug-list:

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

	 **Block object keys**             

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

    **debug-ip-addr**

        **Description** Specify source/dest ip addr

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **debug-port**

        **Description** Specify port

        **Type:** number

        **Range:** 1-65535

    **debug-protocol**

        **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; 

        **Type:** string

        **Supported Values:** TCP, UDP, ICMP

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3584_delete-debug-file:

delete-debug-file
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **debug-ip-addr**

        **Description** Specify source/dest ip addr

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **debug-port**

        **Description** Specify port

        **Type:** number

        **Range:** 1-65535

    **debug-protocol**

        **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; 

        **Type:** string

        **Supported Values:** TCP, UDP, ICMP

.. _3584_replay-debug-file:

replay-debug-file
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **debug-ip-addr**

        **Description** Specify source/dest ip addr

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **debug-port**

        **Description** Specify port

        **Type:** number

        **Range:** 1-65535

    **debug-protocol**

        **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; 

        **Type:** string

        **Supported Values:** TCP, UDP, ICMP