.. _visibility_monitor:

visibility monitor
==================

Configure monitoring keys


monitor Specification
---------------------

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

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

	 **Element Name**                      monitor

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

	 **Element Attributes**                monitor_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1653_monitor_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/monitor



.. raw:: html

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


:ref:`1653_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



.. raw:: html

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


:ref:`1653_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



.. raw:: html

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


:ref:`1653_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



.. raw:: html

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


:ref:`1653_monitor_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1653_monitor_attributes:

monitor attributes
------------------

    **debug-list**

        **Type:** List

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

    **delete-debug-file**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr} <visibility_monitor_delete_debug_file>`

    **mon-entity-topk**

        **Description** Enable topk for primary entities

        **Type:** boolean

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

        **Default:** 0

    **monitor-key**

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

        **Type:** string

        **Supported Values:** dest, service

    **netflow**

        **Description:** netflow is a **JSON Block**.  Please see below for :ref:`1653_netflow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/netflow <visibility_monitor_netflow>`

    **port-scan-filter-settings**

        **Description:** port-scan-filter-settings is a **JSON Block**.  Please see below for :ref:`1653_port-scan-filter-settings` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/port-scan-filter-settings <visibility_monitor_port_scan_filter_settings>`

    **primary-monitor**

        **Description** 'xflow': Monitor xflow samples; 

        **Type:** string

        **Supported Values:** xflow

    **replay-debug-file**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/replay-debug-file/{debug-ip-addr} <visibility_monitor_replay_debug_file>`

    **secondary-monitor**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor <visibility_monitor_secondary_monitor>`

    **sflow**

        **Description:** sflow is a **JSON Block**.  Please see below for :ref:`1653_sflow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/sflow <visibility_monitor_sflow>`

    **source-entity-topk**

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

        **Type:** boolean

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

        **Default:** 0

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1653_template` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v4-class-list**

        **Description** Class list of ipv4 addresses to be monitored

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`

    **v4-grouping**

        **Description** Enable aggregate the log and notification per class-list

        **Type:** boolean

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

        **Default:** 0

    **v6-class-list**

        **Description** Class list of ipv6 addresses to be monitored

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`

    **v6-grouping**

        **Description** Enable aggregate the log and notification per class-list

        **Type:** boolean

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

        **Default:** 0

.. _1653_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

.. _1653_sflow:

sflow
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **listening-port**

        **Description** sFlow port to receive packets (sFlow port number(default 6343))

        **Type:** number

        **Range:** 1-65535

        **Default:** 6343

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1653_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

.. _1653_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

.. _1653_port-scan-filter-settings:

port-scan-filter-settings
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **pkt-rate-threshold**

        **Description** packet rate threshold for the filter (default 10 pkts/sec, set to 0 pkts/sec to disable the feature)

        **Type:** number

        **Range:** 0-255

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1653_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **notification**

        **Type:** List

.. _1653_template_notification:

template_notification
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **notif-template-name**

        **Description** 

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/template-name <visibility_reporting_template_notification_template_name>`

.. _1653_netflow:

netflow
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **listening-port**

        **Description** Netflow port to receive packets (Netflow port number(default 9996))

        **Type:** number

        **Range:** 1-65535

        **Default:** 9996

    **template-active-timeout**

        **Description** Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))

        **Type:** number

        **Range:** 2-300

        **Default:** 30

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1653_secondary-monitor:

secondary-monitor
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **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:`1653_secondary-monitor_delete-debug-file` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file/{debug-ip-addr} <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:`1653_secondary-monitor_replay-debug-file` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file/{debug-ip-addr} <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

.. _1653_secondary-monitor_debug-list:

secondary-monitor_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

.. _1653_secondary-monitor_delete-debug-file:

secondary-monitor_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

.. _1653_secondary-monitor_replay-debug-file:

secondary-monitor_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