.. _techreport:

techreport
==========

Configure show tech


techreport Specification
------------------------

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

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

	 **Element Name**                      techreport

	 **Element URI**                       /axapi/v3/techreport

	 **Element Attributes**                techreport_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3466_techreport_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/techreport_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/techreport



.. raw:: html

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


:ref:`3466_techreport_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/techreport_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/techreport



.. raw:: html

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


:ref:`3466_techreport_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/techreport



.. raw:: html

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


:ref:`3466_techreport_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/techreport_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/techreport



.. raw:: html

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


:ref:`3466_techreport_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/techreport_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3466_techreport_attributes:

techreport attributes
---------------------

    **disable**

        **Description** Disable the polling techreport

        **Type:** boolean

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

        **Default:** 0

    **enable-full-history**

        **Description** Enable 31 day poll techreports (default seven) on platforms with less than 32GB disk (no op otherwise)

        **Type:** boolean

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

        **Default:** 0

    **interval**

        **Description:** interval is a **JSON Block**.  Please see below for :ref:`3466_interval` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/techreport/interval <techreport_interval>`

    **max-logfile-size**

        **Description:** max-logfile-size is a **JSON Block**.  Please see below for :ref:`3466_max-logfile-size` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/techreport/max-logfile-size <techreport_max_logfile_size>`

    **max-partitions**

        **Description:** max-partitions is a **JSON Block**.  Please see below for :ref:`3466_max-partitions` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/techreport/max-partitions <techreport_max_partitions>`

    **priority-partition-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/techreport/priority-partition/{part-name} <techreport_priority_partition>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3466_max-logfile-size:

max-logfile-size
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** Log file size for periodic techsupport (default is 1)

        **Type:** number

        **Range:** 1-10

        **Default:** 1

.. _3466_max-partitions:

max-partitions
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** Maximum partions to show in per periodic techsupport (default is 30)

        **Type:** number

        **Range:** 1-120

        **Default:** 30

.. _3466_interval:

interval
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** Showtech interval in minutes (default is 15)

        **Type:** number

        **Range:** 15-120

        **Default:** 15

.. _3466_priority-partition-list:

priority-partition-list
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **part-name**

        **Description** Name of partition always want to show in showtech (shared is always shown by default)

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters