.. _visibility_reporting:

visibility reporting
====================

Configure reporting framework


reporting Specification
-----------------------

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

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

	 **Element Name**                      reporting

	 **Element URI**                       /axapi/v3/visibility/reporting

	 **Element Attributes**                reporting_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/visibility/reporting/stats

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



.. raw:: html

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


:ref:`4027_reporting_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_reporting_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/reporting



.. raw:: html

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


:ref:`4027_reporting_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_reporting_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/reporting



.. raw:: html

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


:ref:`4027_reporting_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/reporting



.. raw:: html

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


:ref:`4027_reporting_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_reporting_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/reporting



.. raw:: html

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


:ref:`4027_reporting_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_reporting_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4027_reporting_attributes:

reporting attributes
--------------------

    **sampling-enable**

        **Type:** List

    **session-logging**

        **Description** 'enable': Enable session logging; 'disable': Disable session logging(default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **telemetry-export-interval**

        **Description:** telemetry-export-interval is a **JSON Block**.  Please see below for :ref:`4027_telemetry-export-interval` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/reporting/telemetry-export-interval <visibility_reporting_telemetry_export_interval>`

    **template**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template <visibility_reporting_template>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _4027_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'log-transmit-failure': Total log transmit failures; 'buffer-alloc-failure': Total reporting buffer allocation failures; 'notif-jobs-in-queue': Total notification jobs in queue; 'enqueue-fail': Total enqueue jobs failed; 'enqueue-pass': Total enqueue jobs passed; 'dequeued': Total jobs dequeued; 

        **Type:** string

        **Supported Values:** all, log-transmit-failure, buffer-alloc-failure, notif-jobs-in-queue, enqueue-fail, enqueue-pass, dequeued

.. _4027_template:

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

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

    **notification**

        **Description:** notification is a **JSON Block**.  Please see below for :ref:`4027_template_notification` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification <visibility_reporting_template_notification>`

.. _4027_template_notification:

template_notification
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **debug**

        **Description:** debug is a **JSON Block**.  Please see below for :ref:`4027_template_notification_debug` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/debug <visibility_reporting_template_notification_debug>`

    **template-name-list**

        **Type:** List

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

.. _4027_template_notification_debug:

template_notification_debug
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _4027_template_notification_template-name-list:

template_notification_template-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'enable': Enable; 'disable': Disable; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`4027_template_notification_template-name-list_authentication` 

        **Type:** Object

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

    **debug-mode**

        **Description** Enable debug mode

        **Type:** boolean

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

        **Default:** 0

    **host-name**

        **Description** Configure the host name(e.g www.a10networks.com)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** host-name, ipv4-address, and ipv6-address are mutually exclusive

    **http-port**

        **Description** Configure the http port to use(default 80) (http port(default 80))

        **Type:** number

        **Range:** 1-65535

        **Default:** 80

    **https-port**

        **Description** Configure the https port to use(default 443) (http port(default 443))

        **Type:** number

        **Range:** 1-65535

        **Default:** 443

    **ipv4-address**

        **Description** Configure the host IPv4 address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ipv4-address, ipv6-address, and host-name are mutually exclusive

    **ipv6-address**

        **Description** Configure the host IPv6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-address, ipv4-address, and host-name are mutually exclusive

    **name**

        **Description** Notification template name

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **protocol**

        **Description** 'http': Use http protocol; 'https': Use https protocol(default);  (http protocol)

        **Type:** string

        **Supported Values:** http, https

        **Default:** https

    **relative-uri**

        **Description** Configure the relative uri(e.g /example , default /)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** /

    **sampling-enable**

        **Type:** List

    **test-connectivity**

        **Description** Test connectivity to notification receiver

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port for notifications

        **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

.. _4027_template_notification_template-name-list_authentication:

template_notification_template-name-list_authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **api-key**

        **Description** Configure api-key as a mode of authentication

        **Type:** boolean

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

        **Default:** 0

    **api-key-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **api-key-string**

        **Description** Configure api-key as a mode of authentication

        **Type:** string

        **Format:** password

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **auth-password**

        **Description** Configure the authentication user password (Authentication password)

        **Type:** boolean

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

        **Default:** 0

    **auth-password-string**

        **Description** Configure the authentication user password (Authentication password)

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **auth-username**

        **Description** Configure the authentication user name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **relative-login-uri**

        **Description** Configure the authentication login uri

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **relative-logoff-uri**

        **Description** Configure the authentication logoff uri

        **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

.. _4027_template_notification_template-name-list_sampling-enable:

template_notification_template-name-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'sent_successful': Sent successful; 'send_fail': Send failures; 'response_fail': Response failures; 

        **Type:** string

        **Supported Values:** all, sent_successful, send_fail, response_fail

.. _4027_telemetry-export-interval:

telemetry-export-interval
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** Monitored entity telemetry data export interval in mins (Default 5 mins)

        **Type:** number

        **Range:** 1-5

        **Default:** 5