.. _aam_authentication_relay_ntlm_stats:

aam authentication relay ntlm stats
===================================

Statistics for the object ntlm


ntlm Specification
------------------

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

	===================================== ===================================================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`58_ntlm_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/ntlm/{name}

	                                       

	 **Element Name**                      ntlm

	 **Element URI**                       /axapi/v3/aam/authentication/relay/ntlm/{name}/stats

	 **Element Attributes**                ntlm_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`ntlm schema <aam-authentication-relay-ntlm-stats/aam-authentication-relay-ntlm-stats.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/aam/authentication/relay/ntlm/{name}



.. raw:: html

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


:ref:`58_ntlm_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/aam/authentication/relay/ntlm/{name}



.. raw:: html

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


:ref:`58_ntlm_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/aam/authentication/relay/ntlm/{name}/stats



.. raw:: html

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


:ref:`58_ntlm_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/aam/authentication/relay/ntlm/{name}



.. raw:: html

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


:ref:`58_ntlm_list`



.. 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/aam/authentication/relay/ntlm/{name}/stats



.. raw:: html

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


:ref:`58_ntlm_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/aam/authentication/relay/ntlm/{name}/stats



.. raw:: html

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


:ref:`58_ntlm_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/aam/authentication/relay/ntlm/{name}



.. raw:: html

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


:ref:`58_ntlm_list`



.. 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/aam/authentication/relay/ntlm/{name}/stats



.. raw:: html

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


:ref:`58_ntlm_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _58_ntlm_list:

ntlm-list
---------


    ntlm-list is **JSON List** of :ref:`58_ntlm_attributes` 

        ntlm-list : [

             { :ref:`58_ntlm_attributes` },

             { :ref:`58_ntlm_attributes` },

             ...

         ]

.. _58_ntlm_attributes:

ntlm attributes
---------------

    **name**

        **Description** Specify NTLM authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`58_stats` 

        **Type:** Object

.. _58_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **buffer-alloc-fail**

        **Description** Buffer Allocation Failure

        **Type:** number

        **Format:** counter

    **encoding-fail**

        **Description** Encoding Failure

        **Type:** number

        **Format:** counter

    **failure**

        **Description** Failure

        **Type:** number

        **Format:** counter

    **head-auth-request-sent**

        **Description** HEAD requests sent with AUTH header

        **Type:** number

        **Format:** counter

    **head-negotiate-request-sent**

        **Description** HEAD requests sent with NEGOTIATE header

        **Type:** number

        **Format:** counter

    **http-code-200**

        **Description** HTTP 200 OK

        **Type:** number

        **Format:** counter

    **http-code-400**

        **Description** HTTP 400 Bad Request

        **Type:** number

        **Format:** counter

    **http-code-401**

        **Description** HTTP 401 Unauthorized

        **Type:** number

        **Format:** counter

    **http-code-403**

        **Description** HTTP 403 Forbidden

        **Type:** number

        **Format:** counter

    **http-code-404**

        **Description** HTTP 404 Not Found

        **Type:** number

        **Format:** counter

    **http-code-500**

        **Description** HTTP 500 Internal Server Error

        **Type:** number

        **Format:** counter

    **http-code-503**

        **Description** HTTP 503 Service Unavailable

        **Type:** number

        **Format:** counter

    **http-code-other**

        **Description** Other HTTP Response

        **Type:** number

        **Format:** counter

    **insert-header-fail**

        **Description** Insert Header Failure

        **Type:** number

        **Format:** counter

    **internal-error**

        **Description** Internal Error

        **Type:** number

        **Format:** counter

    **large-request-flushed**

        **Description** Large requests sent to server

        **Type:** number

        **Format:** counter

    **large-request-processing**

        **Description** Requests invoking large request processing

        **Type:** number

        **Format:** counter

    **ntlm-auth-skipped**

        **Description** Requests for which NTLM relay is skipped

        **Type:** number

        **Format:** counter

    **parse-header-fail**

        **Description** Parse Header Failure

        **Type:** number

        **Format:** counter

    **request**

        **Description** Request

        **Type:** number

        **Format:** counter

    **response**

        **Description** Response

        **Type:** number

        **Format:** counter

    **success**

        **Description** Success

        **Type:** number

        **Format:** counter