.. _controller_telemetry:

controller telemetry
====================

Controller telemetry config


telemetry Specification
-----------------------

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

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

	 **Element Name**                      telemetry

	 **Element URI**                       /axapi/v3/controller/telemetry

	 **Element Attributes**                telemetry_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`telemetry schema <controller-telemetry/controller-telemetry.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/controller/telemetry



.. raw:: html

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


:ref:`647_telemetry_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/controller/telemetry



.. raw:: html

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


:ref:`647_telemetry_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/controller/telemetry



.. raw:: html

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


:ref:`647_telemetry_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/controller/telemetry



.. raw:: html

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


:ref:`647_telemetry_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/controller/telemetry



.. raw:: html

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


:ref:`647_telemetry_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _647_telemetry_attributes:

telemetry attributes
--------------------

    **log-rate**

        **Description** Max number of session logs sent by the partition per second

        **Type:** number

        **Range:** 0-10000

        **Default:** 10

    **probe**

        **Description:** probe is a **JSON Block**.  Please see below for :ref:`647_probe` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/controller/telemetry/probe <controller_telemetry_probe>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _647_probe:

probe
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'enable': Enable the probe functionality; 'disable': Disable the probe functionality; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **export-policy**

        **Description** 'snapshots-all': Export historical/missed snapshots.; 'snapshots-new': Export only new snapshots(default).; 

        **Type:** string

        **Supported Values:** snapshots-all, snapshots-new

        **Default:** snapshots-new

    **interval**

        **Description** snapshot export interval in minute,default is 15.

        **Type:** number

        **Range:** 15-60

        **Default:** 15

    **log-level**

        **Description** 'ERROR': show errors only(default).; 'WARNING': show warnings; 'INFO': show info messages; 'DEBUG': show debug logs; 

        **Type:** string

        **Supported Values:** ERROR, WARNING, INFO, DEBUG

        **Default:** ERROR

    **target**

        **Description** 'remote': Export data to remote. This is the default value.; 'local': Export data local.; 

        **Type:** string

        **Supported Values:** remote, local

        **Default:** remote

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters