.. _visibility_monitored_entity_oper: visibility monitored-entity oper ================================ Operational Status for the object monitored-entity monitored-entity Specification ------------------------------ ===================================== ========================================================================= **Parameter** **Value** ===================================== ========================================================================= **Type** *Configuration Resource* **Element Name** monitored-entity **Element URI** /axapi/v3/visibility/monitored-entity/oper **Element Attributes** monitored-entity_attributes **Partition Visibility** None **Schema** :download:`monitored-entity schema <visibility-monitored-entity-oper/visibility-monitored-entity-oper.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/oper .. raw:: html </td><td valign = 'top'> :ref:`3595_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/oper .. raw:: html </td><td valign = 'top'> :ref:`3595_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/oper .. raw:: html </td><td valign = 'top'> :ref:`3595_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/oper .. raw:: html </td><td valign = 'top'> :ref:`3595_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/oper .. raw:: html </td><td valign = 'top'> :ref:`3595_monitored-entity_attributes` .. raw:: html </td><td></td></tr> .. raw:: html </table> .. _3595_monitored-entity_attributes: monitored-entity attributes --------------------------- **detail** **Description:** detail is a **JSON Block**. Please see below for :ref:`3595_detail` **Type:** Object **Reference 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:`3595_mon-topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions/mon-topk <visibility_monitored_entity_detail_sessions_mon_topk>` **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_oper` **Type:** Object **secondary** **Description:** secondary is a **JSON Block**. Please see below for :ref:`3595_secondary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions/mon-topk/secondary <visibility_monitored_entity_detail_sessions_mon_topk_secondary>` **sessions** **Description:** sessions is a **JSON Block**. Please see below for :ref:`3595_sessions` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions <visibility_monitored_entity_detail_sessions>` .. _3595_oper: oper ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **mon-entity-list** **Type:** List **primary-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 .. _3595_oper_mon-entity-list: oper_mon-entity-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **sec-entity-list** **Type:** List **uuid** **Description** **Type:** string .. _3595_oper_mon-entity-list_sec-entity-list: oper_mon-entity-list_sec-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **uuid** **Description** **Type:** string .. _3595_secondary: secondary ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mon-topk** **Description:** mon-topk is a **JSON Block**. Please see below for :ref:`3595_secondary_mon-topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions/mon-topk/secondary/mon-topk <visibility_monitored_entity_detail_sessions_mon_topk_secondary_mon_topk>` **oper** **Type:** Object .. _3595_secondary_mon-topk: secondary_mon-topk ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_secondary_mon-topk_oper` **Type:** Object **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`3595_secondary_mon-topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions/mon-topk/secondary/mon-topk/sources <visibility_monitored_entity_detail_sessions_mon_topk_secondary_mon_topk_sources>` .. _3595_secondary_mon-topk_oper: secondary_mon-topk_oper ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4-addr** **Description** **Type:** string **ipv6-addr** **Description** **Type:** string **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **metric-topk-list** **Type:** List .. _3595_secondary_mon-topk_oper_metric-topk-list: secondary_mon-topk_oper_metric-topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-name** **Description** **Type:** string **topk-list** **Type:** List .. _3595_secondary_mon-topk_oper_metric-topk-list_topk-list: secondary_mon-topk_oper_metric-topk-list_topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-addr** **Description** **Type:** string **metric-value** **Description** **Type:** string **port** **Description** **Type:** number **protocol** **Description** **Type:** string .. _3595_secondary_mon-topk_sources: secondary_mon-topk_sources ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_secondary_mon-topk_sources_oper` **Type:** Object .. _3595_secondary_mon-topk_sources_oper: secondary_mon-topk_sources_oper ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4-addr** **Description** **Type:** string **ipv6-addr** **Description** **Type:** string **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **metric-topk-list** **Type:** List .. _3595_secondary_mon-topk_sources_oper_metric-topk-list: secondary_mon-topk_sources_oper_metric-topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-name** **Description** **Type:** string **topk-list** **Type:** List .. _3595_secondary_mon-topk_sources_oper_metric-topk-list_topk-list: secondary_mon-topk_sources_oper_metric-topk-list_topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-addr** **Description** **Type:** string **metric-value** **Description** **Type:** string .. _3595_mon-topk: mon-topk ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_mon-topk_oper` **Type:** Object **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`3595_mon-topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/sessions/mon-topk/sources <visibility_monitored_entity_detail_sessions_mon_topk_sources>` .. _3595_mon-topk_oper: mon-topk_oper ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **metric-topk-list** **Type:** List .. _3595_mon-topk_oper_metric-topk-list: mon-topk_oper_metric-topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-name** **Description** **Type:** string **topk-list** **Type:** List .. _3595_mon-topk_oper_metric-topk-list_topk-list: mon-topk_oper_metric-topk-list_topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-addr** **Description** **Type:** string **metric-value** **Description** **Type:** string **port** **Description** **Type:** number **protocol** **Description** **Type:** string .. _3595_mon-topk_sources: mon-topk_sources ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_mon-topk_sources_oper` **Type:** Object .. _3595_mon-topk_sources_oper: mon-topk_sources_oper ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4-addr** **Description** **Type:** string **ipv6-addr** **Description** **Type:** string **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **metric-topk-list** **Type:** List .. _3595_mon-topk_sources_oper_metric-topk-list: mon-topk_sources_oper_metric-topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-name** **Description** **Type:** string **topk-list** **Type:** List .. _3595_mon-topk_sources_oper_metric-topk-list_topk-list: mon-topk_sources_oper_metric-topk-list_topk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-addr** **Description** **Type:** string **metric-value** **Description** **Type:** string .. _3595_detail: detail ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`3595_detail_debug` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/debug <visibility_monitored_entity_detail_debug>` **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_detail_oper` **Type:** Object .. _3595_detail_oper: detail_oper ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **mon-entity-list** **Type:** List **primary-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 .. _3595_detail_oper_mon-entity-list: detail_oper_mon-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **entity-metric-list** **Type:** List **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **sec-entity-list** **Type:** List **uuid** **Description** **Type:** string .. _3595_detail_oper_mon-entity-list_entity-metric-list: detail_oper_mon-entity-list_entity-metric-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **anomaly** **Description** **Type:** string **current** **Description** **Type:** string **metric-name** **Description** **Type:** string **threshold** **Description** **Type:** string .. _3595_detail_oper_mon-entity-list_sec-entity-list: detail_oper_mon-entity-list_sec-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **entity-metric-list** **Type:** List **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **uuid** **Description** **Type:** string .. _3595_detail_oper_mon-entity-list_sec-entity-list_entity-metric-list: detail_oper_mon-entity-list_sec-entity-list_entity-metric-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **anomaly** **Description** **Type:** string **current** **Description** **Type:** string **metric-name** **Description** **Type:** string **threshold** **Description** **Type:** string .. _3595_detail_debug: detail_debug ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_detail_debug_oper` **Type:** Object .. _3595_detail_debug_oper: detail_debug_oper ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **mon-entity-list** **Type:** List **primary-keys** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 .. _3595_detail_debug_oper_mon-entity-list: detail_debug_oper_mon-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **entity-metric-list** **Type:** List **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **sec-entity-list** **Type:** List **uuid** **Description** **Type:** string .. _3595_detail_debug_oper_mon-entity-list_entity-metric-list: detail_debug_oper_mon-entity-list_entity-metric-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **anomaly** **Description** **Type:** string **current** **Description** **Type:** string **max** **Description** **Type:** string **mean** **Description** **Type:** string **metric-name** **Description** **Type:** string **min** **Description** **Type:** string **std-dev** **Description** **Type:** string **threshold** **Description** **Type:** string .. _3595_detail_debug_oper_mon-entity-list_sec-entity-list: detail_debug_oper_mon-entity-list_sec-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **entity-metric-list** **Type:** List **flat-oid** **Description** **Type:** number **ha-state** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **mode** **Description** **Type:** string **uuid** **Description** **Type:** string .. _3595_detail_debug_oper_mon-entity-list_sec-entity-list_entity-metric-list: detail_debug_oper_mon-entity-list_sec-entity-list_entity-metric-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **anomaly** **Description** **Type:** string **current** **Description** **Type:** string **max** **Description** **Type:** string **mean** **Description** **Type:** string **metric-name** **Description** **Type:** string **min** **Description** **Type:** string **std-dev** **Description** **Type:** string **threshold** **Description** **Type:** string .. _3595_sessions: sessions ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **oper** **Description:** oper is a **JSON Block**. Please see below for :ref:`3595_sessions_oper` **Type:** Object .. _3595_sessions_oper: sessions_oper ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mon-entity-list** **Type:** List .. _3595_sessions_oper_mon-entity-list: sessions_oper_mon-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **sec-entity-list** **Type:** List **session-list** **Type:** List .. _3595_sessions_oper_mon-entity-list_session-list: sessions_oper_mon-entity-list_session-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fwd-dst-ip** **Description** **Type:** string **fwd-dst-port** **Description** **Type:** number **fwd-src-ip** **Description** **Type:** string **fwd-src-port** **Description** **Type:** number **proto** **Description** **Type:** string **rev-dst-ip** **Description** **Type:** string **rev-dst-port** **Description** **Type:** number **rev-src-ip** **Description** **Type:** string **rev-src-port** **Description** **Type:** number .. _3595_sessions_oper_mon-entity-list_sec-entity-list: sessions_oper_mon-entity-list_sec-entity-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **entity-key** **Description** **Type:** string **ipv4-addr** **Description** **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** **Type:** string **Format:** ipv6-address **l4-port** **Description** **Type:** number **l4-proto** **Description** **Type:** string **session-list** **Type:** List .. _3595_sessions_oper_mon-entity-list_sec-entity-list_session-list: sessions_oper_mon-entity-list_sec-entity-list_session-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fwd-dst-ip** **Description** **Type:** string **fwd-dst-port** **Description** **Type:** number **fwd-src-ip** **Description** **Type:** string **fwd-src-port** **Description** **Type:** number **proto** **Description** **Type:** string **rev-dst-ip** **Description** **Type:** string **rev-dst-port** **Description** **Type:** number **rev-src-ip** **Description** **Type:** string **rev-src-port** **Description** **Type:** number