.. _visibility_file_metrics_oper:

visibility file metrics oper
============================

Operational Status for the object metrics


metrics Specification
---------------------

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

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

	 **Element Name**                      metrics

	 **Element URI**                       /axapi/v3/visibility/file/metrics/oper

	 **Element Attributes**                metrics_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`3557_metrics_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/file/metrics/oper



.. raw:: html

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


:ref:`3557_metrics_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/file/metrics/oper



.. raw:: html

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


:ref:`3557_metrics_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/file/metrics/oper



.. raw:: html

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


:ref:`3557_metrics_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/file/metrics/oper



.. raw:: html

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


:ref:`3557_metrics_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3557_metrics_attributes:

metrics attributes
------------------

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`3557_oper` 

        **Type:** Object

.. _3557_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **file-name**

        **Description** 

        **Type:** string

    **monitor-type**

        **Description** 

        **Type:** string

    **pri-ipv4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **pri-ipv6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **pri-l4-port**

        **Description** 

        **Type:** number

    **pri-l4-proto**

        **Description** 

        **Type:** number

    **pri-type**

        **Description** 

        **Type:** string

    **proc-metric-list**

        **Type:** List

    **sec-ipv4-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **sec-ipv6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **sec-l4-port**

        **Description** 

        **Type:** number

    **sec-l4-proto**

        **Description** 

        **Type:** number

    **sec-type**

        **Description** 

        **Type:** string

.. _3557_oper_proc-metric-list:

oper_proc-metric-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **metric-attr-list**

        **Type:** List

    **metric-name**

        **Description** 

        **Type:** string

.. _3557_oper_proc-metric-list_metric-attr-list:

oper_proc-metric-list_metric-attr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **metric-attr-name**

        **Description** 

        **Type:** string

    **metric-attr-value**

        **Description** 

        **Type:** string