.. _aam_authentication_server_windows:

aam authentication server windows
=================================

"Windows Server, using Kerberos or NTLM for authentication"


windows Specification
---------------------

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

	 **Element Name**                      windows

	 **Element URI**                       /axapi/v3/aam/authentication/server/windows

	 **Element Attributes**                windows_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/server/windows/stats

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



.. raw:: html

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


:ref:`491_windows_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/server/windows



.. raw:: html

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


:ref:`491_windows_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/aam/authentication/server/windows



.. raw:: html

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


:ref:`491_windows_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/server/windows



.. raw:: html

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


:ref:`491_windows_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/aam/authentication/server/windows



.. raw:: html

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


:ref:`491_windows_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _491_windows_attributes:

windows attributes
------------------

    **instance-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/aam/authentication/server/windows/instance/{name} <aam_authentication_server_windows_instance>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _491_instance-list:

instance-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **auth-protocol**

        **Description:** auth-protocol is a **JSON Block**.  Please see below for :ref:`491_instance-list_auth-protocol` 

        **Type:** Object

    **health-check**

        **Description** Check server's health status

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

    **health-check-disable**

        **Description** Disable configured health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **health-check-string**

        **Description** Health monitor name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **host**

        **Description:** host is a **JSON Block**.  Please see below for :ref:`491_instance-list_host` 

        **Type:** Object

    **name**

        **Description** Specify Windows authentication server name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **realm**

        **Description** Specify realm of Windows server

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **support-apacheds-kdc**

        **Description** Enable weak cipher (DES CRC/MD5/MD4) and merge AS-REQ in single packet

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Specify connection timeout to server, default is 10 seconds

        **Type:** number

        **Range:** 1-255

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _491_instance-list_host:

instance-list_host
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **hostip**

        **Description** Specify the Windows server's hostname(Length 1-31) or IP address

        **Type:** string

        **Format:** host

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** hostip and hostipv6 are mutually exclusive

    **hostipv6**

        **Description** Specify the Windows server's IPV6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** hostipv6 and hostip are mutually exclusive

.. _491_instance-list_auth-protocol:

instance-list_auth-protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **kerberos-disable**

        **Description** Disable Kerberos authentication protocol

        **Type:** boolean

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

        **Default:** 0

    **kerberos-password-change-port**

        **Description** Specify the Kerbros password change port, default is 464

        **Type:** number

        **Range:** 1-65534

        **Default:** 464

    **kerberos-port**

        **Description** Specify the Kerberos port, default is 88

        **Type:** number

        **Range:** 1-65534

        **Default:** 88

    **kport-hm**

        **Description** Check Kerberos port's health status

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** kport-hm and kport-hm-disable are mutually exclusive

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **kport-hm-disable**

        **Description** Disable configured Kerberos port health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** kport-hm-disable and kport-hm are mutually exclusive

    **ntlm-disable**

        **Description** Disable NTLM authentication protocol

        **Type:** boolean

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

        **Default:** 0

    **ntlm-health-check**

        **Description** Check NTLM port's health status

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** ntlm-health-check and ntlm-health-check-disable are mutually exclusive

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **ntlm-health-check-disable**

        **Description** Disable configured NTLM port health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** ntlm-health-check-disable and ntlm-health-check are mutually exclusive

    **ntlm-version**

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

        **Type:** number

        **Range:** 1-2

        **Default:** 2

.. _491_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - kerberos-pw-change-success
      - 8
      - Total Kerberos password change success

   *  - 
      - ntlm-response-error
      - 8
      - Total NTLM Error Response

   *  - 
      - ntlm-proto-negotiation-failure
      - 8
      - Total NTLM Protocol Negotiation Failure

   *  - 
      - ntlm-session-setup-failed
      - 8
      - Total NTLM Session Setup Failure

   *  - 
      - ntlm-polling-control-error
      - 8
      - Total NTLM Polling Control Error

   *  - 
      - kerberos-other-error
      - 8
      - Total Kerberos Other Error

   *  - 
      - kerberos-timeout-error
      - 8
      - Total Kerberos Timeout

   *  - 
      - kerberos-job-start-error
      - 8
      - Total Kerberos Job Start Error

   *  - 
      - ntlm-proto-negotiation-success
      - 8
      - Total NTLM Protocol Negotiation Success

   *  - 
      - ntlm-other-error
      - 8
      - Total NTLM Other Error

   *  - 
      - ntlm-job-start-error
      - 8
      - Total NTLM Job Start Error

   *  - 
      - ntlm-prepare-req-success
      - 8
      - Total NTLM Prepare Request Success

   *  - 
      - ntlm-response-failure
      - 8
      - Total NTLM Failure Response

   *  - 
      - kerberos-polling-control-error
      - 8
      - Total Kerberos Polling Control Error

   *  - 
      - ntlm-prepare-req-failed
      - 8
      - Total NTLM Prepare Request Failed

   *  - 
      - ntlm-request-normal
      - 8
      - Total NTLM Normal Request

   *  - 
      - kerberos-pw-expiry
      - 8
      - Total Kerberos password expiry

   *  - 
      - ntlm-authentication-success
      - 8
      - Total NTLM Authentication Success

   *  - 
      - ntlm-response-timeout
      - 8
      - Total NTLM Timeout Response

   *  - 
      - ntlm-authentication-failure
      - 8
      - Total NTLM Authentication Failure

   *  - 
      - kerberos-request-send
      - 8
      - Total Kerberos Request

   *  - 
      - kerberos-pw-change-failure
      - 8
      - Total Kerberos password change failure

   *  - 
      - kerberos-request-normal
      - 8
      - Total Kerberos Normal Request

   *  - 
      - ntlm-response-other
      - 8
      - Total NTLM Other Response

   *  - 
      - kerberos-request-dropped
      - 8
      - Total Kerberos Dropped Request

   *  - 
      - kerberos-response-other
      - 8
      - Total Kerberos Other Response

   *  - 
      - ntlm-session-setup-success
      - 8
      - Total NTLM Session Setup Success

   *  - 
      - kerberos-response-error
      - 8
      - Total Kerberos Error Response

   *  - 
      - kerberos-response-success
      - 8
      - Total Kerberos Success Response

   *  - 
      - ntlm-request-dropped
      - 8
      - Total NTLM Dropped Request

   *  - 
      - kerberos-response-timeout
      - 8
      - Total Kerberos Timeout Response

   *  - 
      - kerberos-response-get
      - 8
      - Total Kerberos Response

   *  - 
      - ntlm-timeout-error
      - 8
      - Total NTLM Timeout

   *  - 
      - kerberos-response-failure
      - 8
      - Total Kerberos Failure Response

   *  - 
      - ntlm-response-success
      - 8
      - Total NTLM Success Response