.. _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:`3586_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_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



.. raw:: html

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


:ref:`3586_monitor_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/visibility_monitor_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/visibility/monitor



.. raw:: html

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


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



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/visibility_monitor_PUT.txt
   :literal:




.. raw:: html

   </div></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:`3586_monitor_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/visibility_monitor_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3586_monitor_attributes:

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

    **agent-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/visibility/monitor/agent/{agent-name} <visibility_monitor_agent>`

    **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:`3586_delete-debug-file` 

        **Type:** Object

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

    **index-sessions**

        **Description** Start indexing associated sessions

        **Type:** boolean

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

        **Default:** 0

    **index-sessions-type**

        **Description** 'per-cpu': Use per cpu list; 

        **Type:** string

        **Supported Values:** per-cpu

    **mon-entity-topk**

        **Description** Enable topk for primary entities

        **Type:** boolean

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

        **Default:** 0

    **monitor-key**

        **Description** 'source': Monitor traffic from all sources; 'dest': Monitor traffic to any destination; 'service': Monitor traffic to any service; 'source-nat-ip': Monitor traffic to all source nat IPs; 

        **Type:** string

        **Supported Values:** source, dest, service, source-nat-ip

    **netflow**

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

        **Type:** Object

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

    **primary-monitor**

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

        **Type:** string

        **Supported Values:** traffic, xflow

    **replay-debug-file**

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

        **Type:** Object

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

    **secondary-monitor**

        **Description:** secondary-monitor is a **JSON Block**.  Please see below for :ref:`3586_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:`3586_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:`3586_template` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

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

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

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

.. _3586_template:

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

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

    **notification**

        **Type:** List

.. _3586_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>`

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

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

.. _3586_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:`3586_secondary-monitor_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:`3586_secondary-monitor_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

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

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

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

.. _3586_agent-list:

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

	 **Block object keys**             

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

    **agent-name**

        **Description** Specify name for the agent

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **agent-v4-addr**

        **Description** Configure agent's IPv4 address

        **Type:** string

        **Format:** ipv4-address

    **agent-v6-addr**

        **Description** Configure agent's IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **sampling-enable**

        **Type:** List

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3586_agent-list_sampling-enable:

agent-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'sflow-packets-received': sFlow Packets Received; 'sflow-samples-received': sFlow Samples Received; 'sflow-samples-bad-len': sFlow Samples Bad Length; 'sflow-samples-non-std': sFlow Samples Non-standard; 'sflow-samples-skipped': sFlow Samples Skipped; 'sflow-sample-record-bad-len': sFlow Sample Records Bad Length; 'sflow-samples-sent-for-detection': sFlow Samples Processed For Detection; 'sflow-sample-record-invalid-layer2': sFlow Sample Records Unknown Layer-2; 'sflow-sample-ipv6-hdr-parse-fail': sFlow Sample IPv6 Record Header Parse Failures; 'sflow-disabled': sFlow Packet Samples Processing Disabled; 'netflow-disabled': Netflow Flow Samples Processing Disabled; 'netflow-v5-packets-received': Netflow v5 Packets Received; 'netflow-v5-samples-received': Netflow v5 Samples Received; 'netflow-v5-samples-sent-for-detection': Netflow v5 Samples Processed For Detection; 'netflow-v5-sample-records-bad-len': Netflow v5 Sample Records Bad Length; 'netflow-v5-max-records-exceed': Netflow v5 Sample Max Records Error; 'netflow-v9-packets-received': Netflow v9 Packets Received; 'netflow-v9-samples-received': Netflow v9 Samples Received; 'netflow-v9-samples-sent-for-detection': Netflow v9 Samples Processed For Detection; 'netflow-v9-sample-records-bad-len': Netflow v9 Sample Records Bad Length; 'netflow-v9-max-records-exceed': Netflow v9 Sample Max Records Error; 'netflow-v10-packets-received': Netflow v10 Packets Received; 'netflow-v10-samples-received': Netflow v10 Samples Received; 'netflow-v10-samples-sent-for-detection': Netflow v10 Samples Procssed For Detection; 'netflow-v10-sample-records-bad-len': Netflow v10 Sample Records Bad Length; 'netflow-v10-max-records-exceed': Netflow v10 Sample Max records Error; 'netflow-tcp-sample-received': Netflow TCP Samples Received; 'netflow-udp-sample-received': Netflow UDP Samples received; 'netflow-icmp-sample-received': Netflow ICMP Samples Received; 'netflow-other-sample-received': Netflow OTHER Samples Received; 'netflow-record-copy-oom-error': Netflow Data Record Copy Fail OOM; 'netflow-record-rse-invalid': Netflow Data Record Reduced Size Invalid; 'netflow-sample-flow-dur-error': Netflow Sample Flow Duration Error; 

        **Type:** string

        **Supported Values:** all, sflow-packets-received, sflow-samples-received, sflow-samples-bad-len, sflow-samples-non-std, sflow-samples-skipped, sflow-sample-record-bad-len, sflow-samples-sent-for-detection, sflow-sample-record-invalid-layer2, sflow-sample-ipv6-hdr-parse-fail, sflow-disabled, netflow-disabled, netflow-v5-packets-received, netflow-v5-samples-received, netflow-v5-samples-sent-for-detection, netflow-v5-sample-records-bad-len, netflow-v5-max-records-exceed, netflow-v9-packets-received, netflow-v9-samples-received, netflow-v9-samples-sent-for-detection, netflow-v9-sample-records-bad-len, netflow-v9-max-records-exceed, netflow-v10-packets-received, netflow-v10-samples-received, netflow-v10-samples-sent-for-detection, netflow-v10-sample-records-bad-len, netflow-v10-max-records-exceed, netflow-tcp-sample-received, netflow-udp-sample-received, netflow-icmp-sample-received, netflow-other-sample-received, netflow-record-copy-oom-error, netflow-record-rse-invalid, netflow-sample-flow-dur-error