.. _aam_authentication_relay_ntlm:

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

NTLM Authentication Relay


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

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`59_ntlm_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/ntlm

	                                       

	 **Element Name**                      ntlm

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

	 **Element Attributes**                ntlm_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`59_ntlm_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/aam_authentication_relay_ntlm_POST.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`59_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}



.. raw:: html

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


:ref:`59_ntlm_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/aam_authentication_relay_ntlm_GET.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`59_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}



.. raw:: html

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


:ref:`59_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}



.. raw:: html

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


:ref:`59_ntlm_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/aam_authentication_relay_ntlm_PUT.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`59_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}



.. raw:: html

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


:ref:`59_ntlm_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/aam_authentication_relay_ntlm_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _59_ntlm_list:

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


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

        ntlm-list : [

             { :ref:`59_ntlm_attributes` },

             { :ref:`59_ntlm_attributes` },

             ...

         ]

.. _59_ntlm_attributes:

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

    **domain**

        **Description** Specify NTLM domain, default is null

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **large-request-disable**

        **Description** Disable NTLM relay processing for large requests

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Specify NTLM authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-ntlm-tmpl <visibility_packet_capture_object_templates_aam_auth_relay_ntlm_tmpl>`

    **sampling-enable**

        **Type:** List

    **user-tag**

        **Description** Customized tag

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

    **version**

        **Description** Specify NTLM version, default is NTLM 2

        **Type:** number

        **Range:** 1-2

        **Default:** 2

.. _59_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'success': Success; 'failure': Failure; 'request': Request; 'response': Response; 'http-code-200': HTTP 200 OK; 'http-code-400': HTTP 400 Bad Request; 'http-code-401': HTTP 401 Unauthorized; 'http-code-403': HTTP 403 Forbidden; 'http-code-404': HTTP 404 Not Found; 'http-code-500': HTTP 500 Internal Server Error; 'http-code-503': HTTP 503 Service Unavailable; 'http-code-other': Other HTTP Response; 'buffer-alloc-fail': Buffer Allocation Failure; 'encoding-fail': Encoding Failure; 'insert-header-fail': Insert Header Failure; 'parse-header-fail': Parse Header Failure; 'internal-error': Internal Error; 'ntlm-auth-skipped': Requests for which NTLM relay is skipped; 'large-request-processing': Requests invoking large request processing; 'large-request-flushed': Large requests sent to server; 'head-negotiate-request-sent': HEAD requests sent with NEGOTIATE header; 'head-auth-request-sent': HEAD requests sent with AUTH header; 

        **Type:** string

        **Supported Values:** all, success, failure, request, response, http-code-200, http-code-400, http-code-401, http-code-403, http-code-404, http-code-500, http-code-503, http-code-other, buffer-alloc-fail, encoding-fail, insert-header-fail, parse-header-fail, internal-error, ntlm-auth-skipped, large-request-processing, large-request-flushed, head-negotiate-request-sent, head-auth-request-sent