.. _visibility_monitored_entity:

visibility monitored-entity
===========================

Display Monitoring entities


monitored-entity Specification
------------------------------

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

	 **Element Name**                      monitored-entity

	 **Element URI**                       /axapi/v3/visibility/monitored-entity

	 **Element Attributes**                monitored-entity_attributes

	 **Operational Data URI**              /axapi/v3/visibility/monitored-entity/oper

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



.. raw:: html

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


:ref:`1747_monitored-entity_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/visibility/monitored-entity



.. raw:: html

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


:ref:`1747_monitored-entity_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/monitored-entity



.. raw:: html

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


:ref:`1747_monitored-entity_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/monitored-entity



.. raw:: html

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


:ref:`1747_monitored-entity_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/monitored-entity



.. raw:: html

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


:ref:`1747_monitored-entity_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1747_monitored-entity_attributes:

monitored-entity attributes
---------------------------

    **detail**

        **Description:** detail is a **JSON Block**.  Please see below for :ref:`1747_detail` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail <visibility_monitored_entity_detail>`

    **mon-topk**

        **Description:** mon-topk is a **JSON Block**.  Please see below for :ref:`1747_mon-topk` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/mon-topk <visibility_monitored_entity_mon_topk>`

    **secondary**

        **Description:** secondary is a **JSON Block**.  Please see below for :ref:`1747_secondary` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary <visibility_monitored_entity_secondary>`

    **sessions**

        **Description:** sessions is a **JSON Block**.  Please see below for :ref:`1747_sessions` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/sessions <visibility_monitored_entity_sessions>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_mon-topk:

mon-topk
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sources**

        **Description:** sources is a **JSON Block**.  Please see below for :ref:`1747_mon-topk_sources` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/mon-topk/sources <visibility_monitored_entity_mon_topk_sources>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_mon-topk_sources:

mon-topk_sources
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_secondary:

secondary
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mon-topk**

        **Description:** mon-topk is a **JSON Block**.  Please see below for :ref:`1747_secondary_mon-topk` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary/mon-topk <visibility_monitored_entity_secondary_mon_topk>`

.. _1747_secondary_mon-topk:

secondary_mon-topk
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sources**

        **Description:** sources is a **JSON Block**.  Please see below for :ref:`1747_secondary_mon-topk_sources` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary/mon-topk/sources <visibility_monitored_entity_secondary_mon_topk_sources>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_secondary_mon-topk_sources:

secondary_mon-topk_sources
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_sessions:

sessions
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_detail:

detail
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **debug**

        **Description:** debug is a **JSON Block**.  Please see below for :ref:`1747_detail_debug` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/debug <visibility_monitored_entity_detail_debug>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_detail_debug:

detail_debug
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1747_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - all-keys
      - flag
      - all-keys

   *  - 
      - mon-entity-list
      - 
      - mon-entity-list

   *  - 
      - primary-keys
      - flag
      - primary-keys